PHP Class eZ\Publish\Core\MVC\Symfony\View\Manager

Inheritance: implements eZ\Publish\Core\MVC\Symfony\View\ViewManagerInterface

Datei anzeigen Open project: ezsystems/ezpublish-kernel Class Usage Examples

Protected Properties

Property	Type	Description
$blockViewProviders		Array indexed by priority. Each priority key is an array of Block View Provider objects having this priority. The highest priority number is the highest priority
$configResolver	eZ\Publish\Core\MVC\ConfigResolverInterface
$contentViewProviders		Array indexed by priority. Each priority key is an array of Content View Provider objects having this priority. The highest priority number is the highest priority
$eventDispatcher	Symfony\Component\EventDispatcher\EventDispatcherInterface
$locationViewProviders		Array indexed by priority. Each priority key is an array of Location View Provider objects having this priority. The highest priority number is the highest priority
$logger	Psr\Log\LoggerInterface
$repository	eZ\Publish\API\Repository\Repository
$sortedBlockViewProviders	eZ\Publish\Core\MVC\Symfony\View\Provider\Block[]
$sortedContentViewProviders	eZ\Publish\Core\MVC\Symfony\View\Provider\Content[]
$sortedLocationViewProviders	eZ\Publish\Core\MVC\Symfony\View\Provider\Location[]
$templateEngine	Symfony\Component\Templating\EngineInterface
$viewBaseLayout	string	The base layout template to use when the view is requested to be generated outside of the pagelayout.

Public Methods

Method	Description
__construct ( Symfony\Component\Templating\EngineInterface $templateEngine, Symfony\Component\EventDispatcher\EventDispatcherInterface $eventDispatcher, eZ\Publish\API\Repository\Repository $repository, eZ\Publish\Core\MVC\ConfigResolverInterface $configResolver, $viewBaseLayout, $viewConfigurator, Psr\Log\LoggerInterface $logger = null )
addBlockViewProvider ( eZ\Publish\Core\MVC\Symfony\View\ViewProvider $viewProvider, integer $priority )	Registers $viewProvider as a valid location view provider.
addContentViewProvider ( eZ\Publish\Core\MVC\Symfony\View\ViewProvider $viewProvider, integer $priority )	Registers $viewProvider as a valid content view provider.
addLocationViewProvider ( eZ\Publish\Core\MVC\Symfony\View\ViewProvider $viewProvider, integer $priority )	Registers $viewProvider as a valid location view provider.
getAllBlockViewProviders ( ) : eZ\Publish\Core\MVC\Symfony\View\ViewProvider[]
getAllContentViewProviders ( ) : eZ\Publish\Core\MVC\Symfony\View\ViewProvider[]
getAllLocationViewProviders ( ) : eZ\Publish\Core\MVC\Symfony\View\ViewProvider[]
renderBlock ( Block $block, array $parameters = [] ) : string	Renders $block by selecting the right template.
renderContent ( eZ\Publish\API\Repository\Values\Content\Content $content, string $viewType = ViewManagerInterface::VIEW_TYPE_FULL, array $parameters = [] ) : string	Renders $content by selecting the right template.
renderContentView ( eZ\Publish\Core\MVC\Symfony\View\View $view, array $defaultParams = [] ) : string	Renders passed ContentView object via the template engine.
renderLocation ( eZ\Publish\API\Repository\Values\Content\Location $location, string $viewType = ViewManagerInterface::VIEW_TYPE_FULL, array $parameters = [] ) : string	Renders $location by selecting the right template for $viewType.

Protected Methods

Method	Description
sortViewProviders ( array $property ) : eZ\Publish\Core\MVC\Symfony\View\Provider\Content[] \| eZ\Publish\Core\MVC\Symfony\View\Provider\Location[] \| eZ\Publish\Core\MVC\Symfony\View\Provider\Block[]	Sort the registered view providers by priority.

Private Methods

Method	Description
addViewProvider ( array &$property, eZ\Publish\Core\MVC\Symfony\View\ViewProvider $viewProvider, integer $priority )	Helper for {@see addContentViewProvider()} and {@see addLocationViewProvider()}.

Method Details

__construct() public method

public __construct ( Symfony\Component\Templating\EngineInterface $templateEngine, Symfony\Component\EventDispatcher\EventDispatcherInterface $eventDispatcher, eZ\Publish\API\Repository\Repository $repository, eZ\Publish\Core\MVC\ConfigResolverInterface $configResolver, $viewBaseLayout, $viewConfigurator, Psr\Log\LoggerInterface $logger = null )
$templateEngine	Symfony\Component\Templating\EngineInterface
$eventDispatcher	Symfony\Component\EventDispatcher\EventDispatcherInterface
$repository	eZ\Publish\API\Repository\Repository
$configResolver	eZ\Publish\Core\MVC\ConfigResolverInterface
$logger	Psr\Log\LoggerInterface

addBlockViewProvider() public method

When this view provider will be called in the chain depends on $priority. The highest $priority is, the earliest the router will be called.

public addBlockViewProvider ( eZ\Publish\Core\MVC\Symfony\View\ViewProvider $viewProvider, integer $priority )
$viewProvider	eZ\Publish\Core\MVC\Symfony\View\ViewProvider
$priority	integer

addContentViewProvider() public method

When this view provider will be called in the chain depends on $priority. The highest $priority is, the earliest the router will be called.

public addContentViewProvider ( eZ\Publish\Core\MVC\Symfony\View\ViewProvider $viewProvider, integer $priority )
$viewProvider	eZ\Publish\Core\MVC\Symfony\View\ViewProvider
$priority	integer

