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

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

Public Properties

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

Public Methods

Method Description
getCacheTags ( mixed $data, array $tags = [] ) : array This is a dummy and is mostly implemented by relation types
getDataForEditmode ( Asset $data, null | AbstractObject $object = null, mixed $params = [] ) : integer
getDataForQueryResource ( Asset $data, null | AbstractObject $object = null, mixed $params = [] ) : integer | null
getDataForResource ( Asset $data, null | AbstractObject $object = null, mixed $params = [] ) : integer | null
getDataFromEditmode ( integer $data, null | AbstractObject $object = null, mixed $params = [] ) : Asset
getDataFromResource ( integer $data, null | AbstractObject $object = null, mixed $params = [] ) : Asset
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
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 | null | Asset
getFromWebserviceImport ( mixed $value, null $object = null, array $params = [], null $idMapper = null ) : null | Asset | Archive | Audio | Document | Folder | Image | Text | Unknown | Video
getHeight ( ) : integer
getUploadPath ( ) : string
getVersionPreview ( Image $data, null | Object\AbstractObject $object = null, mixed $params = [] ) : string
getWidth ( ) : integer
isDiffChangeAllowed ( string $object, mixed $params = [] ) : boolean True if change is allowed in edit mode.
marshal ( mixed $value, AbstractObject $object = null, mixed $params = [] ) : mixed Encode value for packing it into a single column.
resolveDependencies ( $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(.
setHeight ( integer $height )
setUploadPath ( $uploadPath )
setWidth ( integer $width )
synchronizeWithMasterDefinition ( Data $masterDefinition )
unmarshal ( mixed $value, AbstractObject $object = null, mixed $params = [] ) : mixed See marshal

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 ( Asset $data, null | AbstractObject $object = null, mixed $params = [] ) : integer
$data Pimcore\Model\Asset
$object null | Pimcore\Model\Object\AbstractObject
$params mixed
return integer

getDataForQueryResource() public method

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

getDataForResource() public method

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

getDataFromEditmode() public method

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

getDataFromResource() public method

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

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

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 | null | Asset
$importValue
$object null | Pimcore\Model\Object\AbstractObject
$params mixed
return mixed | null | Pimcore\Model\Asset

getFromWebserviceImport() public method

public getFromWebserviceImport ( mixed $value, null $object = null, array $params = [], null $idMapper = null ) : null | Asset | Archive | Audio | Document | Folder | Image | Text | Unknown | Video
$value mixed
$object null
$params array
$idMapper null
return null | Pimcore\Model\Asset | Pimcore\Model\Asset\Archive | Pimcore\Model\Asset\Audio | Pimcore\Model\Asset\Document | Pimcore\Model\Asset\Folder | Pimcore\Model\Asset\Image | Pimcore\Model\Asset\Text | Pimcore\Model\Asset\Unknown | Pimcore\Model\Asset\Video

getHeight() public method

public getHeight ( ) : integer
return integer

getUploadPath() public method

public getUploadPath ( ) : string
return string

getVersionPreview() public method

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

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 ( $data ) : array
$data
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

setHeight() public method

public setHeight ( integer $height )
$height integer

setUploadPath() public method

public setUploadPath ( $uploadPath )
$uploadPath

setWidth() public method

public setWidth ( integer $width )
$width integer

synchronizeWithMasterDefinition() public method

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

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

$height public property

Type for the column to query
public int $height
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

$uploadPath public property

public string $uploadPath
return string

$width public property

public int $width
return integer