class DisqusComment in Disqus 8

Same name in this branch

8 src/Plugin/migrate/source/DisqusComment.php \Drupal\disqus\Plugin\migrate\source\DisqusComment
8 src/Plugin/migrate/destination/DisqusComment.php \Drupal\disqus\Plugin\migrate\destination\DisqusComment

Disqus comment source using disqus-api.

Plugin annotation


@MigrateSource(
  id = "disqus_source",
  source_module = "disqus"
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\migrate\Plugin\migrate\source\SourcePluginBase implements RollbackAwareInterface, MigrateSourceInterface
    class \Drupal\disqus\Plugin\migrate\source\DisqusComment implements ContainerFactoryPluginInterface

Expanded class hierarchy of DisqusComment

File

src/Plugin/migrate/source/DisqusComment.php, line 23

Namespace

Drupal\disqus\Plugin\migrate\source

View source

class DisqusComment extends SourcePluginBase implements ContainerFactoryPluginInterface {

  /**
   * Iterator.
   *
   * @var \ArrayIterator
   */
  protected $iterator;

  /**
   * A logger instance.
   *
   * @var \Psr\Log\LoggerInterface
   */
  protected $logger;

  /**
   * The disqus.settings configuration.
   *
   * @var \Drupal\Core\Config\Config
   */
  protected $config;

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * Constructs Disqus comments destination plugin.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implemetation definition.
   * @param \Drupal\migrate\Plugin\MigrationInterface $migration
   *   The migration.
   * @param \Psr\Log\LoggerInterface $logger
   *   A logger instance.
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The config factory.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, MigrationInterface $migration, LoggerInterface $logger, ConfigFactoryInterface $config_factory, EntityTypeManagerInterface $entity_type_manager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $migration);
    $this->logger = $logger;
    $this->config = $config_factory
      ->get('disqus.settings');
    $this->entityTypeManager = $entity_type_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition, MigrationInterface $migration = NULL) {
    return new static($configuration, $plugin_id, $plugin_definition, $migration, $container
      ->get('logger.factory')
      ->get('disqus'), $container
      ->get('config.factory'), $container
      ->get('entity_type.manager'));
  }

  /**
   * {@inheritdoc}
   */
  public function getIds() {
    $ids['id']['type'] = 'integer';
    return $ids;
  }

  /**
   * {@inheritdoc}
   */
  public function fields() {
    return [
      'id' => $this
        ->t('Comment ID.'),
      'pid' => $this
        ->t('Parent comment ID. If set to null, this comment is not a reply to an existing comment.'),
      'identifier' => $this
        ->t("The disqus identifier to look up the corrent thread."),
      'name' => $this
        ->t("The comment author's name."),
      'user_id' => $this
        ->t('The disqus user-id of the author who commented.'),
      'email' => $this
        ->t("The comment author's email address."),
      'url' => $this
        ->t("The author's home page address."),
      'ipAddress' => $this
        ->t("The author's IP address."),
      'isAnonymous' => $this
        ->t('If true, this comments has been posted by an anonymous user.'),
      'isApproved' => $this
        ->t('If the comment is approved or not.'),
      'createdAt' => $this
        ->t('The time that the comment was created.'),
      'comment' => $this
        ->t('The comment body.'),
      'isEdited' => $this
        ->t('Boolean value indicating if the comment has been edited or not.'),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function prepareRow(Row $row) {
    $row
      ->setSourceProperty('uid', 0);
    $email = $row
      ->getSourceProperty('email');
    $user = $this->entityTypeManager
      ->getStorage('user')
      ->getQuery()
      ->condition('mail', $email)
      ->execute();
    if ($user) {
      $row
        ->setSourceProperty('uid', key($user));
    }
    return parent::prepareRow($row);
  }

  /**
   * {@inheritdoc}
   */
  public function __toString() {
    return 'Disqus comments';
  }

  /**
   * {@inheritdoc}
   */
  public function initializeIterator() {
    $items = [];
    if ($disqus = disqus_api()) {
      $items = [];
      try {
        $posts = $disqus->forums
          ->listPosts([
          'forum' => $this->config
            ->get('disqus_domain'),
        ]);
      } catch (\Exception $exception) {
        $this
          ->messenger()
          ->addMessage($this
          ->t('There was an error loading the forum details. Please check you API keys and try again.'), MessengerInterface::TYPE_ERROR);
        $this->logger
          ->error('Error loading the Disqus PHP API. Check your forum name.', []);
        return new \ArrayIterator($items);
      }
      foreach ($posts as $post) {
        $id = $post->id;
        $items[$id]['id'] = $id;
        $items[$id]['pid'] = $post->parent;
        $thread = $disqus->threads
          ->details([
          'thread' => $post->thread,
        ]);
        $items[$id]['identifier'] = $thread->identifier;
        $items[$id]['name'] = $post->author->name;
        $items[$id]['email'] = $post->author->email;
        $items[$id]['user_id'] = $post->author->id;
        $items[$id]['url'] = $post->author->url;
        $items[$id]['ipAddress'] = $post->ipAddress;
        $items[$id]['isAnonymous'] = $post->author->isAnonymous;
        $items[$id]['createdAt'] = $post->createdAt;
        $items[$id]['comment'] = $post->message;
        $items[$id]['isEdited'] = $post->isEdited;
      }
    }
    return new \ArrayIterator($items);
  }

}

Members

Name	Modifiers	Type	Description	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
DisqusComment::$config	protected	property	The disqus.settings configuration.
DisqusComment::$entityTypeManager	protected	property	The entity type manager.
DisqusComment::$iterator	protected	property	Iterator. Overrides SourcePluginBase::$iterator
DisqusComment::$logger	protected	property	A logger instance.
DisqusComment::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
DisqusComment::fields	public	function	Returns available fields on the source. Overrides MigrateSourceInterface::fields
DisqusComment::getIds	public	function	Defines the source fields uniquely identifying a source row. Overrides MigrateSourceInterface::getIds
DisqusComment::initializeIterator	public	function	Initializes the iterator with the source data. Overrides SourcePluginBase::initializeIterator
DisqusComment::prepareRow	public	function	Adds additional data to the row. Overrides SourcePluginBase::prepareRow
DisqusComment::__construct	public	function	Constructs Disqus comments destination plugin. Overrides SourcePluginBase::__construct
DisqusComment::__toString	public	function	Allows class to decide how it will react when it is treated like a string. Overrides MigrateSourceInterface::__toString
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::$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.	4
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::fetchNextRow	protected	function	Position the iterator to the following row.	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.
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.

You are here

class DisqusComment in Disqus 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation