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

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

Public Properties

Property Type Description
$allowedTypes array
$fieldtype string Static type of this element
$phpdocType string Type for the generated phpdoc

Public Methods

Method Description
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
collectCalculatedValueItems ( $container, &$list = [] )
delete ( $object )
getAllowedTypes ( ) : array
getCacheTags ( mixed $data, array $tags = [] ) : array This is a dummy and is mostly implemented by relation types
getDataForEditmode ( string $data, null | AbstractObject $object = null, mixed $params = [], $objectFromVersion = null ) : string
getDataForGrid ( $data, Concrete $object = null, mixed $params = [] ) : string
getDataForSearchIndex ( $object, mixed $params = [] ) : string
getDataFromEditmode ( string $data, null | AbstractObject $object = null, mixed $params = [] ) : string
getDiffDataForEditMode ( mixed $data, null $object = null, mixed $params = [], $objectFromVersion = null ) : array | null See parent class.
getDiffDataFromEditmode ( $data, null $object = null, mixed $params = [] ) : null | Pimcore\Date See parent class.
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 $data, null $relatedObject = null, mixed $params = [], null $idMapper = null ) : mixed
getGetterCode ( $class )
getVersionPreview ( string $data, null | AbstractObject $object = null, mixed $params = [] ) : string
isDiffChangeAllowed ( string $object, mixed $params = [] ) : boolean True if change is allowed in edit mode.
load ( $object, array $params = [] ) : null
preSetData ( $object, $value, array $params = [] ) : mixed
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 = [] )
setAllowedTypes ( $allowedTypes )
synchronizeWithMasterDefinition ( Data $masterDefinition )

Private Methods

Method Description
doGetDataForEditmode ( $getter, $data, $params, $allowedBrickType, $objectFromVersion, integer $level ) : array
doGetDiffDataForEditmode ( $data, $getter, $objectFromVersion, integer $level ) : array
getDataForField ( $item, $key, $fielddefinition, $level, $baseObject, $getter, $objectFromVersion ) : mixed gets recursively attribute data from parent and fills objectData and metaData
getDiffDataForField ( $item, $key, $fielddefinition, $level, $baseObject, $getter, $objectFromVersion )

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

collectCalculatedValueItems() public static method

public static collectCalculatedValueItems ( $container, &$list = [] )

delete() public method

public delete ( $object )
$object

getAllowedTypes() public method

public getAllowedTypes ( ) : 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

getDataForEditmode() public method

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

getDataForGrid() public method

public getDataForGrid ( $data, Concrete $object = null, mixed $params = [] ) : string
$data
$object Pimcore\Model\Object\Concrete
$params mixed
return string

getDataForSearchIndex() public method

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

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 = [], $objectFromVersion = null ) : 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

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 $data, null $relatedObject = null, mixed $params = [], null $idMapper = null ) : mixed
$data mixed
$relatedObject null
$params mixed
$idMapper null
return mixed

getGetterCode() public method

public getGetterCode ( $class )

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

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 = [] ) : null
$object
$params array
return null

preSetData() public method

public preSetData ( $object, $value, array $params = [] ) : mixed
$object
$value
$params array
return mixed

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

setAllowedTypes() public method

public setAllowedTypes ( $allowedTypes )
$allowedTypes

synchronizeWithMasterDefinition() public method

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

Property Details

$allowedTypes public property

public array $allowedTypes
return array

$fieldtype public property

Static type of this element
public string $fieldtype
return string

$phpdocType public property

Type for the generated phpdoc
public string $phpdocType
return string