You are here

class Newsletter in Simplenews 8

Same name in this branch
  1. 8 src/Entity/Newsletter.php \Drupal\simplenews\Entity\Newsletter
  2. 8 src/Plugin/migrate/source/d7/Newsletter.php \Drupal\simplenews\Plugin\migrate\source\d7\Newsletter
Same name and namespace in other branches
  1. 8.2 src/Plugin/migrate/source/d7/Newsletter.php \Drupal\simplenews\Plugin\migrate\source\d7\Newsletter
  2. 3.x src/Plugin/migrate/source/d7/Newsletter.php \Drupal\simplenews\Plugin\migrate\source\d7\Newsletter

Migration source for Newsletter entities in D7.

Plugin annotation


@MigrateSource(
  id = "simplenews_newsletter",
  source_module = "simplenews"
)

Hierarchy

Expanded class hierarchy of Newsletter

16 string references to 'Newsletter'
field.field.node.simplenews_issue.simplenews_issue.yml in config/optional/field.field.node.simplenews_issue.simplenews_issue.yml
config/optional/field.field.node.simplenews_issue.simplenews_issue.yml
simplenews.links.task.yml in ./simplenews.links.task.yml
simplenews.links.task.yml
simplenews.routing.yml in ./simplenews.routing.yml
simplenews.routing.yml
simplenews.schema.yml in config/schema/simplenews.schema.yml
config/schema/simplenews.schema.yml
SimplenewsAdministrationTest::testContentTypes in src/Tests/SimplenewsAdministrationTest.php
Test content type configuration.

... See full list

File

src/Plugin/migrate/source/d7/Newsletter.php, line 15

Namespace

Drupal\simplenews\Plugin\migrate\source\d7
View source
class Newsletter extends DrupalSqlBase {

  /**
   * {@inheritdoc}
   */
  public function fields() {
    return [
      'newsletter_id' => $this
        ->t('Newsletter ID'),
      'name' => $this
        ->t('Name'),
      'description' => $this
        ->t('Description'),
      'format' => $this
        ->t('HTML or plaintext'),
      'priority' => $this
        ->t('Priority'),
      'receipt' => $this
        ->t('Request read receipt'),
      'from_name' => $this
        ->t('Name of the e-mail author'),
      'email_subject' => $this
        ->t('Newsletter subject'),
      'from_address' => $this
        ->t('E-mail author address'),
      'hyperlinks' => $this
        ->t('Indicates if hyperlinks should be kept inline or extracted'),
      'new_account' => $this
        ->t('Indicates how to integrate with the register form'),
      'opt_inout' => $this
        ->t('Defines the Opt-In/out options'),
      'block' => $this
        ->t('TRUE if a block should be provided for this newsletter'),
      'weight' => $this
        ->t('Weight of the newsletter when displayed in listings'),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getIds() {
    $version = $this
      ->getModuleSchemaVersion('simplenews');
    if ($version >= 7000 & $version < 7200) {
      return [
        'tid' => [
          'type' => 'integer',
          'alias' => 'c',
        ],
      ];
    }
    else {
      return [
        'newsletter_id' => [
          'type' => 'integer',
        ],
      ];
    }
  }

  /**
   * {@inheritdoc}
   */
  public function query() {
    $version = $this
      ->getModuleSchemaVersion('simplenews');
    if ($version >= 7000 & $version < 7200) {
      return $this
        ->query71();
    }
    else {
      return $this
        ->query72();
    }
  }

  /**
   * Get query for Simplenews module version 7.x-1.x.
   */
  protected function query71() {
    $q = $this
      ->select('simplenews_category', 'c');
    $q
      ->innerJoin('taxonomy_term_data', 't', 't.tid = c.tid');
    $q
      ->fields('c', [
      'tid',
      'format',
      'priority',
      'receipt',
      'from_name',
      'email_subject',
      'from_address',
      'hyperlinks',
      'new_account',
      'opt_inout',
      'block',
    ]);
    $q
      ->fields('t', [
      'name',
      'description',
      'weight',
    ]);
    $q
      ->orderBy('c.tid');
    return $q;
  }

  /**
   * Get query for Simplenews module version 7.x-2.x.
   */
  protected function query72() {
    return $this
      ->select('simplenews_newsletter', 'n')
      ->fields('n')
      ->orderBy('newsletter_id');
  }

}

Members

Namesort descending 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
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 Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides SqlBase::__construct 6
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
Newsletter::fields public function Returns available fields on the source. Overrides MigrateSourceInterface::fields
Newsletter::getIds public function Defines the source fields uniquely identifying a source row. Overrides MigrateSourceInterface::getIds
Newsletter::query public function Overrides SqlBase::query
Newsletter::query71 protected function Get query for Simplenews module version 7.x-1.x.
Newsletter::query72 protected function Get query for Simplenews module version 7.x-2.x.
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::$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::prepareRow public function Adds additional data to the row. Overrides MigrateSourceInterface::prepareRow 50
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.
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
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.