PHP Class Neos\Neos\Controller\Service\ContentDimensionsController

Inheritance: extends Neos\Flow\Mvc\Controller\ActionController, use trait Neos\Neos\Controller\BackendUserTranslationTrait

Show file Open project: neos/neos-development-collection

Protected Properties

Property	Type	Description
$contentDimensionPresetSource	Neos\Neos\Domain\Service\ContentDimensionPresetSourceInterface
$supportedMediaTypes	array
$viewFormatToObjectNameMap	array

Public Methods

Method	Description
indexAction ( ) : void	Returns the full content dimensions presets as JSON object; see ContentDimensionPresetSourceInterface::getAllPresets() for a format description.
showAction ( string $dimensionName, array $chosenDimensionPresets = [] ) : void	Returns only presets of the dimension specified by $dimensionName. But even though only one dimension is returned, the output follows the structure as described in ContentDimensionPresetSourceInterface::getAllPresets().

Method Details

indexAction() public method

Returns the full content dimensions presets as JSON object; see ContentDimensionPresetSourceInterface::getAllPresets() for a format description.

public indexAction ( ) : void
return	void

showAction() public method

It is possible to pass a selection of presets as a filter. In that case, $chosenDimensionPresets must be an array of one or more dimension names (key) and preset names (value). The returned list will then only contain dimension presets which are allowed in combination with the given presets. Example: Given that $chosenDimensionPresets = array('country' => 'US') and that a second dimension "language" exists and $dimensionName is "language. This method will now display a list of dimension presets for the dimension "language" which are allowed in combination with the country "US".

public showAction ( string $dimensionName, array $chosenDimensionPresets = [] ) : void
$dimensionName	string	Name of the dimension to return presets for
$chosenDimensionPresets	array	An optional array of dimension names and a single preset per dimension
return	void

Property Details

$contentDimensionPresetSource protected property

protected ContentDimensionPresetSourceInterface,Neos\Neos\Domain\Service $contentDimensionPresetSource
return	Neos\Neos\Domain\Service\ContentDimensionPresetSourceInterface

$supportedMediaTypes protected property

protected array $supportedMediaTypes
return	array

$viewFormatToObjectNameMap protected property

protected array $viewFormatToObjectNameMap
return	array