You are here

abstract class DemoComment in Open Social 10.0.x

Same name and namespace in other branches
  1. 8.9 modules/custom/social_demo/src/DemoComment.php \Drupal\social_demo\DemoComment
  2. 8 modules/custom/social_demo/src/DemoComment.php \Drupal\social_demo\DemoComment
  3. 8.2 modules/custom/social_demo/src/DemoComment.php \Drupal\social_demo\DemoComment
  4. 8.3 modules/custom/social_demo/src/DemoComment.php \Drupal\social_demo\DemoComment
  5. 8.4 modules/custom/social_demo/src/DemoComment.php \Drupal\social_demo\DemoComment
  6. 8.5 modules/custom/social_demo/src/DemoComment.php \Drupal\social_demo\DemoComment
  7. 8.6 modules/custom/social_demo/src/DemoComment.php \Drupal\social_demo\DemoComment
  8. 8.7 modules/custom/social_demo/src/DemoComment.php \Drupal\social_demo\DemoComment
  9. 8.8 modules/custom/social_demo/src/DemoComment.php \Drupal\social_demo\DemoComment
  10. 10.3.x modules/custom/social_demo/src/DemoComment.php \Drupal\social_demo\DemoComment
  11. 10.1.x modules/custom/social_demo/src/DemoComment.php \Drupal\social_demo\DemoComment
  12. 10.2.x modules/custom/social_demo/src/DemoComment.php \Drupal\social_demo\DemoComment

Class DemoComment.

@package Drupal\social_demo

Hierarchy

Expanded class hierarchy of DemoComment

1 file declares its use of DemoComment
Comment.php in modules/custom/social_demo/src/Plugin/DemoContent/Comment.php

File

modules/custom/social_demo/src/DemoComment.php, line 14

Namespace

Drupal\social_demo
View source
abstract class DemoComment extends DemoContent {

  /**
   * The user storage.
   *
   * @var \Drupal\user\UserStorageInterface
   */
  protected $userStorage;

  /**
   * DemoComment constructor.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, DemoContentParserInterface $parser, UserStorageInterface $user_storage) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->parser = $parser;
    $this->userStorage = $user_storage;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('social_demo.yaml_parser'), $container
      ->get('entity_type.manager')
      ->getStorage('user'));
  }

  /**
   * {@inheritdoc}
   */
  public function createContent($generate = FALSE, $max = NULL) {
    $data = $this
      ->fetchData();
    if ($generate === TRUE) {
      $data = $this
        ->scrambleData($data, $max);
    }
    foreach ($data as $uuid => $item) {

      // Must have uuid and same key value.
      if ($uuid !== $item['uuid']) {
        drush_log(dt("Comment with uuid: {$uuid} has a different uuid in content."), LogLevel::ERROR);
        continue;
      }

      // Check whether comment with same uuid already exists.
      $comments = $this->entityStorage
        ->loadByProperties([
        'uuid' => $uuid,
      ]);
      if ($comments) {
        drush_log(dt("Comment with uuid: {$uuid} already exists."), LogLevel::WARNING);
        continue;
      }

      // Try to load a user account (author's account).
      $accounts = $this->userStorage
        ->loadByProperties([
        'uuid' => $item['uid'],
      ]);
      if (!$accounts) {
        drush_log(dt("Account with uuid: {$item['uid']} doesn't exists."), LogLevel::ERROR);
        continue;
      }
      $account = current($accounts);

      // Create array with data of a comment.
      $item['uid'] = $account
        ->id();
      $item['pid'] = NULL;

      // Set parent comment if it is present.
      if (!empty($item['parent'])) {
        $comments = $this->entityStorage
          ->loadByProperties([
          'uuid' => $item['parent'],
        ]);
        if ($comments) {
          $comment = current($comments);
          $item['pid'] = $comment
            ->id();
        }
      }

      // Try and fetch the related entity.
      $entity = $this
        ->loadByUuid($item['entity_type'], $item['entity_id']);
      if (!$entity) {
        drush_log(dt("Entity {$item['entity_type']} with uuid: {$item['entity_id']} doesn't exists."), LogLevel::ERROR);
        continue;
      }
      if (!empty($item['created'])) {
        $item['created'] = $this
          ->createDate($item['created']);
        if ($item['created'] < $entity
          ->get('created')->value) {
          $item['created'] = \Drupal::time()
            ->getRequestTime();
        }
      }
      else {
        $item['created'] = \Drupal::time()
          ->getRequestTime();
      }
      $item['entity_id'] = $entity
        ->id();
      $entry = $this
        ->getEntry($item);
      $entity = $this->entityStorage
        ->create($entry);
      $entity
        ->save();
      if ($entity
        ->id()) {
        $this->content[$entity
          ->id()] = $entity;
      }
    }
    return $this->content;
  }

