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

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

Public Properties

Property Type Description
$columnType string Type for the column
$defaultUnit string
$defaultValue float
$fieldtype string Static type of this element
$phpdocType string Type for the generated phpdoc
$queryColumnType integer Type for the column to query
$validUnits array()
$width float

Public Methods

Method Description
__set_state ( $data ) : static
checkValidity ( mixed $data, boolean $omitMandatoryCheck = false ) Checks if data is valid for current data field
configureOptions ( )
getDataForEditmode ( float $data, null | AbstractObject $object = null, mixed $params = [] ) : float
getDataForQueryResource ( float $data, null | AbstractObject $object = null, mixed $params = [] ) : float
getDataForResource ( float $data, null | AbstractObject $object = null, mixed $params = [] ) : float
getDataFromEditmode ( float $data, Concrete $object = null, mixed $params = [] ) : float
getDataFromResource ( float $data, null | AbstractObject $object = null, mixed $params = [] ) : float
getDefaultUnit ( ) : string
getDefaultValue ( ) : integer
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 ( string $importValue, null | AbstractObject $object = null, mixed $params = [] ) : double 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
getValidUnits ( ) : array()
getVersionPreview ( float $data, null | AbstractObject $object = null, mixed $params = [] ) : float
getWidth ( ) : integer
marshal ( mixed $value, AbstractObject $object = null, mixed $params = [] ) : mixed Encode value for packing it into a single column.
setDefaultUnit ( string $defaultUnit )
setDefaultValue ( integer $defaultValue ) : void
setValidUnits ( array() $validUnits ) : void
setWidth ( integer $width ) : void
unmarshal ( mixed $value, AbstractObject $object = null, mixed $params = [] ) : mixed See marshal

Method Details

__set_state() public static method

public static __set_state ( $data ) : static
$data
return static

checkValidity() public method

Checks if data is valid for current data field
public checkValidity ( mixed $data, boolean $omitMandatoryCheck = false )
$data mixed
$omitMandatoryCheck boolean

configureOptions() public method

public configureOptions ( )

getDataForEditmode() public method

See also: Object_Class_Data::getDataForEditmode
public getDataForEditmode ( float $data, null | AbstractObject $object = null, mixed $params = [] ) : float
$data float
$object null | Pimcore\Model\Object\AbstractObject
$params mixed
return float

getDataForQueryResource() public method

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

getDataForResource() public method

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

getDataFromEditmode() public method

See also: Object_Class_Data::getDataFromEditmode
public getDataFromEditmode ( float $data, Concrete $object = null, mixed $params = [] ) : float
$data float
$object Pimcore\Model\Object\Concrete
$params mixed
return float

getDataFromResource() public method

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

getDefaultUnit() public method

public getDefaultUnit ( ) : string
return string

getDefaultValue() public method

public getDefaultValue ( ) : integer
return integer

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

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

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

getValidUnits() public method

public getValidUnits ( ) : array()
return array()

getVersionPreview() public method

See also: Object_Class_Data::getVersionPreview
public getVersionPreview ( float $data, null | AbstractObject $object = null, mixed $params = [] ) : float
$data float
$object null | Pimcore\Model\Object\AbstractObject
$params mixed
return float

getWidth() public method

public getWidth ( ) : integer
return integer

marshal() public method

Encode value for packing it into a single column.
public marshal ( mixed $value, AbstractObject $object = null, mixed $params = [] ) : mixed
$value mixed
$object Pimcore\Model\Object\AbstractObject
$params mixed
return mixed

setDefaultUnit() public method

public setDefaultUnit ( string $defaultUnit )
$defaultUnit string

setDefaultValue() public method

public setDefaultValue ( integer $defaultValue ) : void
$defaultValue integer
return void

setValidUnits() public method

public setValidUnits ( array() $validUnits ) : void
$validUnits array()
return void

setWidth() public method

public setWidth ( integer $width ) : void
$width integer
return void

unmarshal() public method

See marshal
public unmarshal ( mixed $value, AbstractObject $object = null, mixed $params = [] ) : mixed
$value mixed
$object Pimcore\Model\Object\AbstractObject
$params mixed
return mixed

Property Details

$columnType public property

Type for the column
public string $columnType
return string

$defaultUnit public property

public string $defaultUnit
return string

$defaultValue public property

public float $defaultValue
return float

$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 int $queryColumnType
return integer

$validUnits public property

public array() $validUnits
return array()

$width public property

public float $width
return float