class Page in Open Social 8

Pre-processes variables for the "page" theme hook.

Plugin annotation

@BootstrapPreprocess("page");

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\bootstrap\Plugin\PluginBase
      • class \Drupal\bootstrap\Plugin\Preprocess\PreprocessBase implements PreprocessInterface
        • class \Drupal\socialbase\Plugin\Preprocess\Page

17 string references to 'Page'

views.view.activity_stream.yml in modules/social_features/social_activity/config/install/views.view.activity_stream.yml

modules/social_features/social_activity/config/install/views.view.activity_stream.yml

views.view.activity_stream_notifications.yml in modules/social_features/social_activity/config/install/views.view.activity_stream_notifications.yml

modules/social_features/social_activity/config/install/views.view.activity_stream_notifications.yml

views.view.content.yml in modules/social_features/social_core/config/install/views.view.content.yml

modules/social_features/social_core/config/install/views.view.content.yml

views.view.event_enrollments.yml in modules/social_features/social_event/config/install/views.view.event_enrollments.yml

modules/social_features/social_event/config/install/views.view.event_enrollments.yml

views.view.following.yml in modules/social_features/social_follow_content/config/install/views.view.following.yml

modules/social_features/social_follow_content/config/install/views.view.following.yml

... See full list

File

themes/socialbase/src/Plugin/Preprocess/Page.php, line 17

Namespace

Drupal\socialbase\Plugin\Preprocess

class Page extends PreprocessBase {

  /**
   * {@inheritdoc}
   */
  public function preprocess(array &$variables, $hook, array $info) {
    parent::preprocess($variables, $hook, $info);

    // Add needed attributes so later in template we can manipulate with them.
    $attributes = new Attribute();

    // Default classes.
    $attributes
      ->addClass('row', 'container');

    // If page has title.
    if ($variables['page']['title']) {
      $attributes
        ->addClass('with-title-region');
      $variables['display_page_title'] = TRUE;
    }

    // If we have the admin toolbar permission.
    $user = \Drupal::currentUser();

    // Check for permission.
    if ($user
      ->hasPermission('access toolbar')) {
      $variables['#attached']['library'][] = 'socialbase/admin-toolbar';
    }

    // Add plain title for node preview page templates.
    if (!empty($variables['page']['#title'])) {
      $variables['plain_title'] = strip_tags($variables['page']['#title']);
    }

    // Hide page title for pages where we want to
    // display it in the Hero instead, like event, topic, basic page.
    // First determine if we are looking at a node.
    $nid = \Drupal::routeMatch()
      ->getRawParameter('node');
    $node = FALSE;
    $current_url = Url::fromRoute('<current>');
    $current_path = $current_url
      ->toString();
    if (!is_null($nid) && !is_object($nid)) {
      $node = Node::load($nid);
    }
    if ($node instanceof Node) {

      // List pages where we want to hide the default page title.
      $page_to_exclude = [
        'event',
        'topic',
        'page',
        'book',
      ];
      $paths_to_exclude = [
        'edit',
        'add',
        'delete',
      ];
      $in_path = str_replace($paths_to_exclude, '', $current_path) != $current_path;
      if (!$in_path) {

        // If there is a title and node type is excluded remove class.
        if (in_array($node
          ->bundle(), $page_to_exclude, TRUE)) {
          $attributes
            ->removeClass('with-title-region');
          $variables['display_page_title'] = FALSE;
        }
      }
    }

    // Check complementary_top and complementary_bottom variables.
    if ($variables['page']['complementary_top'] || $variables['page']['complementary_bottom']) {
      $attributes
        ->addClass('layout--with-complementary');
    }

    // Check if sidebars are empty.
    if (empty($variables['page']['sidebar_first']) && empty($variables['page']['sidebar_second'])) {
      $attributes
        ->addClass('layout--with-complementary');
    }

    // Sidebars logic.
    if (empty($variables['page']['complementary_top']) && empty($variables['page']['complementary_bottom'])) {
      if ($variables['page']['sidebar_first'] && $variables['page']['sidebar_second']) {
        $attributes
          ->addClass('layout--with-three-columns');
      }
      if (!empty($variables['page']['sidebar_second']) xor !empty($variables['page']['sidebar_first'])) {
        $attributes
          ->addClass('layout--with-two-columns');
      }
    }
    $variables['content_attributes'] = $attributes;
  }

}

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
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
Page::preprocess	public	function	Preprocess theme hook variables. Overrides PreprocessBase::preprocess
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::$theme	protected	property	The currently set theme object.
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.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct	1
PreprocessBase::$hook	protected	property	The theme hook invoked.
PreprocessBase::$info	protected	property	The theme hook info array from the theme registry.
PreprocessBase::$variables	protected	property	The Variables object.
PreprocessBase::preprocessAttributes	protected	function	Ensures all attributes have been converted to an Attribute object.
PreprocessBase::preprocessDescription	protected	function	Converts any set description variable into a traversable array.
PreprocessBase::preprocessElement	protected	function	Preprocess the variables array if an element is present.	8
PreprocessBase::preprocessVariables	protected	function	Preprocess the variables array.	15
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.