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

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

Public Properties

Property Type Description
$columnType string Type for the column
$defaultValue boolean
$fieldtype string Static type of this element
$phpdocType string Type for the generated phpdoc
$queryColumnType string Type for the column to query

Public Methods

Method Description
checkValidity ( mixed $data, boolean $omitMandatoryCheck = false ) Checks if data is valid for current data field
getDataForEditmode ( boolean $data, null | AbstractObject $object = null, mixed $params = [] ) : boolean
getDataForQueryResource ( boolean $data, null | AbstractObject $object = null, mixed $params = [] ) : boolean
getDataForResource ( boolean $data, null | AbstractObject $object = null, mixed $params = [] ) : integer
getDataFromEditmode ( boolean $data, null | AbstractObject $object = null, mixed $params = [] ) : boolean
getDataFromResource ( boolean $data, null | AbstractObject $object = null, mixed $params = [] ) : boolean
getDefaultValue ( ) : integer
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 ( $object, $params = [] )
getFromCsvImport ( string $importValue, null | AbstractObject $object = null, mixed $params = [] ) : Data fills object field data values from CSV Import String
getFromWebserviceImport ( mixed $value, null | AbstractObject $object = null, mixed $params = [], $idMapper = null ) : mixed converts data to be imported via webservices
getVersionPreview ( boolean $data, null | AbstractObject $object = null, mixed $params = [] ) : boolean
isDiffChangeAllowed ( string $object, mixed $params = [] ) : boolean True if change is allowed in edit mode.
setDefaultValue ( integer $defaultValue )
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 ( boolean $data, null | AbstractObject $object = null, mixed $params = [] ) : boolean
$data boolean
$object null | Pimcore\Model\Object\AbstractObject
$params mixed
return boolean

getDataForQueryResource() public method

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

getDataForResource() public method

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

getDataFromEditmode() public method

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

getDataFromResource() public method

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

getDefaultValue() public method

public getDefaultValue ( ) : integer
return integer

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

getForWebserviceExport() public method

public getForWebserviceExport ( $object, $params = [] )

getFromCsvImport() public method

fills object field data values from CSV Import String
public getFromCsvImport ( string $importValue, null | AbstractObject $object = null, mixed $params = [] ) : Data
$importValue string
$object null | Pimcore\Model\Object\AbstractObject
$params mixed
return Pimcore\Model\Object\ClassDefinition\Data

getFromWebserviceImport() public method

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

getVersionPreview() public method

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

setDefaultValue() public method

public setDefaultValue ( integer $defaultValue )
$defaultValue integer

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

$defaultValue public property

public bool $defaultValue
return boolean

$fieldtype public property

Static type of this element
public string $fieldtype
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