You are here

class SocialPageTitleBlock in Open Social 8.4

Same name and namespace in other branches
  1. 8.9 modules/social_features/social_core/src/Plugin/Block/SocialPageTitleBlock.php \Drupal\social_core\Plugin\Block\SocialPageTitleBlock
  2. 8 modules/social_features/social_core/src/Plugin/Block/SocialPageTitleBlock.php \Drupal\social_core\Plugin\Block\SocialPageTitleBlock
  3. 8.2 modules/social_features/social_core/src/Plugin/Block/SocialPageTitleBlock.php \Drupal\social_core\Plugin\Block\SocialPageTitleBlock
  4. 8.3 modules/social_features/social_core/src/Plugin/Block/SocialPageTitleBlock.php \Drupal\social_core\Plugin\Block\SocialPageTitleBlock
  5. 8.5 modules/social_features/social_core/src/Plugin/Block/SocialPageTitleBlock.php \Drupal\social_core\Plugin\Block\SocialPageTitleBlock
  6. 8.6 modules/social_features/social_core/src/Plugin/Block/SocialPageTitleBlock.php \Drupal\social_core\Plugin\Block\SocialPageTitleBlock
  7. 8.7 modules/social_features/social_core/src/Plugin/Block/SocialPageTitleBlock.php \Drupal\social_core\Plugin\Block\SocialPageTitleBlock
  8. 8.8 modules/social_features/social_core/src/Plugin/Block/SocialPageTitleBlock.php \Drupal\social_core\Plugin\Block\SocialPageTitleBlock
  9. 10.3.x modules/social_features/social_core/src/Plugin/Block/SocialPageTitleBlock.php \Drupal\social_core\Plugin\Block\SocialPageTitleBlock
  10. 10.0.x modules/social_features/social_core/src/Plugin/Block/SocialPageTitleBlock.php \Drupal\social_core\Plugin\Block\SocialPageTitleBlock
  11. 10.1.x modules/social_features/social_core/src/Plugin/Block/SocialPageTitleBlock.php \Drupal\social_core\Plugin\Block\SocialPageTitleBlock
  12. 10.2.x modules/social_features/social_core/src/Plugin/Block/SocialPageTitleBlock.php \Drupal\social_core\Plugin\Block\SocialPageTitleBlock

Provides a 'SocialPageTitleBlock' block.

Plugin annotation


@Block(
 id = "social_page_title_block",
 admin_label = @Translation("Page title block"),
)

Hierarchy

Expanded class hierarchy of SocialPageTitleBlock

File

modules/social_features/social_core/src/Plugin/Block/SocialPageTitleBlock.php, line 26

Namespace

Drupal\social_core\Plugin\Block
View source
class SocialPageTitleBlock extends PageTitleBlock implements ContainerFactoryPluginInterface {

  /**
   * The route match.
   *
   * @var \Drupal\Core\Routing\RouteMatchInterface
   */
  protected $routeMatch;

  /**
   * The route match.
   *
   * @var \Drupal\social_tagging\SocialTaggingService
   */
  protected $requestStack;

  /**
   * The entity repository.
   *
   * @var \Drupal\Core\Entity\EntityRepositoryInterface
   */
  protected $entityRepository;

  /**
   * The title resolver service.
   *
   * @var \Drupal\Core\Controller\TitleResolverInterface
   */
  protected $titleResolver;

