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

Inheritance: extends Image
Show file Open project: pimcore/pimcore

Public Properties

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

Public Methods

Method Description
getCacheTags ( mixed $data, array $tags = [] ) : array This is a dummy and is mostly implemented by relation types
getDataForEditmode ( Pimcore\Model\Object\Data\Hotspotimage $data, null | AbstractObject $object = null, mixed $params = [] ) : integer
getDataForGrid ( $data, null $object = null, mixed $params = [] ) : null
getDataForQueryResource ( Pimcore\Model\Object\Data\Hotspotimage $data, null | AbstractObject $object = null, mixed $params = [] ) : integer | null
getDataForResource ( Pimcore\Model\Object\Data\Hotspotimage $data, null | AbstractObject $object = null, mixed $params = [] ) : integer | null
getDataFromEditmode ( Pimcore\Model\Object\Data\Hotspotimage $data, null | AbstractObject $object = null, mixed $params = [] ) : Asset
getDataFromResource ( Pimcore\Model\Object\Data\Hotspotimage $data, null | AbstractObject $object = null, mixed $params = [] ) : Asset
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 = [] ) : mixed | null | Data
getFromWebserviceImport ( mixed $value, null $object = null, array $params = [], null $idMapper = null ) : null | Asset | Pimcore\Model\Object\Data\Hotspotimage
getRatioX ( ) : integer
getRatioY ( ) : integer
getVersionPreview ( Image $data, null | AbstractObject $object = null, mixed $params = [] ) : string
marshal ( mixed $value, AbstractObject $object = null, mixed $params = [] ) : mixed Encode value for packing it into a single column.
resolveDependencies ( mixed $data ) : array
rewriteIds ( mixed $object, array $idMapping, array $params = [] ) : Pimcore\Model\Element\ElementInterface Rewrites id from source to target, $idMapping contains array( "document" => array( SOURCE_ID => TARGET_ID, SOURCE_ID => TARGET_ID ), "object" => array(.
setRatioX ( integer $ratioX )
setRatioY ( integer $ratioY )
unmarshal ( mixed $value, AbstractObject $object = null, mixed $params = [] ) : mixed See marshal

Private Methods

Method Description
rewriteIdsInDataEntries ( $dataArray, $idMapping ) : array

Method Details

getCacheTags() public method

This is a dummy and is mostly implemented by relation types
public getCacheTags ( mixed $data, array $tags = [] ) : array
$data mixed
$tags array
return array

getDataForEditmode() public method

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

getDataForGrid() public method

public getDataForGrid ( $data, null $object = null, mixed $params = [] ) : null
$data
$object null
$params mixed
return null

getDataForQueryResource() public method

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

getDataForResource() public method

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

getDataFromEditmode() public method

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

getDataFromResource() public method

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

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

getFromWebserviceImport() public method

public getFromWebserviceImport ( mixed $value, null $object = null, array $params = [], null $idMapper = null ) : null | Asset | Pimcore\Model\Object\Data\Hotspotimage
$value mixed
$object null
$params array
$idMapper null
return null | Pimcore\Model\Asset | Pimcore\Model\Object\Data\Hotspotimage

getRatioX() public method

public getRatioX ( ) : integer
return integer

getRatioY() public method

public getRatioY ( ) : integer
return integer

getVersionPreview() public method

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

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

resolveDependencies() public method

public resolveDependencies ( mixed $data ) : array
$data mixed
return array

rewriteIds() public method

..), "asset" => array(...) )
public rewriteIds ( mixed $object, array $idMapping, array $params = [] ) : Pimcore\Model\Element\ElementInterface
$object mixed
$idMapping array
$params array
return Pimcore\Model\Element\ElementInterface

setRatioX() public method

public setRatioX ( integer $ratioX )
$ratioX integer

setRatioY() public method

public setRatioY ( integer $ratioY )
$ratioY integer

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

$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

$ratioX public property

public int $ratioX
return integer

$ratioY public property

public int $ratioY
return integer