public function AccountHeaderBlock::build in Open Social 10.3.x

Same name and namespace in other branches

1. 8.9 modules/social_features/social_user/src/Plugin/Block/AccountHeaderBlock.php \Drupal\social_user\Plugin\Block\AccountHeaderBlock::build()
2. 8 modules/social_features/social_user/src/Plugin/Block/AccountHeaderBlock.php \Drupal\social_user\Plugin\Block\AccountHeaderBlock::build()
3. 8.2 modules/social_features/social_user/src/Plugin/Block/AccountHeaderBlock.php \Drupal\social_user\Plugin\Block\AccountHeaderBlock::build()
4. 8.3 modules/social_features/social_user/src/Plugin/Block/AccountHeaderBlock.php \Drupal\social_user\Plugin\Block\AccountHeaderBlock::build()
5. 8.4 modules/social_features/social_user/src/Plugin/Block/AccountHeaderBlock.php \Drupal\social_user\Plugin\Block\AccountHeaderBlock::build()
6. 8.5 modules/social_features/social_user/src/Plugin/Block/AccountHeaderBlock.php \Drupal\social_user\Plugin\Block\AccountHeaderBlock::build()
7. 8.6 modules/social_features/social_user/src/Plugin/Block/AccountHeaderBlock.php \Drupal\social_user\Plugin\Block\AccountHeaderBlock::build()
8. 8.7 modules/social_features/social_user/src/Plugin/Block/AccountHeaderBlock.php \Drupal\social_user\Plugin\Block\AccountHeaderBlock::build()
9. 8.8 modules/social_features/social_user/src/Plugin/Block/AccountHeaderBlock.php \Drupal\social_user\Plugin\Block\AccountHeaderBlock::build()
10. 10.0.x modules/social_features/social_user/src/Plugin/Block/AccountHeaderBlock.php \Drupal\social_user\Plugin\Block\AccountHeaderBlock::build()
11. 10.1.x modules/social_features/social_user/src/Plugin/Block/AccountHeaderBlock.php \Drupal\social_user\Plugin\Block\AccountHeaderBlock::build()
12. 10.2.x modules/social_features/social_user/src/Plugin/Block/AccountHeaderBlock.php \Drupal\social_user\Plugin\Block\AccountHeaderBlock::build()

Builds and returns the renderable array for this block plugin.

If a block should not be rendered because it has no content, then this method must also ensure to return no content: it must then only return an empty array, or an empty array with #cache set (with cacheability metadata indicating the circumstances for it being empty).

Return value

array A renderable array representing the content of the block.

Overrides BlockPluginInterface::build

See also

\Drupal\block\BlockViewBuilder

File

modules/social_features/social_user/src/Plugin/Block/AccountHeaderBlock.php, line 125

Class

AccountHeaderBlock

Provides a 'AccountHeaderBlock' block.

Namespace

Drupal\social_user\Plugin\Block

Code

