class Comment

Same name in this branch
  1. 8.9.x core/modules/comment/src/Entity/Comment.php \Drupal\comment\Entity\Comment
  2. 8.9.x core/modules/comment/src/Plugin/views/wizard/Comment.php \Drupal\comment\Plugin\views\wizard\Comment
  3. 8.9.x core/modules/comment/src/Plugin/migrate/source/d7/Comment.php \Drupal\comment\Plugin\migrate\source\d7\Comment
Same name in other branches
  1. 9 core/modules/comment/src/Entity/Comment.php \Drupal\comment\Entity\Comment
  2. 9 core/modules/comment/src/Plugin/views/wizard/Comment.php \Drupal\comment\Plugin\views\wizard\Comment
  3. 9 core/modules/comment/src/Plugin/migrate/source/d6/Comment.php \Drupal\comment\Plugin\migrate\source\d6\Comment
  4. 9 core/modules/comment/src/Plugin/migrate/source/d7/Comment.php \Drupal\comment\Plugin\migrate\source\d7\Comment
  5. 9 core/modules/comment/tests/modules/d6_comment_test/src/Plugin/migrate/source/d6/Comment.php \Drupal\d6_comment_test\Plugin\migrate\source\d6\Comment
  6. 10 core/modules/comment/src/Entity/Comment.php \Drupal\comment\Entity\Comment
  7. 10 core/modules/comment/src/Plugin/views/wizard/Comment.php \Drupal\comment\Plugin\views\wizard\Comment
  8. 10 core/modules/comment/src/Plugin/migrate/source/d6/Comment.php \Drupal\comment\Plugin\migrate\source\d6\Comment
  9. 10 core/modules/comment/src/Plugin/migrate/source/d7/Comment.php \Drupal\comment\Plugin\migrate\source\d7\Comment
  10. 11.x core/modules/comment/src/Entity/Comment.php \Drupal\comment\Entity\Comment
  11. 11.x core/modules/comment/src/Plugin/views/wizard/Comment.php \Drupal\comment\Plugin\views\wizard\Comment
  12. 11.x core/modules/comment/src/Plugin/migrate/source/d6/Comment.php \Drupal\comment\Plugin\migrate\source\d6\Comment
  13. 11.x core/modules/comment/src/Plugin/migrate/source/d7/Comment.php \Drupal\comment\Plugin\migrate\source\d7\Comment

Drupal 6 comment source from database.

Plugin annotation


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

Hierarchy

Expanded class hierarchy of Comment

335 string references to 'Comment'
ActionTest::providerSource in core/modules/action/tests/src/Kernel/Plugin/migrate/source/ActionTest.php
The data provider.
AuthorNameFormatter::isApplicable in core/modules/comment/src/Plugin/Field/FieldFormatter/AuthorNameFormatter.php
Returns if the formatter can be used for the provided field.
BigPipeRegressionTest::testCommentForm_2698811 in core/modules/big_pipe/tests/src/FunctionalJavascript/BigPipeRegressionTest.php
Ensure comment form works with history and big_pipe modules.
CategoryAutocompleteTest::providerTestAutocompleteSuggestions in core/modules/block/tests/src/Unit/CategoryAutocompleteTest.php
Data provider for testAutocompleteSuggestions().
CategoryAutocompleteTest::setUp in core/modules/block/tests/src/Unit/CategoryAutocompleteTest.php

... See full list

File

core/modules/comment/src/Plugin/migrate/source/d6/Comment.php, line 16

Namespace

Drupal\comment\Plugin\migrate\source\d6
View source
class Comment extends DrupalSqlBase {
    
    /**
     * {@inheritdoc}
     */
    public function query() {
        $query = $this->select('comments', 'c')
            ->fields('c', [
            'cid',
            'pid',
            'nid',
            'uid',
            'subject',
            'comment',
            'hostname',
            'timestamp',
            'status',
            'thread',
            'name',
            'mail',
            'homepage',
            'format',
        ]);
        $query->innerJoin('node', 'n', 'c.nid = n.nid');
        $query->fields('n', [
            'type',
            'language',
        ]);
        $query->orderBy('c.timestamp');
        return $query;
    }
    
