Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\views\Entity\Render;
Chris@0: 
Chris@0: use Drupal\Core\Cache\Cache;
Chris@0: use Drupal\Core\Cache\CacheableDependencyInterface;
Chris@0: use Drupal\Core\Entity\EntityTypeInterface;
Chris@0: use Drupal\Core\Language\LanguageManagerInterface;
Chris@0: use Drupal\views\Plugin\views\query\QueryPluginBase;
Chris@0: use Drupal\views\ResultRow;
Chris@0: use Drupal\views\ViewExecutable;
Chris@0: 
Chris@0: /**
Chris@0:  * Defines a base class for entity renderers.
Chris@0:  */
Chris@0: abstract class RendererBase implements CacheableDependencyInterface {
Chris@0: 
Chris@0:   /**
Chris@0:    * The view executable wrapping the view storage entity.
Chris@0:    *
Chris@0:    * @var \Drupal\views\ViewExecutable
Chris@0:    */
Chris@0:   public $view;
Chris@0: 
Chris@0:   /**
Chris@0:    * The language manager.
Chris@0:    *
Chris@0:    * @var \Drupal\Core\Language\LanguageManagerInterface
Chris@0:    */
Chris@0:   protected $languageManager;
Chris@0: 
Chris@0:   /**
Chris@0:    * The type of the entity being rendered.
Chris@0:    *
Chris@0:    * @var \Drupal\Core\Entity\EntityTypeInterface
Chris@0:    */
Chris@0:   protected $entityType;
Chris@0: 
Chris@0:   /**
Chris@0:    * Contains an array of render arrays, one for each rendered entity.
Chris@0:    *
Chris@0:    * @var array
Chris@0:    */
Chris@0:   protected $build;
Chris@0: 
Chris@0:   /**
Chris@0:    * Constructs a renderer object.
Chris@0:    *
Chris@0:    * @param \Drupal\views\ViewExecutable $view
Chris@0:    *   The entity row being rendered.
Chris@0:    * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
Chris@0:    *   The language manager.
Chris@0:    * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
Chris@0:    *   The entity type.
Chris@0:    */
Chris@0:   public function __construct(ViewExecutable $view, LanguageManagerInterface $language_manager, EntityTypeInterface $entity_type) {
Chris@0:     $this->view = $view;
Chris@0:     $this->languageManager = $language_manager;
Chris@0:     $this->entityType = $entity_type;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getCacheMaxAge() {
Chris@0:     return Cache::PERMANENT;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getCacheContexts() {
Chris@0:     return [];
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getCacheTags() {
Chris@0:     return [];
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Alters the query if needed.
Chris@0:    *
Chris@0:    * @param \Drupal\views\Plugin\views\query\QueryPluginBase $query
Chris@0:    *   The query to alter.
Chris@0:    * @param string $relationship
Chris@0:    *   (optional) The relationship, used by a field.
Chris@0:    */
Chris@0:   abstract public function query(QueryPluginBase $query, $relationship = NULL);
Chris@0: 
Chris@0:   /**
Chris@0:    * Runs before each entity is rendered.
Chris@0:    *
Chris@0:    * @param $result
Chris@0:    *   The full array of results from the query.
Chris@0:    */
Chris@0:   public function preRender(array $result) {
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Renders entity data.
Chris@0:    *
Chris@0:    * @param \Drupal\views\ResultRow $row
Chris@0:    *   A single row of the query result.
Chris@0:    *
Chris@0:    * @return array
Chris@0:    *   A renderable array for the entity data contained in the result row.
Chris@0:    */
Chris@0:   abstract public function render(ResultRow $row);
Chris@0: 
Chris@0: }