class CommentType
Drupal 7 comment type source from database.
Plugin annotation
@MigrateSource(
id = "d7_comment_type",
source_module = "comment"
)
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\comment\Plugin\migrate\source\d7\CommentType 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 CommentType
Deprecated
in drupal:8.4.0 and is removed from drupal:9.0.0. Use \Drupal\node\Plugin\migrate\source\d7\NodeType instead.
File
-
core/
modules/ comment/ src/ Plugin/ migrate/ source/ d7/ CommentType.php, line 22
Namespace
Drupal\comment\Plugin\migrate\source\d7View source
class CommentType extends DrupalSqlBase {
/**
* A map of D7 node types to their labels.
*
* @var string[]
*/
protected $nodeTypes = [];
/**
* {@inheritdoc}
*/
public function query() {
return $this->select('field_config_instance', 'fci')
->distinct()
->fields('fci', [
'bundle',
])
->condition('fci.entity_type', 'comment');
}
/**
* {@inheritdoc}
*/
protected function initializeIterator() {
$this->nodeTypes = $this->select('node_type', 'nt')
->fields('nt', [
'type',
'name',
])
->execute()
->fetchAllKeyed();
return parent::initializeIterator();
}
/**
* {@inheritdoc}
*/
public function prepareRow(Row $row) {
$node_type = substr($row->getSourceProperty('bundle'), 13);
$row->setSourceProperty('node_type', $node_type);
$row->setSourceProperty('default_mode', $this->variableGet("comment_default_mode_{$node_type}", 1));
$row->setSourceProperty('per_page', $this->variableGet("comment_default_per_page_{$node_type}", 50));
$row->setSourceProperty('anonymous', $this->variableGet("comment_anonymous_{$node_type}", FALSE));
$row->setSourceProperty('form_location', $this->variableGet("comment_form_location_{$node_type}", CommentItemInterface::FORM_BELOW));
$row->setSourceProperty('preview', $this->variableGet("comment_preview_{$node_type}", TRUE));
$row->setSourceProperty('subject', $this->variableGet("comment_subject_field_{$node_type}", TRUE));
$label = $this->t('@node_type comment', [
'@node_type' => $this->nodeTypes[$node_type],
]);
$row->setSourceProperty('label', $label);
return parent::prepareRow($row);
}
/**
* {@inheritdoc}
*/
public function fields() {
return [
'label' => $this->t('The label of the comment type.'),
'bundle' => $this->t('Bundle ID of the comment type.'),
'node_type' => $this->t('The node type to which this comment type is attached.'),
'default_mode' => $this->t('Default comment mode.'),
'per_page' => $this->t('Number of comments visible per page.'),
'anonymous' => $this->t('Whether anonymous comments are allowed.'),
'form_location' => $this->t('Location of the comment form.'),
'preview' => $this->t('Whether previews are enabled for the comment type.'),
'subject' => $this->t('Whether a subject field is enabled for the comment type.'),
];
}
/**
* {@inheritdoc}
*/
public function getIds() {
return [
'bundle' => [
'type' => 'string',
],
];
}
}
Members
| Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
|---|---|---|---|---|---|
| CommentType::$nodeTypes | protected | property | A map of D7 node types to their labels. | ||
| CommentType::fields | public | function | Returns available fields on the source. | Overrides MigrateSourceInterface::fields | |
| CommentType::getIds | public | function | Defines the source fields uniquely identifying a source row. | Overrides MigrateSourceInterface::getIds | |
| CommentType::initializeIterator | protected | function | Initializes the iterator with the source data. | Overrides SqlBase::initializeIterator | |
| CommentType::prepareRow | public | function | Adds additional data to the row. | Overrides SourcePluginBase::prepareRow | |
| CommentType::query | public | function | Overrides SqlBase::query | ||
| 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 |
| 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::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.