public function build() {

  // This context is used to pass the block context to hooks.
  $context = $this
    ->getContextValues();
  $block = [
    '#attributes' => [
      'class' => [
        'navbar-user',
      ],
    ],
    'menu_items' => [
      '#theme' => 'item_list',
      '#list_type' => 'ul',
      '#attributes' => [
        'class' => [
          'nav',
          'navbar-nav',
        ],
      ],
      '#items' => [],
    ],
  ];

  // Create a convenience shortcut for later code.
  $menu_items =& $block['menu_items']['#items'];

  /** @var \Drupal\Core\Session\AccountInterface $account */
  $account = $this
    ->getContextValue('user');
  if ($account
    ->isAuthenticated()) {
    $menu_items['create'] = [
      '#type' => 'account_header_element',
      '#title' => $this
        ->t('Create New Content'),
      '#url' => Url::fromRoute('<none>'),
      '#icon' => 'add_box',
      '#label' => $this
        ->t('New Content'),
    ];

    // Gather the content creation links from all modules.
    // Weights can be used to order the subitems of an account_header_element.
    $create_links = $this->moduleHandler
      ->invokeAll('social_user_account_header_create_links', [
      $context,
    ]);

    // Allow modules to alter the defined content creation links.
    $this->moduleHandler
      ->alter('social_user_account_header_create_links', $create_links, $context);
    $menu_items['create'] += $create_links;

    // If the user can't access any children then we disable the entire menu.
    if (isset($menu_items['create']) && is_array($menu_items['create']) && !$this
      ->hasAccessibleChild($menu_items['create'])) {
      $menu_items['create']['#access'] = FALSE;
    }
    $account_name = $account
      ->getDisplayName();
    $menu_items['account_box'] = [
      '#type' => 'account_header_element',
      '#wrapper_attributes' => [
        'class' => [
          'profile',
        ],
      ],
      '#icon' => 'account_circle',
      '#title' => $this
        ->t('Profile of @account', [
        '@account' => $account_name,
      ]),
      '#label' => $account_name,
      '#url' => Url::fromRoute('<none>'),
      '#weight' => 1000,
    ];
    $account_links = [
      'signed_in_as' => [
        '#wrapper_attributes' => [
          'class' => [
            'dropdown-header',
            'header-nav-current-user',
          ],
        ],
        '#type' => 'inline_template',
        '#template' => '<a href="/user">{{ tagline }}<strong class="text-truncate">{{ object }} </strong></a>',
        '#context' => [
          'tagline' => $this
            ->t('Signed in as'),
          'object' => $account_name,
        ],
        '#weight' => 0,
      ],
      // @todo Figure out how move these dividers to the right modules.
      'divider_mobile' => [
        "#wrapper_attributes" => [
          "class" => [
            "divider",
            "mobile",
          ],
          "role" => "separator",
        ],
        '#weight' => 100,
      ],
      'divider_profile' => [
        "#wrapper_attributes" => [
          "class" => [
            "divider",
          ],
          "role" => "separator",
        ],
        '#weight' => 400,
      ],
      'divider_content' => [
        "#wrapper_attributes" => [
          "class" => [
            "divider",
          ],
          "role" => "separator",
        ],
        '#weight' => 900,
      ],
      'divider_account' => [
        "#wrapper_attributes" => [
          "class" => [
            "divider",
          ],
          "role" => "separator",
        ],
        '#weight' => 1100,
      ],
    ];

    // Gather the account related links from extending modules.
    $account_links += $this->moduleHandler
      ->invokeAll('social_user_account_header_account_links', [
      $context,
    ]);

    // Allow modules to alter the defined account related links.
    $this->moduleHandler
      ->alter('social_user_account_header_account_links', $account_links, $context);

    // Append the account links as children to the account menu.
    $menu_items['account_box'] += $account_links;
  }

  // We allow modules to add their items to the account header block.
  // We use the union operator (+) to ensure modules can't overwrite items
  // defined above. They should use the alter hook for that.
  $menu_items += $this->moduleHandler
    ->invokeAll('social_user_account_header_items', [
    $context,
  ]);

  // Allow modules to alter the defined account header block items.
  $this->moduleHandler
    ->alter('social_user_account_header_items', $menu_items, $context);

  // We render this element as an item_list (template_preprocess_item_list)
  // which doesn't sort. Therefore it happens here.
  Element::children($menu_items, TRUE);

  // We remove the '#sorted' key that's added above because
  // template_preprocess_item_list does not know how to handle it.
  unset($menu_items['#sorted']);

  // The item_list theme function gets the wrapper_attributes before the
  // AccountHeaderElement::preRender is called. Therefor we provide some
  // assisting classes here.
  foreach ($menu_items as &$item) {
    if (empty($item['#type']) || $item['#type'] !== 'account_header_element') {
      continue;
    }

    // Sort the children according to their weight.
    $children = Element::children($item, TRUE);

    // If this element has children then it's a dropdown.
    if (!empty($children)) {
      if (empty($item['#wrapper_attributes'])) {
        $item['#wrapper_attributes'] = [];
      }
      if (empty($item['#wrapper_attributes']['class'])) {
        $item['#wrapper_attributes']['class'] = [];
      }
      $item['#wrapper_attributes']['class'][] = 'dropdown';
    }
  }
  return $block;
}