PHP Class Pimcore\Model\Document\Tag\Image

Inheritance: extends Pimcore\Model\Document\Tag
Datei anzeigen Open project: pimcore/pimcore

Public Properties

Property Type Description
$alt string The ALT text of the image
$cropHeight float
$cropLeft float
$cropPercent boolean
$cropTop float
$cropWidth float
$hotspots array
$id integer ID of the referenced image
$image Pimcore\Model\Asset\Image Contains the imageobject itself
$marker array

Public Methods

Method Description
__sleep ( )
frontend ( ) : string
getAlt ( ) *
getCacheTags ( $ownerDocument, $tags = [] )
getCropHeight ( ) : float
getCropLeft ( ) : float
getCropPercent ( ) : boolean
getCropTop ( ) : float
getCropWidth ( ) : float
getData ( ) : mixed
getDataEditmode ( ) : array Converts the data so it's suitable for the editmode
getDataForResource ( )
getFromWebserviceImport ( Pimcore\Model\Webservice\Data\Document\Element $wsElement, $document = null, mixed $params = [], null $idMapper = null )
getHotspots ( ) : array
getId ( ) : integer
getImage ( ) : Image
getMarker ( ) : array
getSrc ( ) *
getText ( ) *
getThumbnail ( $conf, boolean $deferred = true ) : Thumbnail | string
getType ( ) : string
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(.
setCropHeight ( $cropHeight )
setCropLeft ( $cropLeft )
setCropPercent ( $cropPercent )
setCropTop ( $cropTop )
setCropWidth ( $cropWidth )
setDataFromEditmode ( mixed $data )
setDataFromResource ( mixed $data )
setHotspots ( array $hotspots )
setId ( integer $id ) : Image
setImage ( Image $image ) : Image
setMarker ( array $marker )

Protected Methods

Method Description
applyCustomCropping ( $thumbConfig ) : mixed

Method Details

__sleep() public method

public __sleep ( )

applyCustomCropping() protected method

protected applyCustomCropping ( $thumbConfig ) : mixed
$thumbConfig
return mixed

frontend() public method

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

getAlt() public method

*
public getAlt ( )

getCacheTags() public method

public getCacheTags ( $ownerDocument, $tags = [] )
$ownerDocument

getCropHeight() public method

public getCropHeight ( ) : float
return float

getCropLeft() public method

public getCropLeft ( ) : float
return float

getCropPercent() public method

public getCropPercent ( ) : boolean
return boolean

getCropTop() public method

public getCropTop ( ) : float
return float

getCropWidth() public method

public getCropWidth ( ) : float
return float

getData() public method

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

getDataEditmode() public method

Converts the data so it's suitable for the editmode
public getDataEditmode ( ) : array
return array

getDataForResource() public method

public getDataForResource ( )

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

getHotspots() public method

public getHotspots ( ) : array
return array

getId() public method

public getId ( ) : integer
return integer

getImage() public method

public getImage ( ) : Image
return Pimcore\Model\Asset\Image

getMarker() public method

public getMarker ( ) : array
return array

getSrc() public method

*
public getSrc ( )

getText() public method

*
public getText ( )

getThumbnail() public method

public getThumbnail ( $conf, boolean $deferred = true ) : Thumbnail | string
$conf
$deferred boolean
return Pimcore\Model\Asset\Image\Thumbnail | string

getType() public method

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

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

setCropHeight() public method

public setCropHeight ( $cropHeight )
$cropHeight

setCropLeft() public method

public setCropLeft ( $cropLeft )
$cropLeft

setCropPercent() public method

public setCropPercent ( $cropPercent )
$cropPercent

setCropTop() public method

public setCropTop ( $cropTop )
$cropTop

setCropWidth() public method

public setCropWidth ( $cropWidth )
$cropWidth

setDataFromEditmode() public method

public setDataFromEditmode ( mixed $data )
$data mixed

setDataFromResource() public method

public setDataFromResource ( mixed $data )
$data mixed

setHotspots() public method

public setHotspots ( array $hotspots )
$hotspots array

setId() public method

public setId ( integer $id ) : Image
$id integer
return Image

setImage() public method

public setImage ( Image $image ) : Image
$image Pimcore\Model\Asset\Image
return Image

setMarker() public method

public setMarker ( array $marker )
$marker array

Property Details

$alt public_oe property

The ALT text of the image
public string $alt
return string

$cropHeight public_oe property

public float $cropHeight
return float

$cropLeft public_oe property

public float $cropLeft
return float

$cropPercent public_oe property

public bool $cropPercent
return boolean

$cropTop public_oe property

public float $cropTop
return float

$cropWidth public_oe property

public float $cropWidth
return float

$hotspots public_oe property

public array $hotspots
return array

$id public_oe property

ID of the referenced image
public int $id
return integer

$image public_oe property

Contains the imageobject itself
public Image,Pimcore\Model\Asset $image
return Pimcore\Model\Asset\Image

$marker public_oe property

public array $marker
return array