class PanelizerUser in Panelizer 8.3

Panelizer entity plugin for integrating with users.

Plugin annotation

@PanelizerEntity("user");

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\panelizer\Plugin\PanelizerEntityBase implements ContainerFactoryPluginInterface, PanelizerEntityInterface uses StringTranslationTrait
    • class \Drupal\panelizer\Plugin\PanelizerEntity\PanelizerUser

File

src/Plugin/PanelizerEntity/PanelizerUser.php, line 16

Namespace

Drupal\panelizer\Plugin\PanelizerEntity

class PanelizerUser extends PanelizerEntityBase {

  /**
   * {@inheritdoc}
   */
  public function getDefaultDisplay(EntityViewDisplayInterface $display, $bundle, $view_mode) {
    $panels_display = parent::getDefaultDisplay($display, $bundle, $view_mode)
      ->setPageTitle('[user:name]');

    // Remove the 'name' block because it's covered already.
    foreach ($panels_display
      ->getRegionAssignments() as $region => $blocks) {

      /** @var \Drupal\Core\Block\BlockPluginInterface[] $blocks */
      foreach ($blocks as $block_id => $block) {
        if ($block
          ->getPluginId() == 'entity_field:user:name') {
          $panels_display
            ->removeBlock($block_id);
        }
      }
    }
    if ($display
      ->getComponent('member_for')) {

      // @todo: add block for 'Member for'.
    }
    return $panels_display;
  }

  /**
   * {@inheritdoc}
   */
  public function alterBuild(array &$build, EntityInterface $entity, PanelsDisplayVariant $panels_display, $view_mode) {

    /** @var $entity \Drupal\user\Entity\User */
    parent::alterBuild($build, $entity, $panels_display, $view_mode);
    if ($entity
      ->id()) {
      $build['#contextual_links']['user'] = [
        'route_parameters' => [
          'user' => $entity
            ->id(),
        ],
        'metadata' => [
          'changed' => $entity
            ->getChangedTime(),
        ],
      ];
    }

    // This function adds a default alt tag to the user_picture field to
    // maintain accessibility.
    if (user_picture_enabled() && !empty($build['content']['middle'])) {
      foreach (Element::children($build['content']['middle']) as $key) {
        if (isset($build['content']['middle'][$key]['content']['field'])) {
          foreach (Element::children($build['content']['middle'][$key]['content']['field']) as $field_key) {
            if ($build['content']['middle'][$key]['content']['field']['#field_name'] == 'user_picture') {
              if (empty($build['content']['middle'][$key]['content']['field'][$field_key]['#item_attributes'])) {
                $build['content']['middle'][$key]['content']['field'][$field_key]['#item_attributes'] = [
                  'alt' => \Drupal::translation()
                    ->translate('Profile picture for user @username', [
                    '@username' => $entity
                      ->getUsername(),
                  ]),
                ];
              }
            }
          }
        }
      }
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
PanelizerEntityBase::$entityFieldManager	protected	property
PanelizerEntityBase::$panelsManager	protected	property
PanelizerEntityBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
PanelizerEntityBase::preprocessViewMode	public	function	Preprocess the variables for the view mode template. Overrides PanelizerEntityInterface::preprocessViewMode	1
PanelizerEntityBase::__construct	public	function	Overrides PluginBase::__construct
PanelizerUser::alterBuild	public	function	Alter the built entity view in an entity specific way before rendering. Overrides PanelizerEntityBase::alterBuild
PanelizerUser::getDefaultDisplay	public	function	Creates a default Panels display from the core Entity display. Overrides PanelizerEntityBase::getDefaultDisplay
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
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.