class UrlAliasBase
Base class for the url_alias source plugins.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\DependencyInjection\AutowiredInstanceTrait, \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
- class \Drupal\migrate\Plugin\migrate\source\SourcePluginBase implements \Drupal\migrate\Plugin\MigrateSourceInterface, \Drupal\migrate\Event\RollbackAwareInterface extends \Drupal\Core\Plugin\PluginBase
- class \Drupal\migrate\Plugin\migrate\source\SqlBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\migrate\Plugin\RequirementsInterface extends \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
- class \Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase implements \Drupal\Component\Plugin\DependentPluginInterface uses \Drupal\Core\Entity\DependencyTrait extends \Drupal\migrate\Plugin\migrate\source\SqlBase
- class \Drupal\path\Plugin\migrate\source\UrlAliasBase extends \Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase
- class \Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase implements \Drupal\Component\Plugin\DependentPluginInterface uses \Drupal\Core\Entity\DependencyTrait extends \Drupal\migrate\Plugin\migrate\source\SqlBase
- class \Drupal\migrate\Plugin\migrate\source\SqlBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\migrate\Plugin\RequirementsInterface extends \Drupal\migrate\Plugin\migrate\source\SourcePluginBase
- class \Drupal\migrate\Plugin\migrate\source\SourcePluginBase implements \Drupal\migrate\Plugin\MigrateSourceInterface, \Drupal\migrate\Event\RollbackAwareInterface extends \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\DependencyInjection\AutowiredInstanceTrait, \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
Expanded class hierarchy of UrlAliasBase
2 files declare their use of UrlAliasBase
- UrlAlias.php in core/
modules/ path/ src/ Plugin/ migrate/ source/ d6/ UrlAlias.php - UrlAlias.php in core/
modules/ path/ src/ Plugin/ migrate/ source/ d7/ UrlAlias.php
File
-
core/
modules/ path/ src/ Plugin/ migrate/ source/ UrlAliasBase.php, line 10
Namespace
Drupal\path\Plugin\migrate\sourceView source
abstract class UrlAliasBase extends DrupalSqlBase {
/**
* {@inheritdoc}
*/
public function query() {
// The order of the migration is significant since
// \Drupal\path_alias\AliasRepository::lookupPathAlias() orders by pid
// before returning a result. Postgres does not automatically order by
// primary key therefore we need to add a specific order by.
return $this->select('url_alias', 'ua')
->fields('ua')
->orderBy('pid');
}
/**
* {@inheritdoc}
*/
public function fields() {
return [
'pid' => $this->t('The numeric identifier of the path alias.'),
'language' => $this->t('The language code of the URL alias.'),
];
}
/**
* {@inheritdoc}
*/
public function getIds() {
$ids['pid']['type'] = 'integer';
return $ids;
}
}
Members
| Title Sort descending | Deprecated | Modifiers | Object type | Summary | Overriden Title | Overrides |
|---|---|---|---|---|---|---|
| AutowiredInstanceTrait::createInstanceAutowired | public static | function | Instantiates a new instance of the implementing class using autowiring. | |||
| 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::__wakeup | public | function | 2 | |||
| DependencyTrait::$dependencies | protected | property | The object's dependencies. | |||
| DependencyTrait::addDependencies | protected | function | Adds multiple dependencies. | |||
| DependencyTrait::addDependency | protected | function | Adds a dependency. | |||
| DrupalSqlBase::$entityTypeManager | protected | property | The entity type manager. | |||
| DrupalSqlBase::$requirements | protected | property | If the source provider is missing. | |||
| DrupalSqlBase::$systemData | protected | property | The contents of the system table. | |||
| DrupalSqlBase::calculateDependencies | public | function | Calculates dependencies for the configured plugin. | Overrides DependentPluginInterface::calculateDependencies | ||
| DrupalSqlBase::checkRequirements | public | function | Checks if requirements for this plugin are OK. | Overrides SqlBase::checkRequirements | 4 | |
| DrupalSqlBase::create | public static | function | Instantiates a new instance of the implementing class using autowiring. | Overrides SqlBase::create | 2 | |
| DrupalSqlBase::getModuleSchemaVersion | protected | function | Retrieves a module schema_version from the source Drupal database. | |||
| DrupalSqlBase::getSourceModule | public | function | Gets the source module providing the source data. | Overrides SourcePluginBase::getSourceModule | ||
| DrupalSqlBase::getSystemData | public | function | Retrieves all system data information from the source Drupal database. | |||
| DrupalSqlBase::moduleExists | protected | function | Checks if a given module is enabled in the source Drupal database. | |||
| DrupalSqlBase::variableGet | protected | function | Reads a variable from a source Drupal database. | |||
| DrupalSqlBase::__construct | public | function | Constructs a \Drupal\Component\Plugin\PluginBase object. | Overrides SqlBase::__construct | 6 | |
| MessengerTrait::$messenger | protected | property | The messenger. | 25 | ||
| MessengerTrait::messenger | public | function | Gets the messenger. | 25 | ||
| MessengerTrait::setMessenger | public | function | Sets the messenger. | |||
| MigrateSourceInterface::NOT_COUNTABLE | constant | Indicates that the source is not countable. | ||||
| 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 | Overrides DerivativeInspectionInterface::getBaseId | |||
| PluginBase::getDerivativeId | public | function | Overrides DerivativeInspectionInterface::getDerivativeId | |||
| PluginBase::getPluginDefinition | public | function | Overrides PluginInspectionInterface::getPluginDefinition | 2 | ||
| PluginBase::getPluginId | public | function | Overrides PluginInspectionInterface::getPluginId | |||
| PluginBase::isConfigurable | Deprecated | public | function | Determines if the plugin is configurable. | ||
| SourcePluginBase::$cache | protected | property | The backend cache. | |||
| SourcePluginBase::$cacheCounts | protected | property | Whether this instance should cache the source count. | 1 | ||
| SourcePluginBase::$cacheKey | protected | property | Key to use for caching counts. | |||
| SourcePluginBase::$currentRow | protected | property | The current row from the query. | |||
| SourcePluginBase::$currentSourceIds | protected | property | The primary key of the current row. | |||
| SourcePluginBase::$highWaterProperty | protected | property | Information on the property used as the high-water mark. | |||
| SourcePluginBase::$highWaterStorage | protected | property | The key-value storage for the high-water value. | |||
| SourcePluginBase::$idMap | protected | property | The migration ID map. | |||
| SourcePluginBase::$iterator | protected | property | The iterator to iterate over the source rows. | |||
| SourcePluginBase::$mapRowAdded | protected | property | Flags whether source plugin will read the map row and add to data row. | |||
| SourcePluginBase::$migration | protected | property | The entity migration object. | |||
| SourcePluginBase::$moduleHandler | protected | property | The module handler service. | 2 | ||
| SourcePluginBase::$originalHighWater | protected | property | The high water mark at the beginning of the import operation. | |||
| SourcePluginBase::$skipCount | protected | property | Whether this instance should not attempt to count the source. | 1 | ||
| SourcePluginBase::$trackChanges | protected | property | Flags whether to track changes to incoming data. | 1 | ||
| SourcePluginBase::aboveHighWater | protected | function | Check if the incoming data is newer than what we've previously imported. | |||
| SourcePluginBase::count | public | function | Gets the source count. | 3 | ||
| SourcePluginBase::current | public | function | ||||
| SourcePluginBase::getCache | protected | function | Gets the cache object. | |||
| SourcePluginBase::getCurrentIds | public | function | Gets the currentSourceIds data member. | |||
| SourcePluginBase::getHighWater | protected | function | The current value of the high water mark. | |||
| SourcePluginBase::getHighWaterField | protected | function | Get the name of the field used as the high watermark. | |||
| SourcePluginBase::getHighWaterProperty | protected | function | Get information on the property used as the high watermark. | |||
| SourcePluginBase::getHighWaterStorage | protected | function | Get the high water storage object. | |||
| SourcePluginBase::getIterator | protected | function | Returns the iterator that will yield the row arrays to be processed. | |||
| SourcePluginBase::getModuleHandler | protected | function | Gets the module handler. | |||
| SourcePluginBase::key | public | function | Gets the iterator key. | |||
| SourcePluginBase::next | public | function | ||||
| SourcePluginBase::postRollback | public | function | Overrides RollbackAwareInterface::postRollback | |||
| SourcePluginBase::prepareRow | public | function | Overrides MigrateSourceInterface::prepareRow | 50 | ||
| SourcePluginBase::preRollback | public | function | Overrides RollbackAwareInterface::preRollback | |||
| SourcePluginBase::rowChanged | protected | function | Checks if the incoming row has changed since our last import. | |||
| SourcePluginBase::saveHighWater | protected | function | Save the new high water mark. | |||
| SourcePluginBase::valid | public | function | Checks whether the iterator is currently valid. | |||
| SqlBase::$batch | protected | property | The count of the number of batches run. | |||
| SqlBase::$batchSize | protected | property | Number of records to fetch from the database during each batch. | |||
| SqlBase::$database | protected | property | The database object. | 1 | ||
| SqlBase::$query | protected | property | The query string. | 81 | ||
| SqlBase::$state | protected | property | State service for retrieving database info. | |||
| SqlBase::doCount | protected | function | Gets the source count using countQuery(). | Overrides SourcePluginBase::doCount | 6 | |
| SqlBase::fetchNextBatch | protected | function | Prepares query for the next set of data from the source database. | |||
| SqlBase::fetchNextRow | protected | function | Position the iterator to the following row. | Overrides SourcePluginBase::fetchNextRow | ||
| SqlBase::getDatabase | public | function | Gets the database connection object. | 2 | ||
| SqlBase::initializeIterator | protected | function | Overrides SourcePluginBase::initializeIterator | 18 | ||
| SqlBase::mapJoinable | protected | function | Checks if we can join against the map table. | 1 | ||
| SqlBase::prepareQuery | protected | function | Adds tags and metadata to the query. | 1 | ||
| SqlBase::rewind | public | function | Overrides SourcePluginBase::rewind | |||
| SqlBase::select | protected | function | Wrapper for database select. | |||
| SqlBase::setUpDatabase | protected | function | Gets a connection to the referenced database. | |||
| SqlBase::__sleep | public | function | Overrides DependencySerializationTrait::__sleep | |||
| SqlBase::__toString | public | function | Prints the query string when the object is used as a string. | Overrides MigrateSourceInterface::__toString | ||
| StringTranslationTrait::$stringTranslation | protected | property | The string translation service. | 3 | ||
| 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. | 1 | ||
| UrlAliasBase::fields | public | function | Overrides MigrateSourceInterface::fields | 2 | ||
| UrlAliasBase::getIds | public | function | Overrides MigrateSourceInterface::getIds | |||
| UrlAliasBase::query | public | function | Overrides SqlBase::query |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.