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

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

Public Properties

Property Type Description
$childs array
$collapsed boolean
$collapsible boolean
$columnType string Type for the column
$disallowAddRemove boolean
$disallowReorder boolean
$fieldDefinitionsCache array
$fieldtype string Static type of this element
$layout string
$phpdocType string Type for the generated phpdoc
$queryColumnType string Type for the column to query

Protected Properties

Property Type Description
$referencedFields array contains further child 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 )
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
getDataForQueryResource ( string $data, null | AbstractObject $object = null, mixed $params = [] ) : string
getDataForResource ( string $data, null | AbstractObject $object = null, mixed $params = [] ) : string
getDataFromEditmode ( string $data, null | AbstractObject $object = null, mixed $params = [] ) : string
getDataFromResource ( string $data, null | AbstractObject $object = null, mixed $params = [] ) : string
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
getFieldDefinitions ( ) : array
getFielddefinition ( $name ) : mixed
getForCsvExport ( AbstractObject $object, array $params = [] ) : string converts object data to a simple string value or CSV Export
getForWebserviceExport ( string $object, mixed $params = [] ) : mixed converts data to be exposed via webservices
getFromCsvImport ( $importValue, null | AbstractObject $object = null, mixed $params = [] ) : string
getFromWebserviceImport ( mixed $value, null $relatedObject = null, mixed $params = [], null $idMapper = null ) : mixed | void
getLayout ( ) : string
getReferencedFields ( ) : array
getVersionPreview ( string $data, null | AbstractObject $object = null, mixed $params = [] ) : string
hasChildren ( ) : boolean
isCollapsed ( ) : boolean
isCollapsible ( ) : boolean
isDiffChangeAllowed ( string $object, mixed $params = [] ) : boolean True if change is allowed in edit mode.
isEmpty ( Pimcore\Model\Object\Data\ExternalImage $data ) : boolean
resolveDependencies ( $data ) : array
setChildren ( array $children )
setCollapsed ( boolean $collapsed )
setCollapsible ( boolean $collapsible )
setLayout ( $layout )
setReferencedFields ( array $referencedFields )
setValues ( mixed $data = [], array $blockedKeys = [] ) : void
synchronizeWithMasterDefinition ( Data $masterDefinition )

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

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

getDataForQueryResource() public method

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

getDataForResource() public method

See also: Object\ClassDefinition\Data::getDataForResource
public getDataForResource ( string $data, null | AbstractObject $object = null, mixed $params = [] ) : string
$data string
$object null | Pimcore\Model\Object\AbstractObject
$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

getDataFromResource() public method

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

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

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

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

getFromCsvImport() public method

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

getFromWebserviceImport() public method

public getFromWebserviceImport ( mixed $value, null $relatedObject = null, mixed $params = [], null $idMapper = null ) : mixed | void
$value mixed
$relatedObject null
$params mixed
$idMapper null
return mixed | void

getLayout() public method

public getLayout ( ) : string
return string

getReferencedFields() public method

public getReferencedFields ( ) : array
return array

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

hasChildren() public method

public hasChildren ( ) : boolean
return boolean

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

isEmpty() public method

public isEmpty ( Pimcore\Model\Object\Data\ExternalImage $data ) : boolean
$data Pimcore\Model\Object\Data\ExternalImage
return boolean

resolveDependencies() public method

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

setChildren() public method

public setChildren ( array $children )
$children array

setCollapsed() public method

public setCollapsed ( boolean $collapsed )
$collapsed boolean

setCollapsible() public method

public setCollapsible ( boolean $collapsible )
$collapsible boolean

setLayout() public method

public setLayout ( $layout )
$layout

setReferencedFields() public method

public setReferencedFields ( array $referencedFields )
$referencedFields array

setValues() public method

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

synchronizeWithMasterDefinition() public method

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

Property Details

$childs public property

public array $childs
return array

$collapsed public property

public bool $collapsed
return boolean

$collapsible public property

public bool $collapsible
return boolean

$columnType public property

Type for the column
public string $columnType
return string

$disallowAddRemove public property

public bool $disallowAddRemove
return boolean

$disallowReorder public property

public bool $disallowReorder
return boolean

$fieldDefinitionsCache public property

public array $fieldDefinitionsCache
return array

$fieldtype public property

Static type of this element
public string $fieldtype
return string

$layout public property

public string $layout
return string

$phpdocType public property

Type for the generated phpdoc
public string $phpdocType
return string

$queryColumnType public property

Type for the column to query
public string $queryColumnType
return string

$referencedFields protected property

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