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

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

Public Properties

Property Type Description
$columnType string Type for the column
$fieldtype string Static type of this element
$height integer
$maxItems integer
$options array Available options to select
$phpdocType string Type for the generated phpdoc
$queryColumnType string Type for the column to query
$width integer

Public Methods

Method Description
checkValidity ( mixed $data, boolean $omitMandatoryCheck = false ) Checks if data is valid for current data field
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
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
getFromCsvImport ( $importValue, null | AbstractObject $object = null, mixed $params = [] ) : array | mixed
getHeight ( ) : integer
getMaxItems ( ) : integer
getOptions ( ) : array
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.
setHeight ( array $height )
setMaxItems ( $maxItems )
setOptions ( array $options )
setWidth ( array $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

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

getFilterCondition() public method

returns sql query statement to filter according to this data types value(s)
public getFilterCondition ( $value, $operator ) : string
$value
$operator
return string

getFilterConditionExt() public method

returns sql query statement to filter according to this data types value(s)
public getFilterConditionExt ( $value, $operator, $params = [] ) : string
$value
$operator
$params optional params used to change the behavior
return 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 = [] ) : array | mixed
$importValue
$object null | Pimcore\Model\Object\AbstractObject
$params mixed
return array | mixed

getHeight() public method

public getHeight ( ) : integer
return integer

getMaxItems() public method

public getMaxItems ( ) : integer
return integer

getOptions() public method

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

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

setHeight() public method

public setHeight ( array $height )
$height array

setMaxItems() public method

public setMaxItems ( $maxItems )
$maxItems

setOptions() public method

public setOptions ( array $options )
$options array

setWidth() public method

public setWidth ( array $width )
$width array

synchronizeWithMasterDefinition() public method

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

Property Details

$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

$maxItems public property

public int $maxItems
return integer

$options public property

Available options to select
public array $options
return array

$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

$width public property

public int $width
return integer