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

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

Public Properties

Property Type Description
$allowedTypes string
$collapsed boolean
$collapsible boolean
$disallowAddRemove boolean
$disallowReorder boolean
$fieldtype string Static type of this element
$lazyLoading boolean
$maxItems integer
$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 ( ) : string
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 = [] ) : string
getDataForGrid ( $data, Concrete $object = null, mixed $params = [] ) : string
getDataForSearchIndex ( $object, mixed $params = [] ) : string
getDataFromEditmode ( string $data, null | AbstractObject $object = null, mixed $params = [] ) : string
getDiffDataFromEditmode ( $data, null $object = null, $params = [] ) : mixed
getDiffVersionPreview ( $data, null $object = null, mixed $params = [] ) : array | string Generates a pretty version preview (similar to getVersionPreview) can be either html or a image URL. See the ObjectMerger plugin documentation for details
getDisallowAddRemove ( ) : boolean
getDisallowReorder ( ) : boolean
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 | AbstractObject $object = null, mixed $params = [], $idMapper = null ) : mixed | Fieldcollection
getGetterCode ( $class ) : string
getLazyLoading ( ) : boolean
getMaxItems ( ) : integer
getVersionPreview ( string $data, null | AbstractObject $object = null, mixed $params = [] ) : string
isCollapsed ( ) : boolean
isCollapsible ( ) : boolean
isDiffChangeAllowed ( string $object, mixed $params = [] ) : boolean True if change is allowed in edit mode.
load ( $object, array $params = [] ) : null | Fieldcollection
preGetData ( $object, array $params = [] ) : null | Fieldcollection
preSetData ( $object, $data, array $params = [] ) : array
resolveDependencies ( mixed $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 )
setCollapsed ( boolean $collapsed )
setCollapsible ( boolean $collapsible )
setDisallowAddRemove ( boolean $disallowAddRemove )
setDisallowReorder ( boolean $disallowReorder )
setLazyLoading ( $lazyLoading )
setMaxItems ( $maxItems )
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|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 ( ) : string
return string

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 = [] ) : 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

getDiffDataFromEditmode() public method

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

getDiffVersionPreview() public method

Generates a pretty version preview (similar to getVersionPreview) can be either html or a image URL. See the ObjectMerger plugin documentation for details
public getDiffVersionPreview ( $data, null $object = null, mixed $params = [] ) : array | string
$data
$object null
$params mixed
return array | string

getDisallowAddRemove() public method

public getDisallowAddRemove ( ) : boolean
return boolean

getDisallowReorder() public method

public getDisallowReorder ( ) : boolean
return boolean

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 | AbstractObject $object = null, mixed $params = [], $idMapper = null ) : mixed | Fieldcollection
$data mixed
$object null | Pimcore\Model\Object\AbstractObject
$params mixed
return mixed | Pimcore\Model\Object\Fieldcollection

getGetterCode() public method

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

getLazyLoading() public method

public getLazyLoading ( ) : boolean
return boolean

getMaxItems() public method

public getMaxItems ( ) : integer
return integer

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

isCollapsed() public method

public isCollapsed ( ) : boolean
return boolean

isCollapsible() public method

public isCollapsible ( ) : 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 = [] ) : null | Fieldcollection
$object
$params array
return null | Pimcore\Model\Object\Fieldcollection

preGetData() public method

public preGetData ( $object, array $params = [] ) : null | Fieldcollection
$object
$params array
return null | Pimcore\Model\Object\Fieldcollection

preSetData() public method

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

resolveDependencies() public method

public resolveDependencies ( mixed $data ) : array
$data mixed
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

setCollapsed() public method

public setCollapsed ( boolean $collapsed )
$collapsed boolean

setCollapsible() public method

public setCollapsible ( boolean $collapsible )
$collapsible boolean

setDisallowAddRemove() public method

public setDisallowAddRemove ( boolean $disallowAddRemove )
$disallowAddRemove boolean

setDisallowReorder() public method

public setDisallowReorder ( boolean $disallowReorder )
$disallowReorder boolean

setLazyLoading() public method

public setLazyLoading ( $lazyLoading )
$lazyLoading

setMaxItems() public method

public setMaxItems ( $maxItems )
$maxItems

synchronizeWithMasterDefinition() public method

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

Property Details

$allowedTypes public property

public string $allowedTypes
return string

$collapsed public property

public bool $collapsed
return boolean

$collapsible public property

public bool $collapsible
return boolean

$disallowAddRemove public property

public bool $disallowAddRemove
return boolean

$disallowReorder public property

public bool $disallowReorder
return boolean

$fieldtype public property

Static type of this element
public string $fieldtype
return string

$lazyLoading public property

public bool $lazyLoading
return boolean

$maxItems public property

public int $maxItems
return integer

$phpdocType public property

Type for the generated phpdoc
public string $phpdocType
return string