class Page in Open Social 8.9
Same name in this branch
- 8.9 themes/socialblue/src/Plugin/Preprocess/Page.php \Drupal\socialblue\Plugin\Preprocess\Page
- 8.9 themes/socialbase/src/Plugin/Preprocess/Page.php \Drupal\socialbase\Plugin\Preprocess\Page
- 8.9 modules/custom/social_demo/src/Plugin/DemoContent/Page.php \Drupal\social_demo\Plugin\DemoContent\Page
Same name and namespace in other branches
- 8 themes/socialbase/src/Plugin/Preprocess/Page.php \Drupal\socialbase\Plugin\Preprocess\Page
- 8.2 themes/socialbase/src/Plugin/Preprocess/Page.php \Drupal\socialbase\Plugin\Preprocess\Page
- 8.3 themes/socialbase/src/Plugin/Preprocess/Page.php \Drupal\socialbase\Plugin\Preprocess\Page
- 8.4 themes/socialbase/src/Plugin/Preprocess/Page.php \Drupal\socialbase\Plugin\Preprocess\Page
- 8.5 themes/socialbase/src/Plugin/Preprocess/Page.php \Drupal\socialbase\Plugin\Preprocess\Page
- 8.6 themes/socialbase/src/Plugin/Preprocess/Page.php \Drupal\socialbase\Plugin\Preprocess\Page
- 8.7 themes/socialbase/src/Plugin/Preprocess/Page.php \Drupal\socialbase\Plugin\Preprocess\Page
- 8.8 themes/socialbase/src/Plugin/Preprocess/Page.php \Drupal\socialbase\Plugin\Preprocess\Page
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
- class \Drupal\bootstrap\Plugin\Preprocess\PreprocessBase implements PreprocessInterface
- class \Drupal\bootstrap\Plugin\PluginBase
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of Page
30 string references to 'Page'
- social_event_managers_update_8004.yml in modules/
social_features/ social_event/ modules/ social_event_managers/ config/ update/ social_event_managers_update_8004.yml - modules/social_features/social_event/modules/social_event_managers/config/update/social_event_managers_update_8004.yml
- social_event_update_8805 in modules/
social_features/ social_event/ social_event.install - Install new fields for the request to join event.
- social_event_update_8808.yml in modules/
social_features/ social_event/ config/ update/ social_event_update_8808.yml - modules/social_features/social_event/config/update/social_event_update_8808.yml
- social_group_update_8802.yml in modules/
social_features/ social_group/ config/ update/ social_group_update_8802.yml - modules/social_features/social_group/config/update/social_group_update_8802.yml
- views.view.activity_stream.yml in modules/
social_features/ social_activity/ config/ optional/ views.view.activity_stream.yml - modules/social_features/social_activity/config/optional/views.view.activity_stream.yml
File
- themes/
socialbase/ src/ Plugin/ Preprocess/ Page.php, line 18
Namespace
Drupal\socialbase\Plugin\PreprocessView source
class Page extends PreprocessBase {
/**
* {@inheritdoc}
*/
public function preprocess(array &$variables, $hook, array $info) {
parent::preprocess($variables, $hook, $info);
$attributes = $variables['content_attributes'] instanceof Attribute ? $variables['content_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',
];
// Alter list of content types where need to hide the default page title.
\Drupal::moduleHandler()
->alter('social_content_type', $page_to_exclude);
$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');
}
}
// This behavior should be fixed in the if statements above on the checks
// for empty sidebars and complementary top/bottom parts. Due to time
// restrains for TB-4116 I've added an additional rule to this quick-fix
// solution.
// @see https://www.drupal.org/project/social/issues/3119191
// @todo: remove the if statement below and fix logic mentioned above.
$route = \Drupal::routeMatch()
->getRouteName();
$routes_remove_complementary_class = [
'view.event_manage_enrollments.page_manage_enrollments',
'view.group_manage_members.page_group_manage_members',
'view.group_pending_members.membership_requests',
'view.event_manage_enrollment_requests.page_manage_enrollment_requests',
'view.event_manage_enrollment_invites.page_manage_enrollment_invites',
'view.user_event_invites.page_user_event_invites',
'view.social_group_invitations.page_1',
'view.social_group_user_invitations.page_1',
];
if (in_array($route, $routes_remove_complementary_class)) {
$attributes
->removeClass('row', 'layout--with-complementary');
}
// Only whenever the social_core layout service is registered
// see SocialCoreServiceProvider, we can run this code.
if (\Drupal::hasService('social_core.layout')) {
// Let's grab all entities available from the route params.
foreach (\Drupal::routeMatch()
->getParameters() as $param) {
// If it is an Entity, lets see if layout_builder is enabled
// and remove or add necessary classes.
if ($param instanceof EntityInterface && \Drupal::service('social_core.layout')
->isTrueLayoutCompatibleEntity($param)) {
$attributes
->removeClass('row', 'layout--with-complementary');
$attributes
->addClass('layout--full');
}
}
}
$variables['content_attributes'] = $attributes;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
Page:: |
public | function |
Preprocess theme hook variables. Overrides PreprocessBase:: |
1 |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
protected | property | The currently set theme object. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
PluginBase:: |
public | function |
Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase:: |
1 |
PreprocessBase:: |
protected | property | The theme hook invoked. | |
PreprocessBase:: |
protected | property | The theme hook info array from the theme registry. | |
PreprocessBase:: |
protected | property | The Variables object. | |
PreprocessBase:: |
protected | function | Ensures all attributes have been converted to an Attribute object. | |
PreprocessBase:: |
protected | function | Converts any set description variable into a traversable array. | |
PreprocessBase:: |
protected | function | Preprocess the variables array if an element is present. | 8 |
PreprocessBase:: |
protected | function | Preprocess the variables array. | 15 |
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |