class SupportTicket in Support Ticketing System 8

Drupal 6 support ticket source from database.

Plugin annotation

@MigrateSource(
  id = "d6_support_ticket"
)

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\migrate\Plugin\migrate\source\SqlBase implements ContainerFactoryPluginInterface, RequirementsInterface
        • class \Drupal\migrate_drupal\Plugin\migrate\source\DrupalSqlBase implements DependentPluginInterface, ContainerFactoryPluginInterface uses DeprecatedServicePropertyTrait, DependencyTrait
          • class \Drupal\support_ticket\Plugin\migrate\source\d6\SupportTicket implements \Drupal\migrate\Plugin\SourceEntityInterface

File

modules/support_ticket/src/Plugin/migrate/source/d6/SupportTicket.php, line 90

Contains \Drupal\support_ticket\Plugin\migrate\source\d6\SupportTicket.

Namespace

Drupal\support_ticket\Plugin\migrate\source\d6

class SupportTicket extends DrupalSqlBase implements SourceEntityInterface {

  /**
   * The join options between the node and the node_revisions table.
   */
  const JOIN_NODE_REVISION = 'n.vid = nr.vid';

  /**
   * The join options between the node and the support_ticket table.
   */
  const JOIN_TICKET = 'n.nid = st.nid';

  /**
   * The join options between the support_ticket and state table.
   */
  const JOIN_STATE = 'st.state = ss.sid';

  /**
   * The join options between the support_ticket and priority table.
   */
  const JOIN_PRIORITY = 'st.priority = sp.pid';

  /**
   * The default filter format.
   *
   * @var string
   */
  protected $filterDefaultFormat;

  /**
   * {@inheritdoc}
   */
  public function query() {

    // Select support ticket / node in its last revision.
    $query = $this
      ->select('node_revisions', 'nr')
      ->fields('n', array(
      'nid',
      'vid',
      'type',
      'language',
      'status',
      'created',
      'changed',
      'comment',
      'moderate',
      'tnid',
      'translate',
    ))
      ->fields('st', array(
      'nid',
      'message_id',
      'state',
      'priority',
      'client',
      'assigned',
    ))
      ->fields('nr', array(
      'vid',
      'title',
      'body',
      'teaser',
      'log',
      'timestamp',
      'format',
    ));
    $query
      ->addField('n', 'uid', 'node_uid');
    $query
      ->addField('nr', 'uid', 'revision_uid');
    $query
      ->addField('ss', 'state', 'state_name');
    $query
      ->addField('sp', 'priority', 'priority_name');
    $query
      ->innerJoin('node', 'n', static::JOIN_NODE_REVISION);
    $query
      ->innerJoin('support_ticket', 'st', static::JOIN_TICKET);
    $query
      ->innerJoin('support_states', 'ss', static::JOIN_STATE);
    $query
      ->innerJoin('support_priority', 'sp', static::JOIN_PRIORITY);

    // @todo: get client name from appropriate table
    return $query;
  }

  /**
   * {@inheritdoc}
   */
  protected function initializeIterator() {
    $this->filterDefaultFormat = $this
      ->variableGet('filter_default_format', '1');
    return parent::initializeIterator();
  }

  /**
   * {@inheritdoc}
   */
  public function fields() {
    $fields = array(
      'nid' => $this
        ->t('Support Ticket ID'),
      'type' => $this
        ->t('Type'),
      // ?
      'title' => $this
        ->t('Title'),
      'body' => $this
        ->t('Body'),
      'format' => $this
        ->t('Format'),
      'teaser' => $this
        ->t('Teaser'),
      'node_uid' => $this
        ->t('Ticket created by (uid)'),
      'revision_uid' => $this
        ->t('Revision authored by (uid)'),
      'created' => $this
        ->t('Created timestamp'),
      'changed' => $this
        ->t('Modified timestamp'),
      'status' => $this
        ->t('Published'),
      'revision' => $this
        ->t('Create new revision'),
      'language' => $this
        ->t('Language (fr, en, ...)'),
      'tnid' => $this
        ->t('The translation set id for this node'),
      'timestamp' => $this
        ->t('The timestamp the latest revision of this node was created.'),
      'state_name' => $this
        ->t('The ticket state'),
      'priority_name' => $this
        ->t('The ticket priority'),
      'message_id' => $this
        ->t('The message_id if this update was created by email.'),
      'assigned' => $this
        ->t('Who the ticket is assigned to (uid)'),
    );
    return $fields;
  }

  /**
   * {@inheritdoc}
   */
  public function prepareRow(Row $row) {

    // format = 0 can happen when the body field is hidden. Set the format to 1
    // to avoid migration map issues (since the body field isn't used anyway).
    if ($row
      ->getSourceProperty('format') === '0') {
      $row
        ->setSourceProperty('format', $this->filterDefaultFormat);
    }
    return parent::prepareRow($row);
  }

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

  /**
   * {@inheritdoc}
   */
  public function bundleMigrationRequired() {
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function entityTypeId() {
    return 'node';
  }

}

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
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.
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::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::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.
SupportTicket::$filterDefaultFormat	protected	property	The default filter format.
SupportTicket::bundleMigrationRequired	public	function
SupportTicket::entityTypeId	public	function
SupportTicket::fields	public	function	Returns available fields on the source. Overrides MigrateSourceInterface::fields
SupportTicket::getIds	public	function	Defines the source fields uniquely identifying a source row. Overrides MigrateSourceInterface::getIds
SupportTicket::initializeIterator	protected	function	Initializes the iterator with the source data. Overrides SqlBase::initializeIterator
SupportTicket::JOIN_NODE_REVISION		constant	The join options between the node and the node_revisions table.
SupportTicket::JOIN_PRIORITY		constant	The join options between the support_ticket and priority table.
SupportTicket::JOIN_STATE		constant	The join options between the support_ticket and state table.
SupportTicket::JOIN_TICKET		constant	The join options between the node and the support_ticket table.
SupportTicket::prepareRow	public	function	Adds additional data to the row. Overrides SourcePluginBase::prepareRow
SupportTicket::query	public	function	Overrides SqlBase::query