  /**
   * EventAddBlock constructor.
   *
   * @param array $configuration
   *   The given configuration.
   * @param string $plugin_id
   *   The given plugin id.
   * @param mixed $plugin_definition
   *   The given plugin definition.
   * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
   *   The route match.
   * @param \Symfony\Component\HttpFoundation\RequestStack $request_stack
   *   The current request stack.
   * @param \Drupal\Core\Entity\EntityRepositoryInterface $entity_repository
   *   The entity repository.
   * @param \Drupal\Core\Controller\TitleResolverInterface $title_resolver
   *   The title resolver.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, RouteMatchInterface $route_match, RequestStack $request_stack, EntityRepositoryInterface $entity_repository, TitleResolverInterface $title_resolver) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->routeMatch = $route_match;
    $this->requestStack = $request_stack;
    $this->entityRepository = $entity_repository;
    $this->titleResolver = $title_resolver;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('current_route_match'), $container
      ->get('request_stack'), $container
      ->get('entity.repository'), $container
      ->get('title_resolver'));
  }

  /**
   * {@inheritdoc}
   */
  public function build() {

    // Take the raw parameter. We'll load it ourselves.
    $nid = $this->routeMatch
      ->getRawParameter('node');
    $node = FALSE;
    $current_url = Url::fromRoute('<current>');
    $current_path = $current_url
      ->toString();

    // At this point the parameter could also be a simple string of a nid.
    // EG: on: /node/%node/enrollments.
    if (!is_null($nid) && !is_object($nid)) {
      $node = Node::load($nid);
    }
    $request = $this->requestStack
      ->getCurrentRequest();
    if ($node) {

      // Landing pages have their own heroes. Usually we're not displayed for
      // landing page. However, when a landing page is used as a 404 or 403 page
      // then this block is still rendered. Therefor if we're asked to render
      // for a landing page we check if we're not in a 404 or 403. If we are
      // then we can quickly determine we won't render anything.
      if ($node
        ->getType() === "landing_page") {
        $exception = $request->attributes
          ->get('exception');
        if ($exception instanceof NotFoundHttpException || $exception instanceof AccessDeniedHttpException) {
          return [];
        }
      }
      $translation = $this->entityRepository
        ->getTranslationFromContext($node);
      if (!empty($translation)) {
        $node
          ->setTitle($translation
          ->getTitle());
      }
      $paths_to_exclude = [
        'edit',
        'add',
        'delete',
      ];
      $in_path = str_replace($paths_to_exclude, '', $current_path) != $current_path;
      if (!$in_path) {
        $title = $node
          ->getTitle();
        return [
          '#theme' => 'page_hero_data',
          '#title' => $title,
          '#node' => $node,
          '#section_class' => 'page-title',
        ];
      }
      else {
        return [
          '#type' => 'page_title',
          '#title' => $this->title,
        ];
      }
    }
    else {
      if ($route = $request->attributes
        ->get(RouteObjectInterface::ROUTE_OBJECT)) {
        $title = $this->titleResolver
          ->getTitle($request, $route);
        return [
          '#type' => 'page_title',
          '#title' => $title,
        ];
      }
      else {
        return [
          '#type' => 'page_title',
          '#title' => '',
        ];
      }
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BlockPluginInterface::BLOCK_LABEL_VISIBLE constant Indicates the block label (title) should be displayed to end users.
BlockPluginTrait::$transliteration protected property The transliteration service.
BlockPluginTrait::access public function
BlockPluginTrait::baseConfigurationDefaults protected function Returns generic default configuration for block plugins.
BlockPluginTrait::blockAccess protected function Indicates whether the block should be shown. 16
BlockPluginTrait::blockForm public function 16
BlockPluginTrait::blockSubmit public function 13
BlockPluginTrait::blockValidate public function 3
BlockPluginTrait::buildConfigurationForm public function Creates a generic configuration form for all block types. Individual block plugins can add elements to this form by overriding BlockBase::blockForm(). Most block plugins should not override this method unless they need to alter the generic form elements. 2
BlockPluginTrait::calculateDependencies public function
BlockPluginTrait::getConfiguration public function 1
BlockPluginTrait::getMachineNameSuggestion public function 1
BlockPluginTrait::getPreviewFallbackString public function 3
BlockPluginTrait::label public function
BlockPluginTrait::setConfiguration public function
BlockPluginTrait::setConfigurationValue public function
BlockPluginTrait::setTransliteration public function Sets the transliteration service.
BlockPluginTrait::submitConfigurationForm public function Most block plugins should not override this method. To add submission handling for a specific block type, override BlockBase::blockSubmit().
BlockPluginTrait::transliteration protected function Wraps the transliteration service.
BlockPluginTrait::validateConfigurationForm public function Most block plugins should not override this method. To add validation for a specific block type, override BlockBase::blockValidate(). 1
ContextAwarePluginAssignmentTrait::addContextAssignmentElement protected function Builds a form element for assigning a context to a given slot.
ContextAwarePluginAssignmentTrait::contextHandler protected function Wraps the context handler.
ContextAwarePluginBase::$context protected property The data objects representing the context of this plugin.
ContextAwarePluginBase::$contexts Deprecated private property Data objects representing the contexts passed in the plugin configuration.
ContextAwarePluginBase::createContextFromConfiguration protected function Overrides ContextAwarePluginBase::createContextFromConfiguration
ContextAwarePluginBase::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts 9
ContextAwarePluginBase::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge 7
ContextAwarePluginBase::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags 4
ContextAwarePluginBase::getContext public function This code is identical to the Component in order to pick up a different Context class. Overrides ContextAwarePluginBase::getContext
ContextAwarePluginBase::getContextDefinition public function Overrides ContextAwarePluginBase::getContextDefinition
ContextAwarePluginBase::getContextDefinitions public function Overrides ContextAwarePluginBase::getContextDefinitions
ContextAwarePluginBase::getContextMapping public function Gets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::getContextMapping
ContextAwarePluginBase::getContexts public function Gets the defined contexts. Overrides ContextAwarePluginInterface::getContexts
ContextAwarePluginBase::getContextValue public function Gets the value for a defined context. Overrides ContextAwarePluginInterface::getContextValue
ContextAwarePluginBase::getContextValues public function Gets the values for all defined contexts. Overrides ContextAwarePluginInterface::getContextValues
ContextAwarePluginBase::setContext public function Set a context on this plugin. Overrides ContextAwarePluginBase::setContext
ContextAwarePluginBase::setContextMapping public function Sets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::setContextMapping
ContextAwarePluginBase::setContextValue public function Sets the value for a defined context. Overrides ContextAwarePluginBase::setContextValue
ContextAwarePluginBase::validateContexts public function Validates the set values for the defined contexts. Overrides ContextAwarePluginInterface::validateContexts
ContextAwarePluginBase::__get public function Implements magic __get() method.
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.
PageTitleBlock::$title protected property The page title: a string (plain title) or a render array (formatted title).
PageTitleBlock::defaultConfiguration public function Gets default configuration for this plugin. Overrides BlockPluginTrait::defaultConfiguration
PageTitleBlock::setTitle public function Sets the title. Overrides TitleBlockPluginInterface::setTitle
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.
PluginWithFormsTrait::getFormClass public function
PluginWithFormsTrait::hasFormClass public function
SocialPageTitleBlock::$entityRepository protected property The entity repository.
SocialPageTitleBlock::$requestStack protected property The route match.
SocialPageTitleBlock::$routeMatch protected property The route match.
SocialPageTitleBlock::$titleResolver protected property The title resolver service.
SocialPageTitleBlock::build public function Builds and returns the renderable array for this block plugin. Overrides PageTitleBlock::build
SocialPageTitleBlock::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
SocialPageTitleBlock::__construct public function EventAddBlock constructor. Overrides BlockPluginTrait::__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.
TypedDataTrait::$typedDataManager protected property The typed data manager used for creating the data types.
TypedDataTrait::getTypedDataManager public function Gets the typed data manager. 2
TypedDataTrait::setTypedDataManager public function Sets the typed data manager. 2