You are here

class NodeCounter in Drupal 9

Same name in this branch
  1. 9 core/modules/statistics/src/Plugin/migrate/source/NodeCounter.php \Drupal\statistics\Plugin\migrate\source\NodeCounter
  2. 9 core/modules/statistics/src/Plugin/migrate/destination/NodeCounter.php \Drupal\statistics\Plugin\migrate\destination\NodeCounter
Same name and namespace in other branches
  1. 8 core/modules/statistics/src/Plugin/migrate/destination/NodeCounter.php \Drupal\statistics\Plugin\migrate\destination\NodeCounter

Destination for node counter.

Plugin annotation


@MigrateDestination(
  id = "node_counter",
  destination_module = "statistics"
)

Hierarchy

Expanded class hierarchy of NodeCounter

1 file declares its use of NodeCounter
DestinationCategoryTest.php in core/modules/migrate_drupal/tests/src/Kernel/Plugin/migrate/DestinationCategoryTest.php

File

core/modules/statistics/src/Plugin/migrate/destination/NodeCounter.php, line 20

Namespace

Drupal\statistics\Plugin\migrate\destination
View source
class NodeCounter extends DestinationBase implements ContainerFactoryPluginInterface {

  /**
   * The database connection.
   *
   * @var \Drupal\Core\Database\Connection
   */
  protected $connection;

  /**
   * Constructs a node counter plugin.
   *
   * @param array $configuration
   *   Plugin configuration.
   * @param string $plugin_id
   *   The plugin ID.
   * @param mixed $plugin_definition
   *   The plugin definition.
   * @param \Drupal\migrate\Plugin\MigrationInterface $migration
   *   The current migration.
   * @param \Drupal\Core\Database\Connection $connection
   *   The database connection.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, MigrationInterface $migration, Connection $connection) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $migration);
    $this->connection = $connection;
  }

  /**
   * {@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('database'));
  }

  /**
   * {@inheritdoc}
   */
  public function getIds() {
    return [
      'nid' => [
        'type' => 'integer',
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function fields() {
    return [
      'nid' => $this
        ->t('The ID of the node to which these statistics apply.'),
      'totalcount' => $this
        ->t('The total number of times the node has been viewed.'),
      'daycount' => $this
        ->t('The total number of times the node has been viewed today.'),
      'timestamp' => $this
        ->t('The most recent time the node has been viewed.'),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function import(Row $row, array $old_destination_id_values = []) {
    $nid = $row
      ->getDestinationProperty('nid');
    $daycount = $row
      ->getDestinationProperty('daycount');
    $totalcount = $row
      ->getDestinationProperty('totalcount');
    $timestamp = $row
      ->getDestinationProperty('timestamp');
    $this->connection
      ->merge('node_counter')
      ->key('nid', $nid)
      ->fields([
      'daycount' => $daycount,
      'totalcount' => $totalcount,
      'timestamp' => $timestamp,
    ])
      ->expression('daycount', '[daycount] + :daycount', [
      ':daycount' => $daycount,
    ])
      ->expression('totalcount', '[totalcount] + :totalcount', [
      ':totalcount' => $totalcount,
    ])
      ->expression('timestamp', 'CASE WHEN [timestamp] > :timestamp1 THEN [timestamp] ELSE :timestamp2 END', [
      ':timestamp1' => $timestamp,
      ':timestamp2' => $timestamp,
    ])
      ->execute();
    return [
      $row
        ->getDestinationProperty('nid'),
    ];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
DestinationBase::$migration protected property The migration.
DestinationBase::$rollbackAction protected property The rollback action to be saved for the last imported item.
DestinationBase::$supportsRollback protected property Indicates whether the destination can be rolled back.
DestinationBase::checkRequirements public function Checks if requirements for this plugin are OK. Overrides RequirementsInterface::checkRequirements
DestinationBase::getDestinationModule public function Gets the destination module handling the destination data. Overrides MigrateDestinationInterface::getDestinationModule 1
DestinationBase::rollback public function Delete the specified destination object from the target Drupal. Overrides MigrateDestinationInterface::rollback 2
DestinationBase::rollbackAction public function The rollback action for the last imported item. Overrides MigrateDestinationInterface::rollbackAction
DestinationBase::setRollbackAction protected function For a destination item being updated, set the appropriate rollback action.
DestinationBase::supportsRollback public function Whether the destination can be rolled back or not. Overrides MigrateDestinationInterface::supportsRollback
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
MessengerTrait::setMessenger public function Sets the messenger.
NodeCounter::$connection protected property The database connection.
NodeCounter::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
NodeCounter::fields public function Returns an array of destination fields. Overrides MigrateDestinationInterface::fields
NodeCounter::getIds public function Gets the destination IDs. Overrides MigrateDestinationInterface::getIds
NodeCounter::import public function Import the row. Overrides MigrateDestinationInterface::import
NodeCounter::__construct public function Constructs a node counter plugin. Overrides DestinationBase::__construct
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.