  /**
   * Converts a date in the correct format.
   *
   * @param string $date_string
   *   The date.
   *
   * @return int|false
   *   Returns a timestamp on success, false otherwise.
   */
  protected function createDate($date_string) {
    if ($date_string === 'now') {
      return time();
    }

    // Split from delimiter.
    $timestamp = explode('|', $date_string);
    $date = strtotime($timestamp[0]);
    $date = date('Y-m-d', $date) . 'T' . $timestamp[1] . ':00';
    return strtotime($date);
  }

  /**
   * {@inheritdoc}
   */
  protected function getEntry(array $item) {
    $entry = [
      'uuid' => $item['uuid'],
      'field_comment_body' => [
        [
          'value' => $this
            ->checkMentionOrLinkByUuid($item['body']),
          'format' => 'basic_html',
        ],
      ],
      'langcode' => $item['langcode'],
      'uid' => $item['uid'],
      'entity_id' => $item['entity_id'],
      'pid' => $item['pid'],
      'created' => $item['created'],
      'changed' => $item['created'],
      'field_name' => $item['field_name'],
      'comment_type' => $item['type'],
      'entity_type' => $item['entity_type'],
      'status' => 1,
    ];
    return $entry;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DemoComment::$userStorage protected property The user storage.
DemoComment::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
DemoComment::createContent public function Creates content. Overrides DemoContentInterface::createContent
DemoComment::createDate protected function Converts a date in the correct format.
DemoComment::getEntry protected function Makes an array with data of an entity. Overrides DemoContent::getEntry
DemoComment::__construct public function DemoComment constructor. Overrides PluginBase::__construct
DemoContent::$content protected property Contains the created content.
DemoContent::$data protected property Contains data from a file.
DemoContent::$entityStorage protected property Contains the entity storage.
DemoContent::$parser protected property Parser.
DemoContent::$profile protected property Profile.
DemoContent::checkMentionOrLinkByUuid protected function Extract the mention from the content by [~Uuid].
DemoContent::count public function Returns quantity of created items. Overrides DemoContentInterface::count 1
DemoContent::fetchData protected function Gets the data from a file.
DemoContent::getModule public function Returns the module name. Overrides DemoContentInterface::getModule
DemoContent::getProfile public function Returns the profile. Overrides DemoContentInterface::getProfile
DemoContent::getSource public function Returns the file name. Overrides DemoContentInterface::getSource
DemoContent::loadByUuid protected function Load entity by uuid.
DemoContent::prepareImage protected function Prepares data about an image.
DemoContent::removeContent public function Removes content. Overrides DemoContentInterface::removeContent
DemoContent::scrambleData public function Scramble it. Overrides DemoContentInterface::scrambleData 2
DemoContent::setEntityStorage public function Set entity storage. Overrides DemoContentInterface::setEntityStorage
DemoContent::setProfile public function Sets the used profile. Overrides DemoContentInterface::setProfile
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
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 2
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.
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
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.