PHP Class Neos\Media\Domain\Model\Thumbnail

Inheritance: implements Neos\Media\Domain\Model\ImageInterface, use trait DimensionsTrait
Show file Open project: neos/neos-development-collection Class Usage Examples

Protected Properties

Property Type Description
$async boolean
$configuration array
$configurationHash string
$generatorStrategy Neos\Media\Domain\Strategy\ThumbnailGeneratorStrategy
$originalAsset Asset
$resource Neos\Flow\ResourceManagement\PersistentResource
$staticResource Supports the 'resource://Package.Key/Public/File' format

Public Methods

Method Description
__construct ( Neos\Media\Domain\Model\AssetInterface $originalAsset, ThumbnailConfiguration $configuration ) Constructs a new Thumbnail
getConfigurationValue ( string $value ) : mixed
getOriginalAsset ( ) : Neos\Media\Domain\Model\ImageInterface Returns the Asset this thumbnail is derived from
getResource ( ) : PersistentResource PersistentResource of this thumbnail
getStaticResource ( ) : string
initializeObject ( integer $initializationCause ) : void Initializes this thumbnail
refresh ( ) : void Refreshes this asset after the PersistentResource has been modified
setHeight ( integer $height ) : void
setResource ( PersistentResource $resource ) : void
setStaticResource ( string $staticResource ) : void
setWidth ( integer $width ) : void

Protected Methods

Method Description
emitThumbnailCreated ( Thumbnail $thumbnail ) : void Signals that a thumbnail was created.
setConfiguration ( ThumbnailConfiguration $configuration ) : void

Method Details

__construct() public method

Constructs a new Thumbnail
public __construct ( Neos\Media\Domain\Model\AssetInterface $originalAsset, ThumbnailConfiguration $configuration )
$originalAsset Neos\Media\Domain\Model\AssetInterface The original asset this variant is derived from
$configuration ThumbnailConfiguration

emitThumbnailCreated() protected method

Signals that a thumbnail was created.
Deprecation: Will be removed with next major version of Neos.Media. Use ThumbnailService::emitThumbnailCreated signal instead.
protected emitThumbnailCreated ( Thumbnail $thumbnail ) : void
$thumbnail Thumbnail
return void

getConfigurationValue() public method

public getConfigurationValue ( string $value ) : mixed
$value string
return mixed

getOriginalAsset() public method

Returns the Asset this thumbnail is derived from
public getOriginalAsset ( ) : Neos\Media\Domain\Model\ImageInterface
return Neos\Media\Domain\Model\ImageInterface

getResource() public method

PersistentResource of this thumbnail
public getResource ( ) : PersistentResource
return Neos\Flow\ResourceManagement\PersistentResource

getStaticResource() public method

public getStaticResource ( ) : string
return string

initializeObject() public method

Initializes this thumbnail
public initializeObject ( integer $initializationCause ) : void
$initializationCause integer
return void

refresh() public method

Refreshes this asset after the PersistentResource has been modified
public refresh ( ) : void
return void

setConfiguration() protected method

protected setConfiguration ( ThumbnailConfiguration $configuration ) : void
$configuration ThumbnailConfiguration
return void

setHeight() public method

public setHeight ( integer $height ) : void
$height integer
return void

setResource() public method

public setResource ( PersistentResource $resource ) : void
$resource Neos\Flow\ResourceManagement\PersistentResource
return void

setStaticResource() public method

public setStaticResource ( string $staticResource ) : void
$staticResource string
return void

setWidth() public method

public setWidth ( integer $width ) : void
$width integer
return void

Property Details

$async protected property

protected bool $async
return boolean

$configuration protected property

protected array $configuration
return array

$configurationHash protected property

protected string $configurationHash
return string

$generatorStrategy protected property

protected ThumbnailGeneratorStrategy,Neos\Media\Domain\Strategy $generatorStrategy
return Neos\Media\Domain\Strategy\ThumbnailGeneratorStrategy

$originalAsset protected property

protected Asset,Neos\Media\Domain\Model $originalAsset
return Asset

$resource protected property

protected PersistentResource,Neos\Flow\ResourceManagement $resource
return Neos\Flow\ResourceManagement\PersistentResource

$staticResource protected property

Supports the 'resource://Package.Key/Public/File' format
protected $staticResource