class CommentType

Same name in this branch
  1. 11.x core/modules/comment/src/Entity/CommentType.php \Drupal\comment\Entity\CommentType
Same name and namespace in other branches
  1. 9 core/modules/comment/src/Entity/CommentType.php \Drupal\comment\Entity\CommentType
  2. 9 core/modules/comment/src/Plugin/migrate/source/CommentType.php \Drupal\comment\Plugin\migrate\source\CommentType
  3. 8.9.x core/modules/comment/src/Entity/CommentType.php \Drupal\comment\Entity\CommentType
  4. 8.9.x core/modules/comment/src/Plugin/migrate/source/d7/CommentType.php \Drupal\comment\Plugin\migrate\source\d7\CommentType
  5. 10 core/modules/comment/src/Entity/CommentType.php \Drupal\comment\Entity\CommentType
  6. 10 core/modules/comment/src/Plugin/migrate/source/CommentType.php \Drupal\comment\Plugin\migrate\source\CommentType

Drupal 6/7 comment types source from database.

For available configuration keys, refer to the parent classes.

Plugin annotation


@MigrateSource(
  id = "comment_type",
  source_module = "comment"
)

Attributes

#[ConfigEntityType(id: 'comment_type', label: new TranslatableMarkup('Comment type'), label_singular: new TranslatableMarkup('comment type'), label_plural: new TranslatableMarkup('comment types'), config_prefix: 'type', entity_keys: ['id' => 'id', 'label' => 'label'], handlers: ['form' => ['default' => CommentTypeForm::class, 'add' => CommentTypeForm::class, 'edit' => CommentTypeForm::class, 'delete' => CommentTypeDeleteForm::class], 'route_provider' => ['permissions' => EntityPermissionsRouteProvider::class], 'list_builder' => CommentTypeListBuilder::class], links: ['delete-form' => '/admin/structure/comment/manage/{comment_type}/delete', 'edit-form' => '/admin/structure/comment/manage/{comment_type}', 'add-form' => '/admin/structure/comment/types/add', 'entity-permissions-form' => '/admin/structure/comment/manage/{comment_type}/permissions', 'collection' => '/admin/structure/comment'], admin_permission: 'administer comment types', bundle_of: 'comment', label_count: ['singular' => '@count comment type', 'plural' => '@count comment types'], config_export: ['id', 'label', 'target_entity_type_id', 'description'])]

Hierarchy

Expanded class hierarchy of CommentType

See also

\Drupal\migrate\Plugin\migrate\source\SqlBase

\Drupal\migrate\Plugin\migrate\source\SourcePluginBase

File

core/modules/comment/src/Plugin/migrate/source/CommentType.php, line 22

Namespace

Drupal\comment\Plugin\migrate\source
View source
class CommentType extends DrupalSqlBase {
  
  /**
   * {@inheritdoc}
   */
  public function query() {
    return $this->select('node_type', 't')
      ->fields('t', [
      'type',
      'name',
    ]);
  }
  
  /**
   * {@inheritdoc}
   */
  public function prepareRow(Row $row) {
    $node_type = $row->getSourceProperty('type');
    foreach (array_keys($this->getCommentFields()) as $field) {
      $row->setSourceProperty($field, $this->variableGet($field . '_' . $node_type, NULL));
    }
    return parent::prepareRow($row);
  }
  
  /**
   * {@inheritdoc}
   */
  public function fields() {
    return [
      'name' => $this->t('Human name of the parent node type.'),
      'type' => $this->t('Machine name of the parent node type.'),
    ] + $this->getCommentFields();
  }
  
  /**
   * Returns the fields containing comment settings for each node type.
   *
   * @return string[]
   *   An associative array of field descriptions, keyed by field.
   */
  protected function getCommentFields() {
    return [
      'comment' => $this->t('Default comment setting'),
      'comment_default_mode' => $this->t('Default display mode'),
      'comment_default_per_page' => $this->t('Default comments per page'),
      'comment_anonymous' => $this->t('Anonymous commenting'),
      'comment_subject_field' => $this->t('Comment subject field'),
      'comment_preview' => $this->t('Preview comment'),
      'comment_form_location' => $this->t('Location of comment submission form'),
    ];
  }
  
  /**
   * {@inheritdoc}
   */
  public function getIds() {
    $ids['type']['type'] = 'string';
    return $ids;
  }
  
  /**
   * {@inheritdoc}
   */
  public function checkRequirements() {
    parent::checkRequirements();
    if (!$this->moduleExists('node')) {
      // Drupal 6 and Drupal 7 comment configuration migrations migrate comment
      // types and comment fields for node comments only.
      throw new RequirementsException('The node module is not enabled in the source site.', [
        'source_module_additional' => 'node',
      ]);
    }
  }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
CommentType::checkRequirements public function Checks if requirements for this plugin are OK. Overrides DrupalSqlBase::checkRequirements
CommentType::fields public function Returns available fields on the source. Overrides MigrateSourceInterface::fields
CommentType::getCommentFields protected function Returns the fields containing comment settings for each node type.
CommentType::getIds public function Defines the source fields uniquely identifying a source row. Overrides MigrateSourceInterface::getIds
CommentType::prepareRow public function Adds additional data to the row. Overrides SourcePluginBase::prepareRow
CommentType::query public function Prepares query object to retrieve data from the source database. Overrides SqlBase::query
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::create public static function Creates an instance of the plugin. 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 Overrides SqlBase::__construct 6
MigrateSourceInterface::NOT_COUNTABLE constant Indicates that the source is not countable.
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 7
PluginInspectionInterface::getPluginId public function Gets the plugin ID of the plugin instance. 3
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 Performs post-rollback tasks. Overrides RollbackAwareInterface::postRollback
SourcePluginBase::preRollback public function Performs pre-rollback tasks. 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. 85
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 Initializes the iterator with the source data. 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 Rewinds the iterator. 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
SqlBase::__toString public function Prints the query string when the object is used as a string. Overrides MigrateSourceInterface::__toString

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.