PHP Class Pimcore\Model\Object\ClassDefinition\Data\KeyValue

Inheritance: extends Pimcore\Model\Object\ClassDefinition\Data
Show file Open project: pimcore/pimcore

Public Properties

Property Type Description
$descWidth width of description column
$fieldtype string Static type of this element
$groupDescWidth width of group description column
$groupWidth width of group column
$height Height of grid
$keyWidth width of key column
$maxheight Maximum height of grid
$metaVisible boolean Whether the metadata column is visible
$metawidth Width of metadata column
$multivalent Whether the value can be multivalent
$phpdocType string Type for the generated phpdoc
$unitWidth width of unit column
$valueWidth width of value column

Public Methods

Method Description
checkValidity ( mixed $data, boolean $omitMandatoryCheck = false ) Checks if data is valid for current data field
classSaved ( ClassDefinition $class, mixed $params = [] ) : void This method is called in Object\\ClassDefinition::save() and is used to create the database table for the localized data
delete ( $object )
getDataForEditmode ( KeyValue $data, null | AbstractObject $object = null, mixed $params = [] ) : tbd
getDataFromEditmode ( mixed $data, null $object = null, $params = [] ) : mixed | KeyValue
getDescWidth ( ) : mixed Returns the width of the description column.
getDiffDataForEditMode ( mixed $data, null $object = null, mixed $params = [] ) : array | null
getDiffDataFromEditmode ( $data, null $object = null, mixed $params = [] ) : mixed | KeyValue
getForWebserviceExport ( string $object, mixed $params = [] ) : mixed converts data to be exposed via webservices
getFromWebserviceImport ( mixed $value, null $relatedObject = null, mixed $params = [], null $idMapper = null ) : mixed | KeyValue
getGroupDescWidth ( ) : integer
getGroupWidth ( ) : integer
getKeyWidth ( ) : integer
getMaxheight ( ) : integer
getMetaVisible ( ) : boolean
getMetawidth ( )
getMultivalent ( )
getUnitWidth ( ) : mixed Returns the width of the unit column.
getValueWidth ( ) : integer
isDiffChangeAllowed ( string $object, mixed $params = [] ) : boolean
load ( $object, array $params = [] ) : KeyValue
save ( $object, array $params = [] )
setDescWidth ( $width ) : Pimcore\Model\Object\ClassDefinition\Data_KeyValue Sets the width of the description column.
setGroupDescWidth ( integer $width ) : void
setGroupWidth ( integer $width )
setKeyWidth ( integer $width )
setMaxheight ( $maxheight )
setMetaVisible ( boolean $metaVisible )
setMetawidth ( $metawidth )
setMultivalent ( $multivalent )
setUnitWidth ( integer $width ) : void
setValueWidth ( integer $width ) : void
synchronizeWithMasterDefinition ( Data $masterDefinition )

Method Details

checkValidity() public method

Checks if data is valid for current data field
public checkValidity ( mixed $data, boolean $omitMandatoryCheck = false )
$data mixed
$omitMandatoryCheck boolean

classSaved() public method

This method is called in Object\\ClassDefinition::save() and is used to create the database table for the localized data
public classSaved ( ClassDefinition $class, mixed $params = [] ) : void
$class Pimcore\Model\Object\ClassDefinition
$params mixed
return void

delete() public method

public delete ( $object )
$object

getDataForEditmode() public method

See also: Object\ClassDefinition\Data::getDataForEditmode
public getDataForEditmode ( KeyValue $data, null | AbstractObject $object = null, mixed $params = [] ) : tbd
$data Pimcore\Model\Object\Data\KeyValue
$object null | Pimcore\Model\Object\AbstractObject
$params mixed
return tbd

getDataFromEditmode() public method

public getDataFromEditmode ( mixed $data, null $object = null, $params = [] ) : mixed | KeyValue
$data mixed
$object null
return mixed | Pimcore\Model\Object\Data\KeyValue

getDescWidth() public method

Returns the width of the description column.
public getDescWidth ( ) : mixed
return mixed

