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

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

Public Properties

Property Type Description
$cols integer
$columnType string Type for the column
$data integer Default data
$fieldtype string Static type of this element
$height integer
$phpdocType string Type for the generated phpdoc
$queryColumnType string Type for the column to query
$rows integer
$width integer

Public Methods

Method Description
checkValidity ( mixed $data, boolean $omitMandatoryCheck = false ) Checks if data is valid for current data field
getCols ( ) : integer
getData ( ) : integer
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
getDataForSearchIndex ( $object, 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
getForCsvExport ( AbstractObject $object, array $params = [] ) : string converts object data to a simple string value or CSV Export
getFromCsvImport ( $importValue, null | AbstractObject $object = null, mixed $params = [] ) : mixed | null
getFromWebserviceImport ( mixed $value, null $object = null, mixed $params = [], $idMapper = null ) : array | mixed converts data to be imported via webservices
getHeight ( ) : integer
getRows ( ) : integer
getVersionPreview ( string $data, null | AbstractObject $object = null, mixed $params = [] ) : string
getWidth ( ) : integer
isDiffChangeAllowed ( string $object, mixed $params = [] ) : boolean True if change is allowed in edit mode.
setCols ( integer $cols ) : void
setData ( integer $data ) : void
setHeight ( integer $height ) : void
setRows ( integer $rows ) : void
setWidth ( integer $width )
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

getCols() public method

public getCols ( ) : integer
return integer

getData() public method

public getData ( ) : integer
return integer

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

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

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

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

getFromCsvImport() public method

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

getFromWebserviceImport() public method

converts data to be imported via webservices
public getFromWebserviceImport ( mixed $value, null $object = null, mixed $params = [], $idMapper = null ) : array | mixed
$value mixed
$object null
$params mixed
return array | mixed

getHeight() public method

public getHeight ( ) : integer
return integer

getRows() public method

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

getWidth() public method

public getWidth ( ) : integer
return integer

isDiffChangeAllowed() public method

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

setCols() public method

public setCols ( integer $cols ) : void
$cols integer
return void

setData() public method

public setData ( integer $data ) : void
$data integer
return void

setHeight() public method

public setHeight ( integer $height ) : void
$height integer
return void

setRows() public method

public setRows ( integer $rows ) : void
$rows integer
return void

setWidth() public method

public setWidth ( integer $width )
$width integer

synchronizeWithMasterDefinition() public method

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

Property Details

$cols public property

public int $cols
return integer

$columnType public property

Type for the column
public string $columnType
return string

$data public property

Default data
public int $data
return integer

$fieldtype public property

Static type of this element
public string $fieldtype
return string

$height public property

public int $height
return integer

$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

$rows public property

public int $rows
return integer

$width public property

public int $width
return integer