PHP Class Pimcore\Model\Document\Tag\Video

Inheritance: extends Pimcore\Model\Document\Tag
Show file Open project: pimcore/pimcore

Public Properties

Property Type Description
$description string
$id mixed ..
$poster integer asset ID of poster image
$title string
$type string one of asset, youtube, vimeo, dailymotion

Public Methods

Method Description
admin ( ) : string
checkValidity ( ) : boolean
frontend ( ) : string
getAssetCode ( $inAdmin = false )
getDailymotionCode ( )
getData ( ) : mixed
getDataForResource ( )
getDescription ( ) : string
getEmptyCode ( )
getErrorCode ( $message = "" )
getFromWebserviceImport ( Pimcore\Model\Webservice\Data\Document\Element $wsElement, $document = null, mixed $params = [], null $idMapper = null )
getHeight ( )
getHtml5Code ( $urls = [], $thumbnail = null )
getId ( ) : mixed
getImageThumbnail ( $config ) : string
getPosterAsset ( ) : Asset
getProgressCode ( $thumbnail = null )
getThumbnail ( $config ) : array
getTitle ( ) : string
getType ( ) : string
getUrlCode ( )
getVideoAsset ( ) : Asset
getVideoType ( ) : string
getVimeoCode ( )
getWidth ( )
getYoutubeCode ( )
isEmpty ( ) : boolean
resolveDependencies ( ) : array
rewriteIds ( array $idMapping ) : void Rewrites id from source to target, $idMapping contains array( "document" => array( SOURCE_ID => TARGET_ID, SOURCE_ID => TARGET_ID ), "object" => array(.
setDataFromEditmode ( mixed $data ) : void
setDataFromResource ( mixed $data )
setDescription ( $description )
setId ( mixed $id ) : Video
setTitle ( $title )

Method Details

admin() public method

See also: Document\Tag\TagInterface::admin
public admin ( ) : string
return string

checkValidity() public method

public checkValidity ( ) : boolean
return boolean

frontend() public method

See also: Document\Tag\TagInterface::frontend
public frontend ( ) : string
return string

getAssetCode() public method

public getAssetCode ( $inAdmin = false )

getDailymotionCode() public method

public getDailymotionCode ( )

getData() public method

See also: Document\Tag\TagInterface::getData
public getData ( ) : mixed
return mixed

getDataForResource() public method

public getDataForResource ( )

getDescription() public method

public getDescription ( ) : string
return string

getEmptyCode() public method

public getEmptyCode ( )

getErrorCode() public method

public getErrorCode ( $message = "" )

getFromWebserviceImport() public method

public getFromWebserviceImport ( Pimcore\Model\Webservice\Data\Document\Element $wsElement, $document = null, mixed $params = [], null $idMapper = null )
$wsElement Pimcore\Model\Webservice\Data\Document\Element
$params mixed
$idMapper null

getHeight() public method

public getHeight ( )

getHtml5Code() public method

public getHtml5Code ( $urls = [], $thumbnail = null )

getId() public method

public getId ( ) : mixed
return mixed

getImageThumbnail() public method

public getImageThumbnail ( $config ) : string
$config
return string

getPosterAsset() public method

public getPosterAsset ( ) : Asset
return Pimcore\Model\Asset

getProgressCode() public method

public getProgressCode ( $thumbnail = null )

getThumbnail() public method

public getThumbnail ( $config ) : array
$config
return array

getTitle() public method

public getTitle ( ) : string
return string

getType() public method

See also: Document\Tag\TagInterface::getType
public getType ( ) : string
return string

getUrlCode() public method

public getUrlCode ( )

getVideoAsset() public method

public getVideoAsset ( ) : Asset
return Pimcore\Model\Asset

getVideoType() public method

public getVideoType ( ) : string
return string

getVimeoCode() public method

public getVimeoCode ( )

getWidth() public method

public getWidth ( )

getYoutubeCode() public method

public getYoutubeCode ( )

isEmpty() public method

public isEmpty ( ) : boolean
return boolean

resolveDependencies() public method

public resolveDependencies ( ) : array
return array

rewriteIds() public method

..), "asset" => array(...) )
public rewriteIds ( array $idMapping ) : void
$idMapping array
return void

setDataFromEditmode() public method

See also: Document\Tag\TagInterface::setDataFromEditmode
public setDataFromEditmode ( mixed $data ) : void
$data mixed
return void

setDataFromResource() public method

See also: Document\Tag\TagInterface::setDataFromResource
public setDataFromResource ( mixed $data )
$data mixed

setDescription() public method

public setDescription ( $description )
$description

setId() public method

public setId ( mixed $id ) : Video
$id mixed
return Video

setTitle() public method

public setTitle ( $title )
$title

Property Details

$description public property

public string $description
return string

$id public property

..
public mixed $id
return mixed

$poster public property

asset ID of poster image
public int $poster
return integer

$title public property

public string $title
return string

$type public property

one of asset, youtube, vimeo, dailymotion
public string $type
return string