You are here

Home » API reference » Page Manager 8.4 » PageVariantConfigMapper.php

class PageVariantConfigMapper in Page Manager 8.4

Same name and namespace in other branches
  1. 8 page_manager_ui/src/ConfigTranslation/PageVariantConfigMapper.php \Drupal\page_manager_ui\ConfigTranslation\PageVariantConfigMapper

Configuration mapper for page variants.

@todo Remove once https://www.drupal.org/node/2670712 is in.

Hierarchy

Expanded class hierarchy of PageVariantConfigMapper

1 file declares its use of PageVariantConfigMapper
page_manager_ui.module in page_manager_ui/page_manager_ui.module
Provides a UI for Page Manager.

File

page_manager_ui/src/ConfigTranslation/PageVariantConfigMapper.php, line 13

Namespace

Drupal\page_manager_ui\ConfigTranslation
View source 
class PageVariantConfigMapper extends ConfigEntityMapper {

  /**
   * {@inheritdoc}
   */
  protected function processRoute(Route $route) {
    parent::processRoute($route);

    // Change the paths for config translation routes to outside the wizard.
    $path = $route
      ->getPath();
    $path = str_replace('manage/{machine_name}/{step}', '{page}/{page_variant}', $path);
    $route
      ->setPath($path);
  }

  /**
   * {@inheritdoc}
   */
  public function getBaseRouteParameters() {
    $parameters = parent::getBaseRouteParameters();
    $parameters['page'] = $this->entity
      ->get('page');
    $parameters['machine_name'] = $parameters['page'];
    $parameters['step'] = 'page_variant__' . $parameters['page_variant'] . '__general';
    return $parameters;
  }

  /**
   * {@inheritdoc}
   */
  public function getAddRouteName() {
    return $this
      ->alterRouteName(parent::getAddRouteName());
  }

  /**
   * {@inheritdoc}
   */
  public function getEditRouteName() {
    return $this
      ->alterRouteName(parent::getEditRouteName());
  }

  /**
   * {@inheritdoc}
   */
  public function getDeleteRouteName() {
    return $this
      ->alterRouteName(parent::getDeleteRouteName());
  }

