class PrivateMessageViewBuilder in Private Message 8.2

Build handler for rpivate messages.

Hierarchy

• class \Drupal\Core\Entity\EntityHandlerBase uses DependencySerializationTrait, StringTranslationTrait
  • class \Drupal\Core\Entity\EntityViewBuilder implements EntityHandlerInterface, EntityViewBuilderInterface, TrustedCallbackInterface uses DeprecatedServicePropertyTrait
    • class \Drupal\private_message\Entity\Builder\PrivateMessageViewBuilder

File

src/Entity/Builder/PrivateMessageViewBuilder.php, line 19

Namespace

Drupal\private_message\Entity\Builder

class PrivateMessageViewBuilder extends EntityViewBuilder {

  /**
   * The current user.
   *
   * @var \Drupal\Core\Session\AccountProxyInterface
   */
  protected $currentUser;

  /**
   * Constructs a PrivateMessageViewBuilder object.
   *
   * @param \Drupal\Core\Entity\EntityRepositoryInterface $entityRepository
   *   The entity repository service.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entityTypeManager
   *   The entity manager service.
   * @param \Drupal\Core\Language\LanguageManagerInterface $languageManager
   *   The language manager.
   * @param \Drupal\Core\Session\AccountProxyInterface $currentUser
   *   The current user.
   * @param \Drupal\Core\Theme\Registry $themeRegistry
   *   The theme registry.
   * @param \Drupal\Core\Entity\EntityDisplayRepositoryInterface $entity_display_repository
   *   The entity display repository.
   */
  public function __construct(EntityTypeInterface $entityType, EntityRepositoryInterface $entityRepository, LanguageManagerInterface $languageManager, AccountProxyInterface $currentUser, Registry $themeRegistry = NULL, EntityDisplayRepositoryInterface $entity_display_repository) {
    parent::__construct($entityType, $entityRepository, $languageManager, $themeRegistry, $entity_display_repository);
    $this->currentUser = $currentUser;
  }

  /**
   * {@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('current_user'), $container
      ->get('theme.registry'), $container
      ->get('entity_display.repository'));
  }

  /**
   * {@inheritdoc}
   */
  public function view(EntityInterface $entity, $viewMode = 'default', $langcode = NULL) {
    $message = parent::view($entity, $viewMode, $langcode);
    $classes = [
      'private-message',
    ];
    $classes[] = 'private-message-' . $viewMode;
    $classes[] = 'private-message-author-' . ($this->currentUser
      ->id() == $entity
      ->getOwnerId() ? 'self' : 'other');
    $id = 'private-message-' . $entity
      ->id();
    $build['wrapper'] = [
      '#type' => 'container',
      '#attributes' => [
        'id' => $id,
        'data-message-id' => $entity
          ->id(),
        'class' => $classes,
      ],
    ];
    $build['wrapper']['message'] = $message;
    $this
      ->moduleHandler()
      ->alter('private_message_view', $build, $entity, $viewMode);
    return $build;
  }

}

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::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::viewMultiple	public	function	Builds the render array for the provided entities. Overrides EntityViewBuilderInterface::viewMultiple	4
PrivateMessageViewBuilder::$currentUser	protected	property	The current user.
PrivateMessageViewBuilder::createInstance	public static	function	Instantiates a new instance of this entity handler. Overrides EntityViewBuilder::createInstance
PrivateMessageViewBuilder::view	public	function	Builds the render array for the provided entity. Overrides EntityViewBuilder::view
PrivateMessageViewBuilder::__construct	public	function	Constructs a PrivateMessageViewBuilder object. Overrides EntityViewBuilder::__construct
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.