PHP Class Pimcore\Model\Asset\Image\Thumbnail\Config

Inheritance: extends Pimcore\Model\AbstractModel
Show file Open project: pimcore/pimcore Class Usage Examples

Public Properties

Property Type Description
$creationDate integer
$description string
$filenameSuffix string
$format string
$highResolution float
$items array format of array: array( array( "method" => "myName", "arguments" => array( "width" => 345, "height" => 200 ) ) )
$medias array
$modificationDate integer
$name string
$preserveColor boolean
$preserveMetaData boolean
$quality mixed

Public Methods

Method Description
addItem ( $name, $parameters, $media = null ) : boolean
addItemAt ( $position, $name, $parameters, $media = null ) : boolean
getByArrayConfig ( $config ) : self
getByAutoDetect ( $config ) : self | boolean
getByLegacyConfig ( $config ) : self This is just for compatibility, this method will be removed with the next major release
getByName ( $name ) : null | Config
getColorspace ( ) : string
getCreationDate ( ) : integer
getDescription ( ) : string
getEstimatedDimensions ( $asset )
getFilenameSuffix ( ) : string
getForWebserviceExport ( ) Returns thumbnail config for webservice export.
getFormat ( ) : string
getHighResolution ( ) : float
getItems ( ) : array
getMedias ( ) : array
getModificationDate ( ) : integer
getName ( ) : string
getPreviewConfig ( )
getQuality ( ) : mixed
hasMedias ( ) : boolean
isPreserveColor ( ) : boolean
isPreserveMetaData ( ) : boolean
resetItems ( ) : void
selectMedia ( $name ) : boolean
setColorspace ( string $colorspace )
setCreationDate ( integer $creationDate )
setDescription ( string $description )
setFilenameSuffix ( string $filenameSuffix )
setFormat ( string $format )
setHighResolution ( float $highResolution )
setItems ( array $items )
setMedias ( array $medias )
setModificationDate ( integer $modificationDate )
setName ( string $name )
setPreserveColor ( boolean $preserveColor )
setPreserveMetaData ( boolean $preserveMetaData )
setQuality ( mixed $quality )

Protected Methods

Method Description
createMediaIfNotExists ( string $name )

Method Details

addItem() public method

public addItem ( $name, $parameters, $media = null ) : boolean
$name
$parameters
return boolean

addItemAt() public method

public addItemAt ( $position, $name, $parameters, $media = null ) : boolean
$name
$parameters
return boolean

createMediaIfNotExists() protected method

protected createMediaIfNotExists ( string $name )
$name string

getByArrayConfig() public static method

public static getByArrayConfig ( $config ) : self
$config
return self

getByAutoDetect() public static method

public static getByAutoDetect ( $config ) : self | boolean
$config
return self | boolean

getByLegacyConfig() public static method

This is just for compatibility, this method will be removed with the next major release
public static getByLegacyConfig ( $config ) : self
$config
return self

getByName() public static method

public static getByName ( $name ) : null | Config
$name
return null | Config

getColorspace() public method

public getColorspace ( ) : string
return string

getCreationDate() public method

public getCreationDate ( ) : integer
return integer

getDescription() public method

public getDescription ( ) : string
return string

getEstimatedDimensions() public method

public getEstimatedDimensions ( $asset )

getFilenameSuffix() public method

public getFilenameSuffix ( ) : string
return string

getForWebserviceExport() public method

Returns thumbnail config for webservice export.
public getForWebserviceExport ( )

getFormat() public method

public getFormat ( ) : string
return string

getHighResolution() public method

public getHighResolution ( ) : float
return float

getItems() public method

public getItems ( ) : array
return array

getMedias() public method

public getMedias ( ) : array
return array

getModificationDate() public method

public getModificationDate ( ) : integer
return integer

getName() public method

public getName ( ) : string
return string

getPreviewConfig() public static method

public static getPreviewConfig ( )

getQuality() public method

public getQuality ( ) : mixed
return mixed

hasMedias() public method

public hasMedias ( ) : boolean
return boolean

isPreserveColor() public method

public isPreserveColor ( ) : boolean
return boolean

isPreserveMetaData() public method

public isPreserveMetaData ( ) : boolean
return boolean

resetItems() public method

public resetItems ( ) : void
return void

selectMedia() public method

public selectMedia ( $name ) : boolean
$name
return boolean

setColorspace() public method

public setColorspace ( string $colorspace )
$colorspace string

setCreationDate() public method

public setCreationDate ( integer $creationDate )
$creationDate integer

setDescription() public method

public setDescription ( string $description )
$description string

setFilenameSuffix() public method

public setFilenameSuffix ( string $filenameSuffix )
$filenameSuffix string

setFormat() public method

public setFormat ( string $format )
$format string

setHighResolution() public method

public setHighResolution ( float $highResolution )
$highResolution float

setItems() public method

public setItems ( array $items )
$items array

setMedias() public method

public setMedias ( array $medias )
$medias array

setModificationDate() public method

public setModificationDate ( integer $modificationDate )
$modificationDate integer

setName() public method

public setName ( string $name )
$name string

setPreserveColor() public method

public setPreserveColor ( boolean $preserveColor )
$preserveColor boolean

setPreserveMetaData() public method

public setPreserveMetaData ( boolean $preserveMetaData )
$preserveMetaData boolean

setQuality() public method

public setQuality ( mixed $quality )
$quality mixed

Property Details

$creationDate public property

public int $creationDate
return integer

$description public property

public string $description
return string

$filenameSuffix public property

public string $filenameSuffix
return string

$format public property

public string $format
return string

$highResolution public property

public float $highResolution
return float

$items public property

format of array: array( array( "method" => "myName", "arguments" => array( "width" => 345, "height" => 200 ) ) )
public array $items
return array

$medias public property

public array $medias
return array

$modificationDate public property

public int $modificationDate
return integer

$name public property

public string $name
return string

$preserveColor public property

public bool $preserveColor
return boolean

$preserveMetaData public property

public bool $preserveMetaData
return boolean

$quality public property

public mixed $quality
return mixed