  /**
   * Alter the route name to be unique from page entity route names.
   *
   * @param string $name
   *   Route name for the mapper.
   *
   * @return string
   *   Altered route name for the mapper.
   */
  protected function alterRouteName($name) {
    return str_replace('page', 'page_variant', $name);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigEntityMapper::$deprecatedProperties protected property
ConfigEntityMapper::$entity protected property Loaded entity instance to help produce the translation interface. 1
ConfigEntityMapper::$entityType protected property Configuration entity type name.
ConfigEntityMapper::$entityTypeManager protected property The entity manager.
ConfigEntityMapper::$typeLabel protected property The label for the entity type.
ConfigEntityMapper::create public static function Creates an instance of the plugin. Overrides ConfigNamesMapper::create
ConfigEntityMapper::getContextualLinkGroup public function Returns the name of the contextual link group to add contextual links to. Overrides ConfigNamesMapper::getContextualLinkGroup
ConfigEntityMapper::getEntity public function Gets the entity instance for this mapper.
ConfigEntityMapper::getOperations public function Provides an array of information to build a list of operation links. Overrides ConfigNamesMapper::getOperations
ConfigEntityMapper::getOverviewRouteName public function Returns route name for the translation overview route. Overrides ConfigNamesMapper::getOverviewRouteName 1
ConfigEntityMapper::getTitle public function Returns title of this translation page. Overrides ConfigNamesMapper::getTitle
ConfigEntityMapper::getType public function Gets the entity type from this mapper.
ConfigEntityMapper::getTypeLabel public function Returns the label of the type of data the mapper encapsulates. Overrides ConfigNamesMapper::getTypeLabel 1
ConfigEntityMapper::getTypeName public function Returns the name of the type of data the mapper encapsulates. Overrides ConfigNamesMapper::getTypeName
ConfigEntityMapper::populateFromRouteMatch public function Populate the config mapper with route match data. Overrides ConfigNamesMapper::populateFromRouteMatch
ConfigEntityMapper::setEntity public function Sets the entity instance for this mapper. 2
ConfigEntityMapper::setType public function Set entity type for this mapper.
ConfigEntityMapper::__construct public function Constructs a ConfigEntityMapper. Overrides ConfigNamesMapper::__construct
ConfigNamesMapper::$baseRoute protected property The base route object that the mapper is attached to.
ConfigNamesMapper::$configFactory protected property The configuration factory.
ConfigNamesMapper::$configMapperManager protected property The mapper plugin discovery service.
ConfigNamesMapper::$eventDispatcher protected property The event dispatcher.
ConfigNamesMapper::$langcode protected property The language code of the language this mapper, if any.
ConfigNamesMapper::$languageManager protected property The language manager.
ConfigNamesMapper::$localeConfigManager protected property The typed configuration manager.
ConfigNamesMapper::$routeCollection protected property The available routes.
ConfigNamesMapper::$routeProvider protected property The route provider.
ConfigNamesMapper::$typedConfigManager protected property The typed config manager.
ConfigNamesMapper::addConfigName public function Adds the given configuration name to the list of names. Overrides ConfigMapperInterface::addConfigName
ConfigNamesMapper::getAddRoute public function Returns the route object for a translation add form route. Overrides ConfigMapperInterface::getAddRoute
ConfigNamesMapper::getAddRouteParameters public function Returns the route parameters for the translation add form route. Overrides ConfigMapperInterface::getAddRouteParameters
ConfigNamesMapper::getBasePath public function Returns a processed path for the base route the mapper is attached to. Overrides ConfigMapperInterface::getBasePath
ConfigNamesMapper::getBaseRoute public function Returns the base route object the mapper is attached to. Overrides ConfigMapperInterface::getBaseRoute
ConfigNamesMapper::getBaseRouteName public function Returns the name of the base route the mapper is attached to. Overrides ConfigMapperInterface::getBaseRouteName
ConfigNamesMapper::getConfigData public function Returns an array with all configuration data. Overrides ConfigMapperInterface::getConfigData
ConfigNamesMapper::getConfigNames public function Returns an array of configuration names for the mapper. Overrides ConfigMapperInterface::getConfigNames
ConfigNamesMapper::getDeleteRoute public function Returns the route object for the translation deletion route. Overrides ConfigMapperInterface::getDeleteRoute
ConfigNamesMapper::getDeleteRouteParameters public function Returns the route parameters for the translation deletion route. Overrides ConfigMapperInterface::getDeleteRouteParameters
ConfigNamesMapper::getEditRoute public function Returns the route object for a translation edit form route. Overrides ConfigMapperInterface::getEditRoute
ConfigNamesMapper::getEditRouteParameters public function Returns the route parameters for the translation edit form route. Overrides ConfigMapperInterface::getEditRouteParameters
ConfigNamesMapper::getLangcode public function Returns the original language code of the configuration. Overrides ConfigMapperInterface::getLangcode
ConfigNamesMapper::getLangcodeFromConfig public function Returns the language code of a configuration object given its name. Overrides ConfigMapperInterface::getLangcodeFromConfig
ConfigNamesMapper::getOverviewPath public function Returns a processed path for the translation overview route. Overrides ConfigMapperInterface::getOverviewPath
ConfigNamesMapper::getOverviewRoute public function Returns the route object for a translation overview route. Overrides ConfigMapperInterface::getOverviewRoute
ConfigNamesMapper::getOverviewRouteParameters public function Returns the route parameters for the translation overview route. Overrides ConfigMapperInterface::getOverviewRouteParameters
ConfigNamesMapper::getWeight public function Returns the weight of the mapper. Overrides ConfigMapperInterface::getWeight
ConfigNamesMapper::hasSchema public function Checks that all pieces of this configuration mapper have a schema. Overrides ConfigMapperInterface::hasSchema
ConfigNamesMapper::hasTranslatable public function Checks if pieces of this configuration mapper have translatables. Overrides ConfigMapperInterface::hasTranslatable
ConfigNamesMapper::hasTranslation public function Checks whether there is already a translation for this mapper. Overrides ConfigMapperInterface::hasTranslation
ConfigNamesMapper::setLangcode public function Sets the original language code. Overrides ConfigMapperInterface::setLangcode
ConfigNamesMapper::setRouteCollection public function Sets the route collection. Overrides ConfigMapperInterface::setRouteCollection
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
DeprecatedServicePropertyTrait::__get public function Allows to access deprecated/removed properties.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PageVariantConfigMapper::alterRouteName protected function Alter the route name to be unique from page entity route names.
PageVariantConfigMapper::getAddRouteName public function Returns route name for the translation add form route. Overrides ConfigNamesMapper::getAddRouteName
PageVariantConfigMapper::getBaseRouteParameters public function Returns the route parameters for the base route the mapper is attached to. Overrides ConfigEntityMapper::getBaseRouteParameters
PageVariantConfigMapper::getDeleteRouteName public function Returns route name for the translation deletion route. Overrides ConfigNamesMapper::getDeleteRouteName
PageVariantConfigMapper::getEditRouteName public function Returns route name for the translation edit form route. Overrides ConfigNamesMapper::getEditRouteName
PageVariantConfigMapper::processRoute protected function Allows to process all config translation routes. Overrides ConfigEntityMapper::processRoute
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.