You are here

Home » API reference » Doubleclick for Publishers (DFP) 8 » TagViewBuilder.php

class TagViewBuilder in Doubleclick for Publishers (DFP) 8

Provides a DFP Tag view builder.

Hierarchy

Expanded class hierarchy of TagViewBuilder

File

src/View/TagViewBuilder.php, line 27
Contains \Drupal\dfp\View\TagViewBuilder.

Namespace

Drupal\dfp\View
View source 
class TagViewBuilder extends EntityViewBuilder {

  /**
   * The module handler.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * The config factory.
   *
   * @var \Drupal\Core\Config\ConfigFactoryInterface
   */
  protected $configFactory;

  /**
   * DFP token service.
   *
   * @var \Drupal\dfp\TokenInterface
   */
  protected $token;

  /**
   * Constructs a new BlockViewBuilder.
   *
   * @param \Drupal\Core\Entity\EntityTypeInterface $entityType
   *   The entity type definition.
   * @param EntityRepositoryInterface $entityRepository
   *   The entity manager service.
   * @param \Drupal\Core\Language\LanguageManagerInterface $languageManager
   *   The language manager.
   * @param \Drupal\Core\Theme\Registry $registry
   *   The theme registry service.
   * @param \Drupal\Core\Entity\EntityDisplayRepositoryInterface $entityDisplayRepository
   *   The entity display repository service.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $moduleHandler
   *   The module handler.
   * @param \Drupal\Core\Config\ConfigFactoryInterface $configFactory
   *   The config factory.
   * @param \Drupal\dfp\TokenInterface $token
   *   DFP token service.
   */
  public function __construct(EntityTypeInterface $entityType, EntityRepositoryInterface $entityRepository, LanguageManagerInterface $languageManager, Registry $registry, EntityDisplayRepositoryInterface $entityDisplayRepository, ModuleHandlerInterface $moduleHandler, ConfigFactoryInterface $configFactory, TokenInterface $token) {
    parent::__construct($entityType, $entityRepository, $languageManager, $registry, $entityDisplayRepository);
    $this->moduleHandler = $moduleHandler;
    $this->configFactory = $configFactory;
    $this->token = $token;
  }

