class MenuLink
Drupal menu link source from database.
Plugin annotation
@MigrateSource(
id = "menu_link",
source_module = "menu"
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses \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\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\Component\Plugin\DependentPluginInterface uses \Drupal\Core\Entity\DependencyTrait, \Drupal\Core\DependencyInjection\DeprecatedServicePropertyTrait extends \Drupal\migrate\Plugin\migrate\source\SqlBase
- class \Drupal\menu_link_content\Plugin\migrate\source\MenuLink extends \Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase
- class \Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\Component\Plugin\DependentPluginInterface uses \Drupal\Core\Entity\DependencyTrait, \Drupal\Core\DependencyInjection\DeprecatedServicePropertyTrait 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\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
Expanded class hierarchy of MenuLink
1 file declares its use of MenuLink
- MenuLinkTranslation.php in core/
modules/ menu_link_content/ src/ Plugin/ migrate/ source/ d6/ MenuLinkTranslation.php
File
-
core/
modules/ menu_link_content/ src/ Plugin/ migrate/ source/ MenuLink.php, line 17
Namespace
Drupal\menu_link_content\Plugin\migrate\sourceView source
class MenuLink extends DrupalSqlBase {
/**
* {@inheritdoc}
*/
public function query() {
$query = $this->select('menu_links', 'ml')
->fields('ml');
$and = $query->andConditionGroup()
->condition('ml.module', 'menu')
->condition('ml.router_path', [
'admin/build/menu-customize/%',
'admin/structure/menu/manage/%',
], 'NOT IN');
$condition = $query->orConditionGroup()
->condition('ml.customized', 1)
->condition($and);
$query->condition($condition);
$query->leftJoin('menu_links', 'pl', 'ml.plid = pl.mlid');
$query->addField('pl', 'link_path', 'parent_link_path');
$query->orderBy('ml.depth');
$query->orderby('ml.mlid');
return $query;
}
/**
* {@inheritdoc}
*/
public function fields() {
return [
'menu_name' => t("The menu name. All links with the same menu name (such as 'navigation') are part of the same menu."),
'mlid' => t('The menu link ID (mlid) is the integer primary key.'),
'plid' => t('The parent link ID (plid) is the mlid of the link above in the hierarchy, or zero if the link is at the top level in its menu.'),
'link_path' => t('The Drupal path or external path this link points to.'),
'router_path' => t('For links corresponding to a Drupal path (external = 0), this connects the link to a {menu_router}.path for joins.'),
'link_title' => t('The text displayed for the link, which may be modified by a title callback stored in {menu_router}.'),
'options' => t('A serialized array of options to set on the URL, such as a query string or HTML attributes.'),
'module' => t('The name of the module that generated this link.'),
'hidden' => t('A flag for whether the link should be rendered in menus. (1 = a disabled menu item that may be shown on admin screens, -1 = a menu callback, 0 = a normal, visible link)'),
'external' => t('A flag to indicate if the link points to a full URL starting with a protocol, like http:// (1 = external, 0 = internal).'),
'has_children' => t('Flag indicating whether any links have this link as a parent (1 = children exist, 0 = no children).'),
'expanded' => t('Flag for whether this link should be rendered as expanded in menus - expanded links always have their child links displayed, instead of only when the link is in the active trail (1 = expanded, 0 = not expanded)'),
'weight' => t('Link weight among links in the same menu at the same depth.'),
'depth' => t('The depth relative to the top level. A link with plid == 0 will have depth == 1.'),
'customized' => t('A flag to indicate that the user has manually created or edited the link (1 = customized, 0 = not customized).'),
'p1' => t('The first mlid in the materialized path. If N = depth, then pN must equal the mlid. If depth > 1 then p(N-1) must equal the plid. All pX where X > depth must equal zero. The columns p1 .. p9 are also called the parents.'),
'p2' => t('The second mlid in the materialized path. See p1.'),
'p3' => t('The third mlid in the materialized path. See p1.'),
'p4' => t('The fourth mlid in the materialized path. See p1.'),
'p5' => t('The fifth mlid in the materialized path. See p1.'),
'p6' => t('The sixth mlid in the materialized path. See p1.'),
'p7' => t('The seventh mlid in the materialized path. See p1.'),
'p8' => t('The eighth mlid in the materialized path. See p1.'),
'p9' => t('The ninth mlid in the materialized path. See p1.'),
'updated' => t('Flag that indicates that this link was generated during the update from Drupal 5.'),
];
}
/**
* {@inheritdoc}
*/
public function prepareRow(Row $row) {
$row->setSourceProperty('options', unserialize($row->getSourceProperty('options')));
$row->setSourceProperty('enabled', !$row->getSourceProperty('hidden'));
$row->setSourceProperty('description', Unicode::truncate($row->getSourceProperty('options/attributes/title'), 255));
return parent::prepareRow($row);
}
/**
* {@inheritdoc}
*/
public function getIds() {
$ids['mlid']['type'] = 'integer';
$ids['mlid']['alias'] = 'ml';
return $ids;
}
}
Members
| Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
|---|---|---|---|---|---|
| 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 | ||
| DependencyTrait::$dependencies | protected | property | The object's dependencies. | ||
| DependencyTrait::addDependencies | protected | function | Adds multiple dependencies. | ||
| DependencyTrait::addDependency | protected | function | Adds a dependency. | ||
| DeprecatedServicePropertyTrait::__get | public | function | Allows to access deprecated/removed properties. | ||
| DrupalSqlBase::$deprecatedProperties | protected | property | 1 | ||
| 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 | 1 |
| DrupalSqlBase::checkRequirements | public | function | Checks if requirements for this plugin are OK. | Overrides SqlBase::checkRequirements | 2 |
| DrupalSqlBase::create | public static | function | Creates an instance of the plugin. | Overrides SqlBase::create | 3 |
| DrupalSqlBase::getModuleSchemaVersion | protected | function | Retrieves a module schema_version from the source Drupal database. | ||
| 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 |
| MenuLink::fields | public | function | Returns available fields on the source. | Overrides MigrateSourceInterface::fields | 1 |
| MenuLink::getIds | public | function | Defines the source fields uniquely identifying a source row. | Overrides MigrateSourceInterface::getIds | 1 |
| MenuLink::prepareRow | public | function | Adds additional data to the row. | Overrides SourcePluginBase::prepareRow | 1 |
| MenuLink::query | public | function | Overrides SqlBase::query | 1 | |
| 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. | ||
| 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::current | public | function | |||
| SourcePluginBase::doCount | protected | function | Gets the source count checking if the source is countable or using the iterator_count function. |
1 | |
| 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. | 1 | |
| 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::getSourceModule | public | function | Gets the source module providing the source data. | Overrides MigrateSourceInterface::getSourceModule | |
| SourcePluginBase::key | public | function | Gets the iterator key. | ||
| SourcePluginBase::next | public | function | The migration iterates over rows returned by the source plugin. This method determines the next row which will be processed and imported into the system. |
||
| SourcePluginBase::postRollback | public | function | Performs post-rollback tasks. | Overrides RollbackAwareInterface::postRollback | |
| SourcePluginBase::preRollback | public | function | Performs pre-rollback tasks. | Overrides RollbackAwareInterface::preRollback | |
| SourcePluginBase::rewind | public | function | Rewinds the iterator. | ||
| 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. | 82 | |
| SqlBase::$state | protected | property | State service for retrieving database info. | ||
| SqlBase::count | public | function | Gets the source count. | Overrides SourcePluginBase::count | 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 | Initializes the iterator with the source data. | Overrides SourcePluginBase::initializeIterator | 20 |
| 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. | ||
| SqlBase::select | protected | function | Wrapper for database select. | ||
| SqlBase::setUpDatabase | protected | function | Gets a connection to the referenced database. | ||
| 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. | 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. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.