addLocationViewProvider() public method

When this view provider will be called in the chain depends on $priority. The highest $priority is, the earliest the router will be called.

public addLocationViewProvider ( eZ\Publish\Core\MVC\Symfony\View\ViewProvider $viewProvider, integer $priority )
$viewProvider	eZ\Publish\Core\MVC\Symfony\View\ViewProvider
$priority	integer

getAllBlockViewProviders() public method

public getAllBlockViewProviders ( ) : eZ\Publish\Core\MVC\Symfony\View\ViewProvider[]
return	eZ\Publish\Core\MVC\Symfony\View\ViewProvider[]

getAllContentViewProviders() public method

public getAllContentViewProviders ( ) : eZ\Publish\Core\MVC\Symfony\View\ViewProvider[]
return	eZ\Publish\Core\MVC\Symfony\View\ViewProvider[]

getAllLocationViewProviders() public method

public getAllLocationViewProviders ( ) : eZ\Publish\Core\MVC\Symfony\View\ViewProvider[]
return	eZ\Publish\Core\MVC\Symfony\View\ViewProvider[]

renderBlock() public method

$block will be injected in the selected template.

public renderBlock ( Block $block, array $parameters = [] ) : string
$block	eZ\Publish\Core\FieldType\Page\Parts\Block
$parameters	array	Parameters to pass to the template called to render the view. By default, it's empty. 'block' entry is reserved for the Block that is viewed.
return	string

renderContent() public method

$content will be injected in the selected template.

public renderContent ( eZ\Publish\API\Repository\Values\Content\Content $content, string $viewType = ViewManagerInterface::VIEW_TYPE_FULL, array $parameters = [] ) : string
$content	eZ\Publish\API\Repository\Values\Content\Content
$viewType	string	Variation of display for your content. Default is 'full'.
$parameters	array	Parameters to pass to the template called to render the view. By default, it's empty. 'content' entry is reserved for the Content that is rendered.
return	string

renderContentView() public method

If $view's template identifier is a closure, then it is called directly and the result is returned as is.

public renderContentView ( eZ\Publish\Core\MVC\Symfony\View\View $view, array $defaultParams = [] ) : string
$view	eZ\Publish\Core\MVC\Symfony\View\View
$defaultParams	array
return	string

renderLocation() public method

$content and $location will be injected in the selected template.

public renderLocation ( eZ\Publish\API\Repository\Values\Content\Location $location, string $viewType = ViewManagerInterface::VIEW_TYPE_FULL, array $parameters = [] ) : string
$location	eZ\Publish\API\Repository\Values\Content\Location
$viewType	string	Variation of display for your content. Default is 'full'.
$parameters	array	Parameters to pass to the template called to render the view. By default, it's empty. 'location' and 'content' entries are reserved for the Location (and its Content) that is viewed.
return	string

sortViewProviders() protected method

The highest priority number is the highest priority (reverse sorting).

protected sortViewProviders ( array $property ) : eZ\Publish\Core\MVC\Symfony\View\Provider\Content[] \| eZ\Publish\Core\MVC\Symfony\View\Provider\Location[] \| eZ\Publish\Core\MVC\Symfony\View\Provider\Block[]
$property	array	view providers to sort
return	eZ\Publish\Core\MVC\Symfony\View\Provider\Content[] \| eZ\Publish\Core\MVC\Symfony\View\Provider\Location[] \| eZ\Publish\Core\MVC\Symfony\View\Provider\Block[]

Property Details

$blockViewProviders protected_oe property

Array indexed by priority. Each priority key is an array of Block View Provider objects having this priority. The highest priority number is the highest priority

protected $blockViewProviders

$configResolver protected_oe property

protected ConfigResolverInterface,eZ\Publish\Core\MVC $configResolver
return	eZ\Publish\Core\MVC\ConfigResolverInterface

$contentViewProviders protected_oe property

Array indexed by priority. Each priority key is an array of Content View Provider objects having this priority. The highest priority number is the highest priority

protected $contentViewProviders

$eventDispatcher protected_oe property

protected EventDispatcherInterface,Symfony\Component\EventDispatcher $eventDispatcher
return	Symfony\Component\EventDispatcher\EventDispatcherInterface

$locationViewProviders protected_oe property

Array indexed by priority. Each priority key is an array of Location View Provider objects having this priority. The highest priority number is the highest priority

protected $locationViewProviders

$logger protected_oe property

protected LoggerInterface,Psr\Log $logger
return	Psr\Log\LoggerInterface

$repository protected_oe property

protected Repository,eZ\Publish\API\Repository $repository
return	eZ\Publish\API\Repository\Repository

$sortedBlockViewProviders protected_oe property

protected Block[],eZ\Publish\Core\MVC\Symfony\View\Provider $sortedBlockViewProviders
return	eZ\Publish\Core\MVC\Symfony\View\Provider\Block[]

$sortedContentViewProviders protected_oe property

protected Content[],eZ\Publish\Core\MVC\Symfony\View\Provider $sortedContentViewProviders
return	eZ\Publish\Core\MVC\Symfony\View\Provider\Content[]

$sortedLocationViewProviders protected_oe property

protected Location[],eZ\Publish\Core\MVC\Symfony\View\Provider $sortedLocationViewProviders
return	eZ\Publish\Core\MVC\Symfony\View\Provider\Location[]

$templateEngine protected_oe property

protected EngineInterface,Symfony\Component\Templating $templateEngine
return	Symfony\Component\Templating\EngineInterface

$viewBaseLayout protected_oe property

The base layout template to use when the view is requested to be generated outside of the pagelayout.

protected string $viewBaseLayout
return	string