  /**
   * {@inheritdoc}
   */
  public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) {
    return new static($entity_type, $container
      ->get('entity.repository'), $container
      ->get('language_manager'), $container
      ->get('theme.registry'), $container
      ->get('entity_display.repository'), $container
      ->get('module_handler'), $container
      ->get('config.factory'), $container
      ->get('dfp.token'));
  }

  /**
   * {@inheritdoc}
   */
  public function buildComponents(array &$build, array $entities, array $displays, $view_mode) {
  }

  /**
   * {@inheritdoc}
   */
  public function view(EntityInterface $entity, $view_mode = 'full', $langcode = NULL) {
    $build = $this
      ->viewMultiple([
      $entity,
    ], $view_mode, $langcode);
    return reset($build);
  }

  /**
   * {@inheritdoc}
   */
  public function viewMultiple(array $entities = [], $view_mode = 'full', $langcode = NULL) {

    /** @var \Drupal\dfp\Entity\TagInterface[] $entities */
    $build = [];
    foreach ($entities as $tag) {

      // @todo Ensure a tag is only once on the page.
      // @todo Get cache-ability based on tokens used in TagView...
      $global_settings = $this->configFactory
        ->get('dfp.settings');
      $tag_view = new TagView($tag, $global_settings, $this->token, $this
        ->moduleHandler());
      $tag_id = $tag
        ->id();
      $build[$tag_id] = [
        '#cache' => [
          'keys' => [
            'entity_view',
            'dfp_tag',
            $tag_id,
          ],
        ],
      ];

      // Sort out the cache tags and contexts.
      $cacheable_metadata = CacheableMetadata::createFromObject($global_settings);
      $cacheable_metadata
        ->merge(CacheableMetadata::createFromObject($tag));
      $cacheable_metadata
        ->addCacheTags($this
        ->getCacheTags());
      $cacheable_metadata
        ->applyTo($build[$tag_id]);
      $build[$tag_id] += static::buildPreTag($tag_view);
    }
    return $build;
  }

  /**
   * Builds a #pre_render-able DFP tag render array.
   *
   * @param \Drupal\dfp\View\TagView $tag_view
   *   A DFP tag.
   *
   * @return array
   *   A render array with a #pre_render callback to render the DFP tag.
   *
   * @see \Drupal\dfp\DfpResponseAttachmentsProcessor::processAttachments()
   */
  protected static function buildPreTag(TagView $tag_view) {
    $build = [
      '#contextual_links' => [
        'dfp_tag' => [
          'route_parameters' => [
            'dfp_tag' => $tag_view
              ->id(),
          ],
        ],
      ],
    ];
    if ($tag_view
      ->isShortTag()) {
      $build['tag'] = [
        '#theme' => 'dfp_short_tag',
        '#url_jump' => '//' . TagInterface::GOOGLE_SHORT_TAG_SERVICES_URL . '/jump?' . $tag_view
          ->getShortTagQueryString(),
        '#url_ad' => '//' . TagInterface::GOOGLE_SHORT_TAG_SERVICES_URL . '/ad?' . $tag_view
          ->getShortTagQueryString(),
      ];
    }
    else {
      $build['tag'] = [
        '#theme' => 'dfp_tag',
      ];

      // Attach a tag. These attachments are processed by
      // \Drupal\dfp\DfpResponseAttachmentsProcessor::processAttachments().
      $build['#attached']['dfp_slot'][] = $tag_view;
    }
    $build['tag']['#tag'] = $tag_view;
    return $build;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
DeprecatedServicePropertyTrait::__get public function Allows to access deprecated/removed properties.
EntityHandlerBase::moduleHandler protected function Gets the module handler. 2
EntityHandlerBase::setModuleHandler public function Sets the module handler for this handler.
EntityViewBuilder::$cacheBin protected property The cache bin used to store the render cache.
EntityViewBuilder::$deprecatedProperties protected property
EntityViewBuilder::$entityDisplayRepository protected property The entity display repository.
EntityViewBuilder::$entityRepository protected property The entity repository service.
EntityViewBuilder::$entityType protected property Information about the entity type.
EntityViewBuilder::$entityTypeId protected property The type of entities for which this view builder is instantiated.
EntityViewBuilder::$languageManager protected property The language manager.
EntityViewBuilder::$singleFieldDisplays protected property The EntityViewDisplay objects created for individual field rendering.
EntityViewBuilder::$themeRegistry protected property The theme registry.
EntityViewBuilder::addContextualLinks protected function Add contextual links.
EntityViewBuilder::alterBuild protected function Specific per-entity building. 1
EntityViewBuilder::build public function Builds an entity's view; augments entity defaults.
EntityViewBuilder::buildMultiple public function Builds multiple entities' views; augments entity defaults.
EntityViewBuilder::getBuildDefaults protected function Provides entity-specific defaults to the build process. 4
EntityViewBuilder::getCacheTags public function The cache tag associated with this entity view builder. Overrides EntityViewBuilderInterface::getCacheTags
EntityViewBuilder::getSingleFieldDisplay protected function Gets an EntityViewDisplay for rendering an individual field.
EntityViewBuilder::isViewModeCacheable protected function Determines whether the view mode is cacheable.
EntityViewBuilder::resetCache public function Resets the entity render cache. Overrides EntityViewBuilderInterface::resetCache
EntityViewBuilder::trustedCallbacks public static function Lists the trusted callbacks provided by the implementing class. Overrides TrustedCallbackInterface::trustedCallbacks 2
EntityViewBuilder::viewField public function Builds a renderable array for the value of a single field in an entity. Overrides EntityViewBuilderInterface::viewField
EntityViewBuilder::viewFieldItem public function Builds a renderable array for a single field item. Overrides EntityViewBuilderInterface::viewFieldItem
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
TagViewBuilder::$configFactory protected property The config factory.
TagViewBuilder::$moduleHandler protected property The module handler. Overrides EntityHandlerBase::$moduleHandler
TagViewBuilder::$token protected property DFP token service.
TagViewBuilder::buildComponents public function Builds the component fields and properties of a set of entities. Overrides EntityViewBuilder::buildComponents
TagViewBuilder::buildPreTag protected static function Builds a #pre_render-able DFP tag render array.
TagViewBuilder::createInstance public static function Instantiates a new instance of this entity handler. Overrides EntityViewBuilder::createInstance
TagViewBuilder::view public function Builds the render array for the provided entity. Overrides EntityViewBuilder::view
TagViewBuilder::viewMultiple public function Builds the render array for the provided entities. Overrides EntityViewBuilder::viewMultiple
TagViewBuilder::__construct public function Constructs a new BlockViewBuilder. Overrides EntityViewBuilder::__construct
TrustedCallbackInterface::THROW_EXCEPTION constant Untrusted callbacks throw exceptions.
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION constant Untrusted callbacks trigger silenced E_USER_DEPRECATION errors.
TrustedCallbackInterface::TRIGGER_WARNING constant Untrusted callbacks trigger E_USER_WARNING errors.