getDiffDataForEditMode() public method

public getDiffDataForEditMode ( mixed $data, null $object = null, mixed $params = [] ) : array | null
$data mixed
$object null
$params mixed
return array | null

getDiffDataFromEditmode() public method

public getDiffDataFromEditmode ( $data, null $object = null, mixed $params = [] ) : mixed | KeyValue
$data
$object null
$params mixed
return mixed | Pimcore\Model\Object\Data\KeyValue

getForWebserviceExport() public method

converts data to be exposed via webservices
public getForWebserviceExport ( string $object, mixed $params = [] ) : mixed
$object string
$params mixed
return mixed

getFromWebserviceImport() public method

public getFromWebserviceImport ( mixed $value, null $relatedObject = null, mixed $params = [], null $idMapper = null ) : mixed | KeyValue
$value mixed
$relatedObject null
$params mixed
$idMapper null
return mixed | Pimcore\Model\Object\Data\KeyValue

getGroupDescWidth() public method

public getGroupDescWidth ( ) : integer
return integer

getGroupWidth() public method

public getGroupWidth ( ) : integer
return integer

getKeyWidth() public method

public getKeyWidth ( ) : integer
return integer

getMaxheight() public method

public getMaxheight ( ) : integer
return integer

getMetaVisible() public method

public getMetaVisible ( ) : boolean
return boolean

getMetawidth() public method

public getMetawidth ( )

getMultivalent() public method

public getMultivalent ( )

getUnitWidth() public method

Returns the width of the unit column.
public getUnitWidth ( ) : mixed
return mixed

getValueWidth() public method

public getValueWidth ( ) : integer
return integer

isDiffChangeAllowed() public method

public isDiffChangeAllowed ( string $object, mixed $params = [] ) : boolean
$object string
$params mixed
return boolean

load() public method

public load ( $object, array $params = [] ) : KeyValue
$object
$params array
return Pimcore\Model\Object\Data\KeyValue

save() public method

public save ( $object, array $params = [] )
$object
$params array

setDescWidth() public method

Sets the width of the description column.
public setDescWidth ( $width ) : Pimcore\Model\Object\ClassDefinition\Data_KeyValue
$width
return Pimcore\Model\Object\ClassDefinition\Data_KeyValue

setGroupDescWidth() public method

public setGroupDescWidth ( integer $width ) : void
$width integer
return void

setGroupWidth() public method

public setGroupWidth ( integer $width )
$width integer

setKeyWidth() public method

public setKeyWidth ( integer $width )
$width integer

setMaxheight() public method

public setMaxheight ( $maxheight )
$maxheight

setMetaVisible() public method

public setMetaVisible ( boolean $metaVisible )
$metaVisible boolean

setMetawidth() public method

public setMetawidth ( $metawidth )
$metawidth

setMultivalent() public method

public setMultivalent ( $multivalent )
$multivalent

setUnitWidth() public method

public setUnitWidth ( integer $width ) : void
$width integer
return void

setValueWidth() public method

public setValueWidth ( integer $width ) : void
$width integer
return void

synchronizeWithMasterDefinition() public method

public synchronizeWithMasterDefinition ( Data $masterDefinition )
$masterDefinition Pimcore\Model\Object\ClassDefinition\Data

Property Details

$descWidth public property

width of description column
public $descWidth

$fieldtype public property

Static type of this element
public string $fieldtype
return string

$groupDescWidth public property

width of group description column
public $groupDescWidth

$groupWidth public property

width of group column
public $groupWidth

$height public property

Height of grid
public $height

$keyWidth public property

width of key column
public $keyWidth

$maxheight public property

Maximum height of grid
public $maxheight

$metaVisible public property

Whether the metadata column is visible
public bool $metaVisible
return boolean

$metawidth public property

Width of metadata column
public $metawidth

$multivalent public property

Whether the value can be multivalent
public $multivalent

$phpdocType public property

Type for the generated phpdoc
public string $phpdocType
return string

$unitWidth public property

width of unit column
public $unitWidth

$valueWidth public property

width of value column
public $valueWidth