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

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

Public Properties

Property Type Description
$childs array
$fieldDefinitionsCache array
$fieldtype string Static type of this element
$height integer
$labelWidth integer
$layout string
$maxTabs integer
$name string
$phpdocType string Type for the generated phpdoc
$region string
$title string
$width integer

Protected Properties

Property Type Description
$referencedFields array contains further localized field definitions if there are more than one localized fields in on class

Public Methods

Method Description
__sleep ( ) : array
addChild ( mixed $child ) : void
addReferencedField ( $field )
checkValidity ( mixed $data, boolean $omitMandatoryCheck = false ) Checks if data is valid for current data field
classSaved ( $class, $params = [] ) : void This method is called in Object|Class::save() and is used to create the database table for the localized data
delete ( $object, $params = [] )
doGetFieldDefinitions ( null $def = null, array $fields = [] ) : array
getCacheTags ( mixed $data, array $tags = [] ) : array This is a dummy and is mostly implemented by relation types
getChildren ( ) : array
getDataForEditmode ( string $data, null | AbstractObject $object = null, mixed $params = [] ) : string
getDataForGrid ( $data, null $object = null, mixed $params = [] ) : stdClass
getDataForSearchIndex ( $object, mixed $params = [] ) : string
getDataFromEditmode ( string $data, null | AbstractObject $object = null, mixed $params = [] ) : string
getDiffDataForEditmode ( mixed $data, null $object = null, mixed $params = [] ) : array | null See parent class.
getDiffDataFromEditmode ( $data, null $object = null, mixed $params = [] ) : null | Pimcore_Date See parent class.
getFieldDefinitions ( ) : array
getFielddefinition ( $name ) : mixed
getForCsvExport ( AbstractObject $object, array $params = [] ) : string converts object data to a simple string value or CSV Export
getForWebserviceExport ( AbstractObject $object, mixed $params = [] ) : mixed
getFromCsvImport ( string $importValue, null | AbstractObject $object = null, mixed $params = [] ) : null
getFromWebserviceImport ( mixed $value, null $object = null, mixed $params = [], null $idMapper = null ) : mixed | null | Localizedfield
getGetterCode ( $class ) : string
getHeight ( ) : integer
getLabelWidth ( ) : integer
getLayout ( ) : string
getMaxTabs ( ) : integer
getName ( ) : string
getReferencedFields ( ) : array
getRegion ( ) : string
getSetterCode ( $class ) : string
getTitle ( ) : string
getVersionPreview ( string $data, null | AbstractObject $object = null, mixed $params = [] ) : string
getWidth ( ) : integer
hasChildren ( ) : boolean
isDiffChangeAllowed ( string $object, mixed $params = [] ) : boolean True if change is allowed in edit mode.
load ( $object, array $params = [] ) : Localizedfield
marshal ( mixed $value, AbstractObject $object = null, mixed $params = [] ) : mixed Encode value for packing it into a single column.
preGetData ( $container, array $params = [] ) : Localizedfield
resolveDependencies ( $data ) : array
rewriteIds ( mixed $object, array $idMapping, array $params = [] ) : Pimcore\Model\Element\ElementInterface Rewrites id from source to target, $idMapping contains array( "document" => array( SOURCE_ID => TARGET_ID, SOURCE_ID => TARGET_ID ), "object" => array(.
save ( $object, array $params = [] )
setChildren ( array $children )
setHeight ( $height )
setLabelWidth ( integer $labelWidth )
setLayout ( $layout )
setMaxTabs ( integer $maxTabs )
setName ( string $name )
setReferencedFields ( array $referencedFields )
setRegion ( $region )
setTitle ( string $title )
setValues ( mixed $data = [], array $blockedKeys = [] ) : void
setWidth ( $width )
unmarshal ( mixed $value, AbstractObject $object = null, mixed $params = [] ) : mixed See marshal

Protected Methods

Method Description
getDataForValidity ( Localizedfield | mixed $localizedObject, array $languages ) : array

Private Methods

Method Description
doGetDataForEditMode ( $data, $object, &$fieldData, &$metaData, integer $level = 1 ) : array

Method Details

__sleep() public method

public __sleep ( ) : array
return array

addChild() public method

public addChild ( mixed $child ) : void
$child mixed
return void

addReferencedField() public method

public addReferencedField ( $field )
$field

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|Class::save() and is used to create the database table for the localized data
public classSaved ( $class, $params = [] ) : void
return void

delete() public method

public delete ( $object, $params = [] )
$object

doGetFieldDefinitions() public method

public doGetFieldDefinitions ( null $def = null, array $fields = [] ) : array
$def null
$fields array
return array

getCacheTags() public method

This is a dummy and is mostly implemented by relation types
public getCacheTags ( mixed $data, array $tags = [] ) : array
$data mixed
$tags array
return array

getChildren() public method

public getChildren ( ) : array
return array

getDataForEditmode() public method

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

getDataForGrid() public method

public getDataForGrid ( $data, null $object = null, mixed $params = [] ) : stdClass
$data
$object null
$params mixed
return stdClass

getDataForSearchIndex() public method

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

getDataForValidity() protected method

protected getDataForValidity ( Localizedfield | mixed $localizedObject, array $languages ) : array
$localizedObject Pimcore\Model\Object\Localizedfield | mixed
$languages array
return array

getDataFromEditmode() public method

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

getDiffDataForEditmode() public method

See parent class.
public getDiffDataForEditmode ( mixed $data, null $object = null, mixed $params = [] ) : array | null
$data mixed
$object null
$params mixed
return array | null

getDiffDataFromEditmode() public method

See parent class.
public getDiffDataFromEditmode ( $data, null $object = null, mixed $params = [] ) : null | Pimcore_Date
$data
$object null
$params mixed
return null | Pimcore_Date

getFieldDefinitions() public method

public getFieldDefinitions ( ) : array
return array

getFielddefinition() public method

public getFielddefinition ( $name ) : mixed
$name
return mixed

getForCsvExport() public method

converts object data to a simple string value or CSV Export
public getForCsvExport ( AbstractObject $object, array $params = [] ) : string
$object Pimcore\Model\Object\AbstractObject
$params array
return string

getForWebserviceExport() public method

public getForWebserviceExport ( AbstractObject $object, mixed $params = [] ) : mixed
$object Pimcore\Model\Object\AbstractObject
$params mixed
return mixed

getFromCsvImport() public method

public getFromCsvImport ( string $importValue, null | AbstractObject $object = null, mixed $params = [] ) : null
$importValue string
$object null | Pimcore\Model\Object\AbstractObject
$params mixed
return null

getFromWebserviceImport() public method

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

getGetterCode() public method

public getGetterCode ( $class ) : string
$class
return string

getHeight() public method

public getHeight ( ) : integer
return integer

getLabelWidth() public method

public getLabelWidth ( ) : integer
return integer

getLayout() public method

public getLayout ( ) : string
return string

getMaxTabs() public method

public getMaxTabs ( ) : integer
return integer

getName() public method

public getName ( ) : string
return string

getReferencedFields() public method

public getReferencedFields ( ) : array
return array

getRegion() public method

public getRegion ( ) : string
return string

getSetterCode() public method

public getSetterCode ( $class ) : string
$class
return string

getTitle() public method

public getTitle ( ) : string
return string

getVersionPreview() public method

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

getWidth() public method

public getWidth ( ) : integer
return integer

hasChildren() public method

public hasChildren ( ) : boolean
return boolean

isDiffChangeAllowed() public method

True if change is allowed in edit mode.
public isDiffChangeAllowed ( string $object, mixed $params = [] ) : boolean
$object string
$params mixed
return boolean

load() public method

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

marshal() public method

Encode value for packing it into a single column.
public marshal ( mixed $value, AbstractObject $object = null, mixed $params = [] ) : mixed
$value mixed
$object Pimcore\Model\Object\AbstractObject
$params mixed
return mixed

preGetData() public method

public preGetData ( $container, array $params = [] ) : Localizedfield
$params array
return Pimcore\Model\Object\Localizedfield

resolveDependencies() public method

public resolveDependencies ( $data ) : array
$data
return array

rewriteIds() public method

..), "asset" => array(...) )
public rewriteIds ( mixed $object, array $idMapping, array $params = [] ) : Pimcore\Model\Element\ElementInterface
$object mixed
$idMapping array
$params array
return Pimcore\Model\Element\ElementInterface

