PHP Class Neos\Media\ViewHelpers\ThumbnailViewHelper

= Examples = (depending on the asset, no scaling applied) a sample asset without scaling (depending on the asset; scaled down to a maximum width of 80 pixels, keeping the aspect ratio) sample (depending on the asset; scaled down to a maximum width and height of 80 pixels, keeping the aspect ratio) sample (depending on the asset; scaled down to a width and height of 80 pixels, possibly changing aspect ratio) sample (depending on the asset; scaled up or down to a width 5000 pixels, keeping aspect ratio) sample
Inheritance: extends Neos\FluidAdaptor\Core\ViewHelper\AbstractTagBasedViewHelper
Show file Open project: neos/neos-development-collection

Protected Properties

Property Type Description
$assetService Neos\Media\Domain\Service\AssetService
$resourceManager Neos\Flow\ResourceManagement\ResourceManager
$tagName string name of the tag to be created by this view helper
$thumbnailService Neos\Media\Domain\Service\ThumbnailService

Public Methods

Method Description
initializeArguments ( ) : void
render ( Neos\Media\Domain\Model\AssetInterface $asset = null, integer $width = null, integer $maximumWidth = null, integer $height = null, integer $maximumHeight = null, boolean $allowCropping = false, boolean $allowUpScaling = false, boolean $async = false, string $preset = null ) : string Renders an HTML img tag with a thumbnail image, created from a given asset.

Method Details

initializeArguments() public method

public initializeArguments ( ) : void
return void

render() public method

Renders an HTML img tag with a thumbnail image, created from a given asset.
public render ( Neos\Media\Domain\Model\AssetInterface $asset = null, integer $width = null, integer $maximumWidth = null, integer $height = null, integer $maximumHeight = null, boolean $allowCropping = false, boolean $allowUpScaling = false, boolean $async = false, string $preset = null ) : string
$asset Neos\Media\Domain\Model\AssetInterface The asset to be rendered as a thumbnail
$width integer Desired width of the thumbnail
$maximumWidth integer Desired maximum width of the thumbnail
$height integer Desired height of the thumbnail
$maximumHeight integer Desired maximum height of the thumbnail
$allowCropping boolean Whether the thumbnail should be cropped if the given sizes would hurt the aspect ratio
$allowUpScaling boolean Whether the resulting thumbnail size might exceed the size of the original asset
$async boolean Return asynchronous image URI in case the requested image does not exist already
$preset string Preset used to determine image configuration
return string an html tag

Property Details

$assetService protected property

protected AssetService,Neos\Media\Domain\Service $assetService
return Neos\Media\Domain\Service\AssetService

$resourceManager protected property

protected ResourceManager,Neos\Flow\ResourceManagement $resourceManager
return Neos\Flow\ResourceManagement\ResourceManager

$tagName protected property

name of the tag to be created by this view helper
protected string $tagName
return string

$thumbnailService protected property

protected ThumbnailService,Neos\Media\Domain\Service $thumbnailService
return Neos\Media\Domain\Service\ThumbnailService