vendor/ibexa/core/src/lib/MVC/Symfony/View/ContentView.php line 39

Open in your IDE?
  1. <?php
  3. /**
  4.  * @copyright Copyright (C) Ibexa AS. All rights reserved.
  5.  * @license For full copyright and license information view LICENSE file distributed with this source code.
  6.  */
  7. namespace Ibexa\Core\MVC\Symfony\View;
  9. use Ibexa\Contracts\Core\Repository\Values\Content\Content;
  10. use Ibexa\Contracts\Core\Repository\Values\Content\Location;
  12. /**
  13.  * Main object to be rendered by the View Manager when viewing a content.
  14.  * Holds the path to the template to be rendered by the view manager and the parameters to inject in it.
  15.  *
  16.  * The template path can be a closure. In that case, the view manager will invoke it instead of loading a template.
  17.  * $parameters will be passed to the callable in addition to the Content or Location object (depending on the context).
  18.  * The prototype of the closure must be :
  19.  * <code>
  20.  * namespace Foo;
  21.  * use Ibexa\Contracts\Core\Repository\Values\Content\ContentInfo;
  22.  * use Ibexa\Contracts\Core\Repository\Values\Content\Location;
  23.  *
  24.  * // For a content
  25.  * function ( ContentInfo $contentInfo, array $parameters = array() )
  26.  * {
  27.  *     // Do something to render
  28.  *     // Must return a string to display
  29.  * }
  30.  *
  31.  * // For a location
  32.  * function ( Location $location, array $parameters = array() )
  33.  * {
  34.  *     // Do something to render
  35.  *     // Must return a string to display
  36.  * }
  37.  * </code>
  38.  */
  39. class ContentView extends BaseView implements View, ContentValueView, LocationValueView, EmbedView, CachableView
  40. {
  41.     /** @var \Ibexa\Contracts\Core\Repository\Values\Content\Content */
  42.     private $content;
  44.     /** @var \Ibexa\Contracts\Core\Repository\Values\Content\Location|null */
  45.     private $location;
  47.     /** @var bool */
  48.     private $isEmbed = false;
  50.     /**
  51.      * @param \Ibexa\Contracts\Core\Repository\Values\Content\Content $content
  52.      */
  53.     public function setContent(Content $content)
  54.     {
  55.         $this->content = $content;
  56.     }
  58.     /**
  59.      * Returns the Content.
  60.      *
  61.      * @return \Ibexa\Contracts\Core\Repository\Values\Content\Content
  62.      */
  63.     public function getContent()
  64.     {
  65.         return $this->content;
  66.     }
  68.     /**
  69.      * @param \Ibexa\Contracts\Core\Repository\Values\Content\Location $location
  70.      */
  71.     public function setLocation(Location $location)
  72.     {
  73.         $this->location = $location;
  74.     }
  76.     /**
  77.      * @return \Ibexa\Contracts\Core\Repository\Values\Content\Location|null
  78.      */
  79.     public function getLocation()
  80.     {
  81.         return $this->location;
  82.     }
  84.     protected function getInternalParameters()
  85.     {
  86.         $parameters = ['content' => $this->content];
  87.         if ($this->location !== null) {
  88.             $parameters['location'] = $this->location;
  89.         }
  91.         return $parameters;
  92.     }
  94.     /**
  95.      * Sets the value as embed / not embed.
  96.      *
  97.      * @param bool $value
  98.      */
  99.     public function setIsEmbed($value)
  100.     {
  101.         $this->isEmbed = (bool)$value;
  102.     }
  104.     /**
  105.      * Is the view an embed or not.
  106.      *
  107.      * @return bool True if the view is an embed, false if it is not.
  108.      */
  109.     public function isEmbed()
  110.     {
  111.         return $this->isEmbed;
  112.     }
  113. }
  115. class_alias(ContentView::class, 'eZ\Publish\Core\MVC\Symfony\View\ContentView');