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

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
$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
getDataForGrid ( $data, null $object = null, mixed $params = [] ) : mixed
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
getFromWebserviceImport ( mixed $value, mixed $relatedObject = null, mixed $params = [], $idMapper = null ) : mixed converts data to be imported via webservices
getHeight ( ) : integer
getVersionPreview ( Image $data, null | 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 ( $object, $idMapping, array $params = [] ) : mixed
setHeight ( integer $height )
setWidth ( integer $width )
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

getDataForGrid() public method

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

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

getFromWebserviceImport() public method

converts data to be imported via webservices
public getFromWebserviceImport ( mixed $value, mixed $relatedObject = null, mixed $params = [], $idMapper = null ) : mixed
$value mixed
$relatedObject mixed
$params mixed
return mixed

getHeight() public method

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

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

public rewriteIds ( $object, $idMapping, array $params = [] ) : mixed
$object
$idMapping
$params array
return mixed

setHeight() public method

public setHeight ( integer $height )
$height integer

setWidth() public method

public setWidth ( integer $width )
$width 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

$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

$width public property

public int $width
return integer