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

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

Public Properties

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

Public Methods

Method Description
checkValidity ( mixed $data, boolean $omitMandatoryCheck = false ) Checks if data is valid for current data field
getCols ( ) : object
getColumnType ( ) : array | string
getDataForEditmode ( string $data, null | AbstractObject $object = null, mixed $params = [] ) : string
getDataForGrid ( $data, null $object = null, mixed $params = [] ) : array | null
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 = [] ) : Pimcore\Model\Object\Data\StructuredTable
getDiffDataForEditMode ( mixed $data, null $object = null, mixed $params = [] ) : array | null See parent class.
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 = [] ) : mixed | Pimcore\Model\Object\Data\StructuredTable
getFromWebserviceImport ( mixed $value, null $object = null, mixed $params = [], null $idMapper = null ) : mixed | void
getHeight ( ) : integer
getLabelFirstCell ( ) : string
getLabelWidth ( ) : integer
getQueryColumnType ( ) : array | string
getRows ( ) : object
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.
isEmpty ( $data ) : boolean
setCols ( object $cols ) : void
setHeight ( integer $height ) : void
setLabelFirstCell ( $labelFirstCell )
setLabelWidth ( integer $labelWidth ) : void
setRows ( object $rows ) : void
setWidth ( integer $width )
sort ( $a, $b )
synchronizeWithMasterDefinition ( Data $masterDefinition )

Protected Methods

Method Description
calculateDbColumns ( ) : array
typeMapper ( $type, $length = null ) : string | null

Method Details

calculateDbColumns() protected method

protected calculateDbColumns ( ) : array
return array

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 ( ) : object
return object

getColumnType() public method

public getColumnType ( ) : array | string
return array | string

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

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

getDiffDataForEditMode() public method

See parent class.
public getDiffDataForEditMode ( mixed $data, null $object = null, mixed $params = [] ) : array | null
$data mixed
$object null
$params mixed
return array | null

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 = [] ) : mixed | Pimcore\Model\Object\Data\StructuredTable
$importValue
$object null | Pimcore\Model\Object\AbstractObject
$params mixed
return mixed | Pimcore\Model\Object\Data\StructuredTable

getFromWebserviceImport() public method

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

getHeight() public method

public getHeight ( ) : integer
return integer

getLabelFirstCell() public method

public getLabelFirstCell ( ) : string
return string

getLabelWidth() public method

public getLabelWidth ( ) : integer
return integer

getQueryColumnType() public method

public getQueryColumnType ( ) : array | string
return array | string

getRows() public method

public getRows ( ) : object
return object

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

isEmpty() public method

public isEmpty ( $data ) : boolean
$data
return boolean

setCols() public method

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

setHeight() public method

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

setLabelFirstCell() public method

public setLabelFirstCell ( $labelFirstCell )
$labelFirstCell

setLabelWidth() public method

public setLabelWidth ( integer $labelWidth ) : void
$labelWidth integer
return void

setRows() public method

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

setWidth() public method

public setWidth ( integer $width )
$width integer

sort() public method

public sort ( $a, $b )

synchronizeWithMasterDefinition() public method

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

typeMapper() protected method

protected typeMapper ( $type, $length = null ) : string | null
$type string text|number|bool
$length int The length of the column, default is 255 for text
return string | null

Property Details

$cols public property

public object $cols
return object

$columnType public property

Type for the column
public string $columnType
return string

$fieldtype public property

Static type of this element
public string $fieldtype
return string

$height public property

public int $height
return integer

$labelFirstCell public property

public string $labelFirstCell
return string

$labelWidth public property

public int $labelWidth
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 object $rows
return object

$width public property

public int $width
return integer