class CommentType in Zircon Profile 8

Drupal 7 comment type source from database.

Plugin annotation

@MigrateSource(
  id = "d7_comment_type",
  source_provider = "comment"
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, StringTranslationTrait
    • class \Drupal\migrate\Plugin\migrate\source\SourcePluginBase implements MigrateSourceInterface
      • class \Drupal\migrate\Plugin\migrate\source\SqlBase implements ContainerFactoryPluginInterface
        • class \Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase implements DependentPluginInterface, ContainerFactoryPluginInterface, RequirementsInterface uses DependencyTrait
          • class \Drupal\comment\Plugin\migrate\source\d7\CommentType

File

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

Contains \Drupal\comment\Plugin\migrate\source\d7\CommentType.

Namespace

Drupal\comment\Plugin\migrate\source\d7

class CommentType extends DrupalSqlBase {

  /**
   * A map of D7 node types to their labels.
   *
   * @var string[]
   */
  protected $nodeTypes = array();

  /**
   * {@inheritdoc}
   */
  public function query() {
    return $this
      ->select('field_config_instance', 'fci')
      ->distinct()
      ->fields('fci', array(
      'bundle',
    ))
      ->condition('entity_type', 'comment');
  }

  /**
   * {@inheritdoc}
   */
  protected function initializeIterator() {
    $this->nodeTypes = $this
      ->select('node_type', 'nt')
      ->fields('nt', array(
      '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 array(
      '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 array(
      'bundle' => array(
        'type' => 'string',
      ),
    );
  }

}

Members

Name	Modifiers	Type	Description	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. None of these fields should contain a NULL value - if necessary, use prepareRow() or hook_migrate_prepare_row() to rewrite NULL values to appropriate empty values (such as '' or 0). Overrides MigrateSourceInterface::getIds
CommentType::initializeIterator	protected	function	Implementation of MigrateSource::performRewind(). Overrides SqlBase::initializeIterator
CommentType::prepareRow	public	function	Add additional data to the row. Overrides SourcePluginBase::prepareRow
CommentType::query	public	function	Overrides SqlBase::query
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.	1
DependencyTrait::addDependencies	protected	function	Adds multiple dependencies.
DependencyTrait::addDependency	protected	function	Adds a dependency.
DrupalSqlBase::$entityManager	protected	property	The entity 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 RequirementsInterface::checkRequirements
DrupalSqlBase::create	public static	function	Creates an instance of the plugin. Overrides SqlBase::create
DrupalSqlBase::getModuleSchemaVersion	protected	function	Get a module schema_version value in the source installation.
DrupalSqlBase::getSystemData	public	function	Retrieves all system data information from origin system.
DrupalSqlBase::moduleExists	protected	function	Check to see if a given module is enabled in the source installation.
DrupalSqlBase::variableGet	protected	function	Read a variable from a Drupal database.
DrupalSqlBase::__construct	public	function	Constructs a Drupal\Component\Plugin\PluginBase object. Overrides SqlBase::__construct	1
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	2
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.
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
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
SourcePluginBase::$cache	protected	property
SourcePluginBase::$cacheCounts	protected	property	Whether this instance should cache the source count.
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	The name and type of the highwater property in the source.
SourcePluginBase::$idMap	protected	property
SourcePluginBase::$iterator	protected	property
SourcePluginBase::$mapRowAdded	protected	property	By default, next() will directly read the map row and add it to the data row. A source plugin implementation may do this itself (in particular, the SQL source can incorporate the map table into the query) - if so, it should set this TRUE so we…
SourcePluginBase::$migration	protected	property
SourcePluginBase::$moduleHandler	protected	property
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.
SourcePluginBase::$trackChanges	protected	property	If TRUE, we will maintain hashed source rows to determine whether incoming data has changed.
SourcePluginBase::aboveHighwater	protected	function	Check if the incoming data is newer than what we've previously imported.
SourcePluginBase::current	public	function
SourcePluginBase::getCache	protected	function	Get the cache object.
SourcePluginBase::getCurrentIds	public	function	Getter for currentSourceIds data member.
SourcePluginBase::getIterator	protected	function	Returns the iterator that will yield the row arrays to be processed.
SourcePluginBase::getModuleHandler	protected	function	Get the module handler.
SourcePluginBase::key	public	function	Get 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::rewind	public	function	Rewind the iterator.
SourcePluginBase::rowChanged	protected	function	Check if the incoming row has changed since our last import.
SourcePluginBase::valid	public	function	Whether the iterator is currently valid.
SqlBase::$database	protected	property		1
SqlBase::$query	protected	property		59
SqlBase::$state	protected	property	State service for retrieving database info.
SqlBase::count	public	function	Get the source count. Overrides SourcePluginBase::count	4
SqlBase::getDatabase	public	function	Get the database connection object.	1
SqlBase::mapJoinable	protected	function	Check if we can join against the map table.	1
SqlBase::prepareQuery	protected	function	A helper for adding tags and metadata to the query.
SqlBase::select	protected	function	Wrapper for database select.
SqlBase::setUpDatabase	protected	function	Get a connection to the referenced database, adding the connection if necessary.
SqlBase::__toString	public	function	Print the query string when the object is used a string. Overrides MigrateSourceInterface::__toString
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.
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.