    /**
     * {@inheritdoc}
     */
    public function prepareRow(Row $row) {
        // @todo Remove the call to ->prepareComment() in
        // https://www.drupal.org/project/drupal/issues/3069260 when the Drupal 9
        // branch opens.
        return parent::prepareRow($this->prepareComment($row));
    }
    
    /**
     * Provides a BC layer for deprecated sources.
     *
     * This is a backward compatibility layer for the deprecated migrate source
     * plugins d6_comment_variable and d6_comment_variable_per_comment_type.
     *
     * @param \Drupal\migrate\Row $row
     *   The row from the source to process.
     *
     * @return \Drupal\migrate\Row
     *   The row object.
     *
     * @throws \Exception
     *   Passing a Row with a frozen source to this method will trigger an
     *   \Exception when attempting to set the source properties.
     *
     * @todo Remove usages of this method and deprecate for removal in
     *   https://www.drupal.org/project/drupal/issues/3069260 when the Drupal 9
     *   branch opens.
     */
    protected function prepareComment(Row $row) {
        if ($this->variableGet('comment_subject_field_' . $row->getSourceProperty('type'), 1)) {
            // Comment subject visible.
            $row->setSourceProperty('field_name', 'comment');
            $row->setSourceProperty('comment_type', 'comment');
        }
        else {
            $row->setSourceProperty('field_name', 'comment_no_subject');
            $row->setSourceProperty('comment_type', 'comment_no_subject');
        }
        // In D6, status=0 means published, while in D8 means the opposite.
        // See https://www.drupal.org/node/237636.
        $row->setSourceProperty('status', !$row->getSourceProperty('status'));
        // If node did not have a language, use site default language as a fallback.
        if (!$row->getSourceProperty('language')) {
            $language_default = $this->variableGet('language_default', NULL);
            $language = $language_default ? $language_default->language : 'en';
            $row->setSourceProperty('language', $language);
        }
        return $row;
    }
    
    /**
     * {@inheritdoc}
     */
    public function fields() {
        return [
            'cid' => $this->t('Comment ID.'),
            'pid' => $this->t('Parent comment ID. If set to 0, this comment is not a reply to an existing comment.'),
            'nid' => $this->t('The {node}.nid to which this comment is a reply.'),
            'uid' => $this->t('The {users}.uid who authored the comment. If set to 0, this comment was created by an anonymous user.'),
            'subject' => $this->t('The comment title.'),
            'comment' => $this->t('The comment body.'),
            'hostname' => $this->t("The author's host name."),
            'timestamp' => $this->t('The time that the comment was created, or last edited by its author, as a Unix timestamp.'),
            'status' => $this->t('The published status of a comment. (0 = Published, 1 = Not Published)'),
            'format' => $this->t('The {filter_formats}.format of the comment body.'),
            'thread' => $this->t("The vancode representation of the comment's place in a thread."),
            'name' => $this->t("The comment author's name. Uses {users}.name if the user is logged in, otherwise uses the value typed into the comment form."),
            'mail' => $this->t("The comment author's email address from the comment form, if user is anonymous, and the 'Anonymous users may/must leave their contact information' setting is turned on."),
            'homepage' => $this->t("The comment author's home page address from the comment form, if user is anonymous, and the 'Anonymous users may/must leave their contact information' setting is turned on."),
            'type' => $this->t("The {node}.type to which this comment is a reply."),
            'language' => $this->t("The {node}.language to which this comment is a reply. Site default language is used as a fallback if node does not have a language."),
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public function getIds() {
        $ids['cid']['type'] = 'integer';
        return $ids;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
Comment::fields public function Returns available fields on the source. Overrides MigrateSourceInterface::fields
Comment::getIds public function Defines the source fields uniquely identifying a source row. Overrides MigrateSourceInterface::getIds
Comment::prepareComment protected function Provides a BC layer for deprecated sources.
Comment::prepareRow public function Adds additional data to the row. Overrides SourcePluginBase::prepareRow
Comment::query public function 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.
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 Overrides SqlBase::__construct 6
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
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

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