class ShareMessageViewBuilder in Share Message 8

Render controller for nodes.

Hierarchy

class \Drupal\Core\Entity\EntityHandlerBase uses DependencySerializationTrait, StringTranslationTrait
- class \Drupal\Core\Entity\EntityViewBuilder implements EntityHandlerInterface, EntityViewBuilderInterface, TrustedCallbackInterface uses DeprecatedServicePropertyTrait
  - class \Drupal\sharemessage\Entity\Handler\ShareMessageViewBuilder

Expanded class hierarchy of ShareMessageViewBuilder

File

src/Entity/Handler/ShareMessageViewBuilder.php, line 12

Namespace

Drupal\sharemessage\Entity\Handler

View source

class ShareMessageViewBuilder extends EntityViewBuilder {

  /**
   * {@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) {
    if (empty($entities)) {
      return [];
    }
    $build = [];
    foreach ($entities as $entity) {

      /* @var \Drupal\sharemessage\ShareMessageInterface $entity */

      // EntityViewController expects the entity to be in #sharemessage.
      $cacheability_metadata = CacheableMetadata::createFromObject($entity);
      $build[$entity
        ->id()] = [
        '#sharemessage' => $entity,
        '#contextual_links' => [
          'sharemessage' => [
            'route_parameters' => [
              'sharemessage' => $entity
                ->id(),
            ],
          ],
        ],
      ];
      $cacheability_metadata
        ->addCacheableDependency(\Drupal::config('sharemessage.settings'));
      $cacheability_metadata
        ->applyTo($build[$entity
        ->id()]);
      $context = $entity
        ->getContext($view_mode);
      $is_overridden = \Drupal::request()->query
        ->get('smid') && \Drupal::config('sharemessage.settings')
        ->get('message_enforcement');

      // Add OG Tags to the page if there are none added yet and a corresponding
      // view mode was set (or it was altered into such a view mode in getContent()).
      $og_view_modes = [
        'full',
        'only_og_tags',
        'no_attributes',
      ];
      if (!$is_overridden && in_array($context['view_mode'], $og_view_modes)) {
        $build[$entity
          ->id()]['#attached']['html_head'] = $this
          ->mapHeadElements($entity
          ->buildOGTags($context));
      }

      // Add twitter card meta tags if setting is active.
      if (\Drupal::config('sharemessage.settings')
        ->get('add_twitter_card')) {
        $twitter_tags = $entity
          ->buildTwitterCardTags($context);
        $build[$entity
          ->id()]['#attached']['html_head'] = array_merge($build[$entity
          ->id()]['#attached']['html_head'], $twitter_tags);
      }
      if ($entity
        ->hasPlugin() && $view_mode != 'only_og_tags') {
        $attributes_view_modes = [
          'full',
          'attributes_only',
        ];
        $plugin_attributes = in_array($context['view_mode'], $attributes_view_modes);
        $build[$entity
          ->id()][$entity
          ->getPluginID()] = $entity
          ->getPlugin()
          ->build($context, $plugin_attributes);
      }
    }
    return $build;
  }

  /**
   * Modifies a buildOGTags structure to work with drupal_add_html_head.
   *
   * @param array $elements
   *   An array containing the Open Graph meta tags:
   *     - title
   *     - image: If at least one image Url is given.
   *     - video, video:width, video:height, video:type:
   *       If at least one video Url is given.
   *     - url
   *     - description
   *     - type
   *
   * @return array $mapped
   *   The new structured buildOGTags array to work with drupal_add_html_head.
   */
  protected function mapHeadElements(array $elements) {
    $mapped = [];
    foreach ($elements as $element) {
      $mapped[] = [
        $element,
        str_replace(':', '_', $element['#attributes']['property']),
      ];
    }
    return $mapped;
  }

}

Members

Name	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	property	The module handler to invoke hooks on.	2
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::buildComponents	public	function	Builds the component fields and properties of a set of entities. Overrides EntityViewBuilderInterface::buildComponents	6
EntityViewBuilder::buildMultiple	public	function	Builds multiple entities' views; augments entity defaults.
EntityViewBuilder::createInstance	public static	function	Instantiates a new instance of this entity handler. Overrides EntityHandlerInterface::createInstance	2
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
EntityViewBuilder::__construct	public	function	Constructs a new EntityViewBuilder.	2
ShareMessageViewBuilder::mapHeadElements	protected	function	Modifies a buildOGTags structure to work with drupal_add_html_head.
ShareMessageViewBuilder::view	public	function	Builds the render array for the provided entity. Overrides EntityViewBuilder::view
ShareMessageViewBuilder::viewMultiple	public	function	Builds the render array for the provided entities. Overrides EntityViewBuilder::viewMultiple
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.
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.

You are here

class ShareMessageViewBuilder in Share Message 8

Hierarchy

File

Namespace

Members

API Navigation