You are here

Home » API reference » Pathauto 8 » ForumAliasType.php

class ForumAliasType in Pathauto 8

A pathauto alias type plugin for forum terms.

Plugin annotation


@AliasType(
  id = "forum",
  label = @Translation("Forum"),
  types = {"term"},
  provider = "forum",
  context_definitions = {
    "taxonomy_term" = @ContextDefinition("entity:taxonomy_term")
  }
)

Hierarchy

Expanded class hierarchy of ForumAliasType

File

src/Plugin/pathauto/AliasType/ForumAliasType.php, line 27

Namespace

Drupal\pathauto\Plugin\pathauto\AliasType
View source 
class ForumAliasType extends EntityAliasTypeBase implements ContainerFactoryPluginInterface {

  /**
   * The config factory.
   *
   * @var \Drupal\Core\Config\ConfigFactoryInterface
   */
  protected $configFactory;

  /**
   * Constructs a ForumAliasType instance.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler service.
   * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
   *   The language manager service.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity manager service.
   * @param \Drupal\Core\KeyValueStore\KeyValueFactoryInterface $key_value
   *   The key/value manager service.
   * @param \Drupal\Core\Database\Connection $database
   *   The database service.
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The config factory.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, ModuleHandlerInterface $module_handler, LanguageManagerInterface $language_manager, EntityTypeManagerInterface $entity_type_manager, KeyValueFactoryInterface $key_value, Connection $database, ConfigFactoryInterface $config_factory) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $module_handler, $language_manager, $entity_type_manager, $key_value, $database);
    $this->configFactory = $config_factory;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('module_handler'), $container
      ->get('language_manager'), $container
      ->get('entity_type.manager'), $container
      ->get('keyvalue'), $container
      ->get('database'), $container
      ->get('config.factory'));
  }

  /**
   * {@inheritdoc}
   */
  protected function getEntityTypeId() {
    return 'taxonomy_term';
  }

  /**
   * {@inheritdoc}
   */
  public function getSourcePrefix() {
    return '/forum/';
  }

  /**
   * {@inheritdoc}
   */
  public function applies($object) {
    if (parent::applies($object)) {

      /** @var \Drupal\taxonomy\TermInterface $object */
      $vid = $this->configFactory
        ->get('forum.settings')
        ->get('vocabulary');
      return $object
        ->bundle() == $vid;
    }
    return FALSE;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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::contextHandler protected function Wraps the context handler.
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::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
EntityAliasTypeBase::$database protected property The database connection.
EntityAliasTypeBase::$entityTypeManager protected property The entity manager service.
EntityAliasTypeBase::$keyValue protected property The key/value manager service.
EntityAliasTypeBase::$languageManager protected property The language manager service.
EntityAliasTypeBase::$moduleHandler protected property The module handler service.
EntityAliasTypeBase::$prefix protected property The path prefix for this entity type.
EntityAliasTypeBase::batchDelete public function Gets called to batch delete all aliases created by pathauto. Overrides AliasTypeBatchUpdateInterface::batchDelete
EntityAliasTypeBase::batchUpdate public function Gets called to batch update all entries. Overrides AliasTypeBatchUpdateInterface::batchUpdate
EntityAliasTypeBase::bulkDelete Deprecated protected function Deletes the URL aliases for multiple entities.
EntityAliasTypeBase::bulkUpdate protected function Update the URL aliases for multiple entities.
EntityAliasTypeBase::calculateDependencies public function
EntityAliasTypeBase::getLabel public function Get the label. Overrides AliasTypeInterface::getLabel 1
EntityAliasTypeBase::getTableInfo private function Returns information about the path alias table and field names.
EntityAliasTypeBase::getTokenTypes public function Get the token types. Overrides AliasTypeInterface::getTokenTypes
EntityAliasTypeBase::setContextValue public function Sets the value for a defined context. Overrides ContextAwarePluginBase::setContextValue
ForumAliasType::$configFactory protected property The config factory.
ForumAliasType::applies public function Determines if this plugin type can apply a given object. Overrides EntityAliasTypeBase::applies
ForumAliasType::create public static function Creates an instance of the plugin. Overrides EntityAliasTypeBase::create
ForumAliasType::getEntityTypeId protected function Returns the entity type ID. Overrides EntityAliasTypeBase::getEntityTypeId
ForumAliasType::getSourcePrefix public function Returns the source prefix; used for bulk delete. Overrides EntityAliasTypeBase::getSourcePrefix
ForumAliasType::__construct public function Constructs a ForumAliasType instance. Overrides EntityAliasTypeBase::__construct
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
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.
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