• Home
• Pimcore
• Model
• Object
• ClassDefinition
• Data

PHP Class Pimcore\Model\Object\ClassDefinition\Data

Show file Open project: pimcore/pimcore Class Usage Examples

Public Properties

Property	Type	Description
$columnType	string | array	| array
$datatype	string
$fieldtype	string
$index	integer
$invisible	boolean
$locked	boolean
$mandatory	boolean
$name	string
$noteditable	boolean
$permissions	array
$queryColumnType	string | array	| array
$relationType	boolean
$style	boolean
$title	string
$tooltip	string
$validFilterOperators	array
$visibleGridView	boolean
$visibleSearch	boolean

Protected Properties

Property	Type	Description
$dropNullValues		If set to true then null values will not be exported.

Public Methods

Method	Description
adoptMasterDefinition ( Data $masterDefinition )
checkValidity ( mixed $data, boolean $omitMandatoryCheck = false )	Checks if data is valid for current data field
getAsFloatCast ( $number ) : float
getAsIntegerCast ( $number ) : integer | null
getCacheTags ( mixed $data, array $tags = [] ) : array	This is a dummy and is mostly implemented by relation types
getColumnType ( ) : string | array
getDataForEditmode ( mixed $data, null | AbstractObject $object = null, mixed $params = [] ) : mixed	Returns the data for the editmode
getDataForSearchIndex ( $object, mixed $params = [] ) : string
getDataFromEditmode ( mixed $data, null | AbstractObject $object = null, mixed $params = [] ) : mixed	Converts data from editmode to internal eg. Image-Id to Asset\Image object
getDatatype ( ) : string
getDiffDataForEditMode ( mixed $data, null | AbstractObject $object = null, mixed $params = [] ) : null | array	Returns the data for the editmode in the format expected by the object merger plugin.
getDiffDataFromEditmode ( $data, null $object = null, mixed $params = [] ) : mixed	Converts the data sent from the object merger plugin back to the internal object. Similar to getDiffDataForEditMode() an array of data elements is passed in containing the following attributes: - "field" => the name of (this) field - "key" => the key of the data element - "data" => the data
getDropNullValues ( )
getFieldtype ( ) : string
getFilterCondition ( $value, $operator ) : string	returns sql query statement to filter according to this data types value(s)
getFilterConditionExt ( $value, $operator, $params = [] ) : string	returns sql query statement to filter according to this data types value(s)
getForCsvExport ( AbstractObject $object, array $params = [] ) : string	converts object data to a simple string value or CSV Export
getForWebserviceExport ( AbstractObject $object, mixed $params = [] ) : mixed	converts data to be exposed via webservices
getFromCsvImport ( $importValue, null | AbstractObject $object = null, mixed $params = [] ) : mixed
getFromWebserviceImport ( mixed $value, null | AbstractObject $object = null, mixed $params = [], $idMapper = null ) : mixed	converts data to be imported via webservices
getGetterCode ( $class ) : string	Creates getter code which is used for generation of php file for object classes using this data type
getGetterCodeFieldcollection ( $fieldcollectionDefinition ) : string	Creates getter code which is used for generation of php file for fieldcollectionk classes using this data type
getGetterCodeLocalizedfields ( $class ) : string	Creates getter code which is used for generation of php file for localized fields in classes using this data type
getGetterCodeObjectbrick ( $brickClass ) : string	Creates getter code which is used for generation of php file for object brick classes using this data type
getIndex ( ) : integer
getInvisible ( ) : boolean
getLocked ( ) : boolean
getMandatory ( ) : boolean
getName ( ) : string
getNoteditable ( ) : boolean
getPermissions ( ) : array
getPhpdocType ( ) : string
getQueryColumnType ( ) : string | array
getSetterCode ( $class ) : string	Creates setter code which is used for generation of php file for object classes using this data type
getSetterCodeFieldcollection ( $fieldcollectionDefinition ) : string	Creates setter code which is used for generation of php file for fieldcollection classes using this data type
getSetterCodeLocalizedfields ( $class ) : string	Creates setter code which is used for generation of php file for localized fields in classes using this data type
getSetterCodeObjectbrick ( $brickClass ) : string	Creates setter code which is used for generation of php file for object brick classes using this data type
getStyle ( ) : boolean
getTitle ( ) : string
getTooltip ( ) : string
getVersionPreview ( $data, null | AbstractObject $object = null, mixed $params = [] ) : string
getVisibleGridView ( ) : boolean
getVisibleSearch ( ) : boolean
isDiffChangeAllowed ( string $object, mixed $params = [] ) : boolean	True if change is allowed in edit mode.
isEmpty ( Concrete $data ) : boolean
isRelationType ( ) : boolean
marshal ( mixed $value, AbstractObject $object = null, mixed $params = [] ) : mixed	Encode value for packing it into a single column.
resolveDependencies ( $data ) : array
setColumnType ( string | array $columnType )
setDatatype ( string $datatype )
setDropNullValues ( $dropNullValues )
setFieldtype ( string $fieldtype )
setIndex ( integer $index )
setInvisible ( $invisible )
setLocked ( $locked )
setMandatory ( boolean $mandatory )
setName ( string $name )
setNoteditable ( boolean $noteditable )
setPermissions ( array $permissions )
setQueryColumnType ( string | array $queryColumnType )
setStyle ( $style )
setTitle ( string $title )
setTooltip ( $tooltip )
setValues ( array $data = [] )
setVisibleGridView ( $visibleGridView )
setVisibleSearch ( $visibleSearch )
synchronizeWithMasterDefinition ( Data $masterDefinition )
unmarshal ( $data, AbstractObject $object = null, $params = [] ) : mixed	See marshal

Protected Methods

Method	Description
getDataFromObjectParam ( $object, array $params = [] ) : mixed

Method Details

Property Details