class PathautoPattern in Pathauto 8
Same name in this branch
- 8 src/Entity/PathautoPattern.php \Drupal\pathauto\Entity\PathautoPattern
- 8 src/Plugin/migrate/source/PathautoPattern.php \Drupal\pathauto\Plugin\migrate\source\PathautoPattern
Defines the Pathauto pattern entity.
Plugin annotation
@ConfigEntityType(
id = "pathauto_pattern",
label = @Translation("Pathauto pattern"),
handlers = {
"list_builder" = "Drupal\pathauto\PathautoPatternListBuilder",
"form" = {
"default" = "Drupal\pathauto\Form\PatternEditForm",
"duplicate" = "Drupal\pathauto\Form\PatternDuplicateForm",
"delete" = "Drupal\Core\Entity\EntityDeleteForm",
"enable" = "Drupal\pathauto\Form\PatternEnableForm",
"disable" = "Drupal\pathauto\Form\PatternDisableForm"
},
"route_provider" = {
"html" = "Drupal\Core\Entity\Routing\DefaultHtmlRouteProvider",
},
},
config_prefix = "pattern",
admin_permission = "administer pathauto",
entity_keys = {
"id" = "id",
"label" = "label",
"uuid" = "uuid",
"weight" = "weight",
"status" = "status"
},
config_export = {
"id",
"label",
"type",
"pattern",
"selection_criteria",
"selection_logic",
"weight",
"relationships"
},
lookup_keys = {
"type",
"status",
},
links = {
"collection" = "/admin/config/search/path/patterns",
"edit-form" = "/admin/config/search/path/patterns/{pathauto_pattern}",
"delete-form" = "/admin/config/search/path/patterns/{pathauto_pattern}/delete",
"enable" = "/admin/config/search/path/patterns/{pathauto_pattern}/enable",
"disable" = "/admin/config/search/path/patterns/{pathauto_pattern}/disable",
"duplicate-form" = "/admin/config/search/path/patterns/{pathauto_pattern}/duplicate"
}
)
Hierarchy
- class \Drupal\Core\Entity\EntityBase implements EntityInterface uses RefinableCacheableDependencyTrait, DependencySerializationTrait
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface uses SynchronizableEntityTrait, PluginDependencyTrait
- class \Drupal\pathauto\Entity\PathautoPattern implements PathautoPatternInterface
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface uses SynchronizableEntityTrait, PluginDependencyTrait
Expanded class hierarchy of PathautoPattern
4 files declare their use of PathautoPattern
- pathauto.install in ./
pathauto.install - Install, update, and uninstall functions for Pathauto.
- PathautoNodeWebTest.php in tests/
src/ Functional/ PathautoNodeWebTest.php - PathautoTestHelperTrait.php in tests/
src/ Functional/ PathautoTestHelperTrait.php - PathautoUiTest.php in tests/
src/ FunctionalJavascript/ PathautoUiTest.php
File
- src/
Entity/ PathautoPattern.php, line 66
Namespace
Drupal\pathauto\EntityView source
class PathautoPattern extends ConfigEntityBase implements PathautoPatternInterface {
/**
* The Pathauto pattern ID.
*
* @var string
*/
protected $id;
/**
* The Pathauto pattern label.
*
* @var string
*/
protected $label;
/**
* The pattern type.
*
* A string denoting the type of pathauto pattern this is. For a node path
* this would be 'node', for users it would be 'user', and so on. This allows
* for arbitrary non-entity patterns to be possible if applicable.
*
* @var string
*/
protected $type;
/**
* @var \Drupal\Core\Plugin\DefaultSingleLazyPluginCollection
*/
protected $aliasTypeCollection;
/**
* A tokenized string for alias generation.
*
* @var string
*/
protected $pattern;
/**
* The plugin configuration for the selection criteria condition plugins.
*
* @var array
*/
protected $selection_criteria = [];
/**
* The selection logic for this pattern entity (either 'and' or 'or').
*
* @var string
*/
protected $selection_logic = 'and';
/**
* @var int
*/
protected $weight = 0;
/**
* @var array[]
* Keys are context tokens, and values are arrays with the following keys:
* - label (string|null, optional): The human-readable label of this
* relationship.
*/
protected $relationships = [];
/**
* The plugin collection that holds the selection criteria condition plugins.
*
* @var \Drupal\Component\Plugin\LazyPluginCollection
*/
protected $selectionConditionCollection;
/**
* {@inheritdoc}
*
* Not using core's default logic around ConditionPluginCollection since it
* incorrectly assumes no condition will ever be applied twice.
*/
public function preSave(EntityStorageInterface $storage) {
parent::preSave($storage);
$criteria = [];
foreach ($this
->getSelectionConditions() as $id => $condition) {
$criteria[$id] = $condition
->getConfiguration();
}
$this->selection_criteria = $criteria;
// Invalidate the static caches.
\Drupal::service('pathauto.generator')
->resetCaches();
}
/**
* {@inheritdoc}
*/
public static function postDelete(EntityStorageInterface $storage, array $entities) {
parent::postDelete($storage, $entities);
// Invalidate the static caches.
\Drupal::service('pathauto.generator')
->resetCaches();
}
/**
* {@inheritdoc}
*/
public function calculateDependencies() {
parent::calculateDependencies();
$this
->calculatePluginDependencies($this
->getAliasType());
foreach ($this
->getSelectionConditions() as $instance) {
$this
->calculatePluginDependencies($instance);
}
return $this
->getDependencies();
}
/**
* {@inheritdoc}
*/
public function getPattern() {
return $this->pattern;
}
/**
* {@inheritdoc}
*/
public function setPattern($pattern) {
$this->pattern = $pattern;
return $this;
}
/**
* {@inheritdoc}
*/
public function getType() {
return $this->type;
}
/**
* {@inheritdoc}
*/
public function getAliasType() {
if (!$this->aliasTypeCollection) {
$this->aliasTypeCollection = new DefaultSingleLazyPluginCollection(\Drupal::service('plugin.manager.alias_type'), $this
->getType(), [
'default' => $this
->getPattern(),
]);
}
return $this->aliasTypeCollection
->get($this
->getType());
}
/**
* {@inheritdoc}
*/
public function getWeight() {
return $this->weight;
}
/**
* {@inheritdoc}
*/
public function setWeight($weight) {
$this->weight = $weight;
return $this;
}
/**
* {@inheritdoc}
*/
public function getContexts() {
$contexts = $this
->getAliasType()
->getContexts();
foreach ($this
->getRelationships() as $token => $definition) {
/** @var \Drupal\ctools\TypedDataResolver $resolver */
$resolver = \Drupal::service('ctools.typed_data.resolver');
$context = $resolver
->convertTokenToContext($token, $contexts);
$context_definition = $context
->getContextDefinition();
if (!empty($definition['label'])) {
$context_definition
->setLabel($definition['label']);
}
$contexts[$token] = $context;
}
return $contexts;
}
/**
* {@inheritdoc}
*/
public function hasRelationship($token) {
return isset($this->relationships[$token]);
}
/**
* {@inheritdoc}
*/
public function addRelationship($token, $label = NULL) {
if (!$this
->hasRelationship($token)) {
$this->relationships[$token] = [
'label' => $label,
];
}
return $this;
}
/**
* {@inheritdoc}
*/
public function replaceRelationship($token, $label) {
if ($this
->hasRelationship($token)) {
$this->relationships[$token] = [
'label' => $label,
];
}
return $this;
}
/**
* {@inheritdoc}
*/
public function removeRelationship($token) {
unset($this->relationships[$token]);
return $this;
}
/**
* {@inheritdoc}
*/
public function getRelationships() {
return $this->relationships;
}
/**
* {@inheritdoc}
*/
public function getSelectionConditions() {
if (!$this->selectionConditionCollection) {
$this->selectionConditionCollection = new ConditionPluginCollection(\Drupal::service('plugin.manager.condition'), $this
->get('selection_criteria'));
}
return $this->selectionConditionCollection;
}
/**
* {@inheritdoc}
*/
public function addSelectionCondition(array $configuration) {
$configuration['uuid'] = $this
->uuidGenerator()
->generate();
$this
->getSelectionConditions()
->addInstanceId($configuration['uuid'], $configuration);
return $configuration['uuid'];
}
/**
* {@inheritdoc}
*/
public function getSelectionCondition($condition_id) {
return $this
->getSelectionConditions()
->get($condition_id);
}
/**
* {@inheritdoc}
*/
public function removeSelectionCondition($condition_id) {
$this
->getSelectionConditions()
->removeInstanceId($condition_id);
return $this;
}
/**
* {@inheritdoc}
*/
public function getSelectionLogic() {
return $this->selection_logic;
}
/**
* {@inheritdoc}
*/
public function applies($object) {
if ($this
->getAliasType()
->applies($object)) {
$definitions = $this
->getAliasType()
->getContextDefinitions();
if (count($definitions) > 1) {
throw new \Exception("Alias types do not support more than one context.");
}
$keys = array_keys($definitions);
// Set the context object on our Alias plugin before retrieving contexts.
$this
->getAliasType()
->setContextValue($keys[0], $object);
/** @var \Drupal\Core\Plugin\Context\ContextInterface[] $base_contexts */
$contexts = $this
->getContexts();
/** @var \Drupal\Core\Plugin\Context\ContextHandler $context_handler */
$context_handler = \Drupal::service('context.handler');
$conditions = $this
->getSelectionConditions();
foreach ($conditions as $condition) {
// As the context object is kept and only the value is switched out,
// it can over time grow to a huge number of cache contexts. Reset it
// if there are 100 cache tags to prevent cache tag merging getting too
// slow.
foreach ($condition
->getContextDefinitions() as $name => $context_definition) {
if (count($condition
->getContext($name)
->getCacheTags()) > 100) {
$condition
->setContext($name, new Context($context_definition));
}
}
if ($condition instanceof ContextAwarePluginInterface) {
try {
$context_handler
->applyContextMapping($condition, $contexts);
} catch (ContextException $e) {
watchdog_exception('pathauto', $e);
return FALSE;
}
}
$result = $condition
->execute();
if ($this
->getSelectionLogic() == 'and' && !$result) {
return FALSE;
}
elseif ($this
->getSelectionLogic() == 'or' && $result) {
return TRUE;
}
}
return TRUE;
}
return FALSE;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
CacheableDependencyTrait:: |
protected | property | Cache contexts. | |
CacheableDependencyTrait:: |
protected | property | Cache max-age. | |
CacheableDependencyTrait:: |
protected | property | Cache tags. | |
CacheableDependencyTrait:: |
protected | function | Sets cacheability; useful for value object constructors. | |
ConfigEntityBase:: |
private | property | Whether the config is being deleted by the uninstall process. | |
ConfigEntityBase:: |
protected | property | The language code of the entity's default language. | |
ConfigEntityBase:: |
protected | property | The original ID of the configuration entity. | |
ConfigEntityBase:: |
protected | property | The enabled/disabled status of the configuration entity. | 4 |
ConfigEntityBase:: |
protected | property | Third party entity settings. | |
ConfigEntityBase:: |
protected | property | Trust supplied data and not use configuration schema on save. | |
ConfigEntityBase:: |
protected | property | The UUID for this entity. | |
ConfigEntityBase:: |
protected | property | Information maintained by Drupal core about configuration. | |
ConfigEntityBase:: |
protected | function | Overrides \Drupal\Core\Entity\DependencyTrait:addDependency(). | |
ConfigEntityBase:: |
public | function |
Creates a duplicate of the entity. Overrides EntityBase:: |
1 |
ConfigEntityBase:: |
public | function |
Disables the configuration entity. Overrides ConfigEntityInterface:: |
1 |
ConfigEntityBase:: |
public | function |
Enables the configuration entity. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Returns the value of a property. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Returns the cache tags that should be used to invalidate caches. Overrides EntityBase:: |
1 |
ConfigEntityBase:: |
public | function |
Gets the configuration dependency name. Overrides EntityBase:: |
|
ConfigEntityBase:: |
protected static | function | Gets the configuration manager. | |
ConfigEntityBase:: |
public | function |
Gets the configuration target identifier for the entity. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Gets the configuration dependencies. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets the original ID. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
protected | function | Gets the typed config manager. | |
ConfigEntityBase:: |
public | function |
Gets whether on not the data is trusted. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
protected static | function |
Override to never invalidate the individual entities' cache tags; the
config system already invalidates them. Overrides EntityBase:: |
|
ConfigEntityBase:: |
protected | function |
Override to never invalidate the entity's cache tag; the config system
already invalidates it. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Checks whether this entity is installable. Overrides ConfigEntityInterface:: |
2 |
ConfigEntityBase:: |
public | function |
Overrides Entity::isNew(). Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Deprecated way of generating a link to the entity. See toLink(). Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface:: |
7 |
ConfigEntityBase:: |
public static | function |
Acts on entities before they are deleted and before hooks are invoked. Overrides EntityBase:: |
8 |
ConfigEntityBase:: |
public | function |
Saves an entity permanently. Overrides EntityBase:: |
1 |
ConfigEntityBase:: |
public | function |
Sets the value of a property. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Sets the original ID. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Sets the status of the configuration entity. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function | ||
ConfigEntityBase:: |
public static | function | Helper callback for uasort() to sort configuration entities by weight and label. | 6 |
ConfigEntityBase:: |
public | function |
Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface:: |
4 |
ConfigEntityBase:: |
public | function |
Gets an array of all property values. Overrides EntityBase:: |
2 |
ConfigEntityBase:: |
public | function |
Gets the URL object for the entity. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Sets that the data should be trusted. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Unsets a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets the public URL for this entity. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Gets the URL object for the entity. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Constructs an Entity object. Overrides EntityBase:: |
10 |
ConfigEntityBase:: |
public | function |
Overrides EntityBase:: |
4 |
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 | Aliased as: traitSleep | 1 |
DependencySerializationTrait:: |
public | function | 2 | |
DependencyTrait:: |
protected | property | The object's dependencies. | |
DependencyTrait:: |
protected | function | Adds multiple dependencies. | |
DependencyTrait:: |
protected | function | Adds a dependency. Aliased as: addDependencyTrait | |
EntityBase:: |
protected | property | Boolean indicating whether the entity should be forced to be new. | |
EntityBase:: |
protected | property | The entity type. | |
EntityBase:: |
protected | property | A typed data object wrapping this entity. | |
EntityBase:: |
public | function |
Checks data value access. Overrides AccessibleInterface:: |
1 |
EntityBase:: |
public | function |
Gets the bundle of the entity. Overrides EntityInterface:: |
1 |
EntityBase:: |
public static | function |
Constructs a new entity object, without permanently saving it. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Deletes an entity permanently. Overrides EntityInterface:: |
2 |
EntityBase:: |
public | function |
Enforces an entity to be new. Overrides EntityInterface:: |
|
EntityBase:: |
protected | function | Gets the entity manager. | |
EntityBase:: |
protected | function | Gets the entity type bundle info service. | |
EntityBase:: |
protected | function | Gets the entity type manager. | |
EntityBase:: |
public | function |
The cache contexts associated with this object. Overrides CacheableDependencyTrait:: |
|
EntityBase:: |
public | function |
The maximum age for which this object may be cached. Overrides CacheableDependencyTrait:: |
|
EntityBase:: |
public | function |
The cache tags associated with this object. Overrides CacheableDependencyTrait:: |
|
EntityBase:: |
public | function |
Gets the key that is used to store configuration dependencies. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets the entity type definition. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets the ID of the type of the entity. Overrides EntityInterface:: |
|
EntityBase:: |
protected | function | The list cache tags to invalidate for this entity. | |
EntityBase:: |
public | function |
Gets a typed data object for this entity object. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Indicates if a link template exists for a given key. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets the identifier. Overrides EntityInterface:: |
11 |
EntityBase:: |
public | function |
Gets the label of the entity. Overrides EntityInterface:: |
6 |
EntityBase:: |
public | function |
Gets the language of the entity. Overrides EntityInterface:: |
1 |
EntityBase:: |
protected | function | Gets the language manager. | |
EntityBase:: |
protected | function | Gets an array link templates. | 1 |
EntityBase:: |
public static | function |
Loads an entity. Overrides EntityInterface:: |
|
EntityBase:: |
public static | function |
Loads one or more entities. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Acts on a created entity before hooks are invoked. Overrides EntityInterface:: |
4 |
EntityBase:: |
public static | function |
Acts on loaded entities. Overrides EntityInterface:: |
2 |
EntityBase:: |
public | function |
Acts on a saved entity before the insert or update hook is invoked. Overrides EntityInterface:: |
14 |
EntityBase:: |
public static | function |
Changes the values of an entity before it is created. Overrides EntityInterface:: |
5 |
EntityBase:: |
public | function |
Gets a list of entities referenced by this entity. Overrides EntityInterface:: |
1 |
EntityBase:: |
public | function |
Generates the HTML for a link to this entity. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets a list of URI relationships supported by this entity. Overrides EntityInterface:: |
|
EntityBase:: |
protected | function | Gets an array of placeholders for this entity. | 2 |
EntityBase:: |
public | function |
Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface:: |
1 |
EntityBase:: |
protected | function | Gets the UUID generator. | |
PathautoPattern:: |
protected | property | ||
PathautoPattern:: |
protected | property | The Pathauto pattern ID. | |
PathautoPattern:: |
protected | property | The Pathauto pattern label. | |
PathautoPattern:: |
protected | property | A tokenized string for alias generation. | |
PathautoPattern:: |
protected | property | Keys are context tokens, and values are arrays with the following keys: | |
PathautoPattern:: |
protected | property | The plugin collection that holds the selection criteria condition plugins. | |
PathautoPattern:: |
protected | property | The plugin configuration for the selection criteria condition plugins. | |
PathautoPattern:: |
protected | property | The selection logic for this pattern entity (either 'and' or 'or'). | |
PathautoPattern:: |
protected | property | The pattern type. | |
PathautoPattern:: |
protected | property | ||
PathautoPattern:: |
public | function |
Adds a relationship. Overrides PathautoPatternInterface:: |
|
PathautoPattern:: |
public | function |
Adds selection criteria. Overrides PathautoPatternInterface:: |
|
PathautoPattern:: |
public | function |
Determines if this pattern can apply a given object. Overrides PathautoPatternInterface:: |
|
PathautoPattern:: |
public | function |
Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityBase:: |
|
PathautoPattern:: |
public | function |
Overrides PathautoPatternInterface:: |
|
PathautoPattern:: |
public | function |
Returns the contexts of this pattern. Overrides PathautoPatternInterface:: |
|
PathautoPattern:: |
public | function |
Get the tokenized pattern used during alias generation. Overrides PathautoPatternInterface:: |
|
PathautoPattern:: |
public | function |
Returns a list of relationships. Overrides PathautoPatternInterface:: |
|
PathautoPattern:: |
public | function |
Gets selection criteria by condition id. Overrides PathautoPatternInterface:: |
|
PathautoPattern:: |
public | function |
Gets the selection condition collection. Overrides PathautoPatternInterface:: |
|
PathautoPattern:: |
public | function |
Gets the selection logic used by the criteria (ie. "and" or "or"). Overrides PathautoPatternInterface:: |
|
PathautoPattern:: |
public | function |
Gets the type of this pattern. Overrides PathautoPatternInterface:: |
|
PathautoPattern:: |
public | function |
Gets the weight of this pattern (compared to other patterns of this type). Overrides PathautoPatternInterface:: |
|
PathautoPattern:: |
public | function |
Returns whether a relationship exists. Overrides PathautoPatternInterface:: |
|
PathautoPattern:: |
public static | function |
Acts on deleted entities before the delete hook is invoked. Overrides EntityBase:: |
|
PathautoPattern:: |
public | function |
Not using core's default logic around ConditionPluginCollection since it
incorrectly assumes no condition will ever be applied twice. Overrides ConfigEntityBase:: |
|
PathautoPattern:: |
public | function |
Removes a relationship. Overrides PathautoPatternInterface:: |
|
PathautoPattern:: |
public | function |
Removes selection criteria by condition id. Overrides PathautoPatternInterface:: |
|
PathautoPattern:: |
public | function |
Replaces a relationship. Overrides PathautoPatternInterface:: |
|
PathautoPattern:: |
public | function |
Set the tokenized pattern to use during alias generation. Overrides PathautoPatternInterface:: |
|
PathautoPattern:: |
public | function |
Sets the weight of this pattern (compared to other patterns of this type). Overrides PathautoPatternInterface:: |
|
PluginDependencyTrait:: |
protected | function | Calculates and adds dependencies of a specific plugin instance. | 1 |
PluginDependencyTrait:: |
protected | function | Calculates and returns dependencies of a specific plugin instance. | |
PluginDependencyTrait:: |
protected | function | Wraps the module handler. | 1 |
PluginDependencyTrait:: |
protected | function | Wraps the theme handler. | 1 |
RefinableCacheableDependencyTrait:: |
public | function | 1 | |
RefinableCacheableDependencyTrait:: |
public | function | ||
RefinableCacheableDependencyTrait:: |
public | function | ||
RefinableCacheableDependencyTrait:: |
public | function | ||
SynchronizableEntityTrait:: |
protected | property | Whether this entity is being created, updated or deleted through a synchronization process. | |
SynchronizableEntityTrait:: |
public | function | ||
SynchronizableEntityTrait:: |
public | function |