save() public method

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

setChildren() public method

public setChildren ( array $children )
$children array

setHeight() public method

public setHeight ( $height )
$height

setLabelWidth() public method

public setLabelWidth ( integer $labelWidth )
$labelWidth integer

setLayout() public method

public setLayout ( $layout )
$layout

setMaxTabs() public method

public setMaxTabs ( integer $maxTabs )
$maxTabs integer

setName() public method

public setName ( string $name )
$name string

setReferencedFields() public method

public setReferencedFields ( array $referencedFields )
$referencedFields array

setRegion() public method

public setRegion ( $region )
$region

setTitle() public method

public setTitle ( string $title )
$title string

setValues() public method

public setValues ( mixed $data = [], array $blockedKeys = [] ) : void
$data mixed
$blockedKeys array
return void

setWidth() public method

public setWidth ( $width )
$width

unmarshal() public method

See marshal
public unmarshal ( mixed $value, AbstractObject $object = null, mixed $params = [] ) : mixed
$value mixed
$object Pimcore\Model\Object\AbstractObject
$params mixed
return mixed

Property Details

$childs public property

public array $childs
return array

$fieldDefinitionsCache public property

public array $fieldDefinitionsCache
return array

$fieldtype public property

Static type of this element
public string $fieldtype
return string

$height public property

public int $height
return integer

$labelWidth public property

public int $labelWidth
return integer

$layout public property

public string $layout
return string

$maxTabs public property

public int $maxTabs
return integer

$name public property

public string $name
return string

$phpdocType public property

Type for the generated phpdoc
public string $phpdocType
return string

$referencedFields protected property

contains further localized field definitions if there are more than one localized fields in on class
protected array $referencedFields
return array

$region public property

public string $region
return string

$title public property

public string $title
return string

$width public property

public int $width
return integer