abstract class XMLMigration in Migrate 6.2

Same name and namespace in other branches

7.2 plugins/sources/xml.inc \XMLMigration

Migrations using XML sources should extend this class instead of Migration.

Hierarchy

class \MigrationBase
- class \Migration
  - class \XMLMigration

Expanded class hierarchy of XMLMigration

1 string reference to 'XMLMigration'

Migration::analyze in includes/migration.inc: Perform an analysis operation - report on field values in the source.

File

plugins/sources/xml.inc, line 213: Support for migration from XML sources.

View source

abstract class XMLMigration extends Migration {

  /**
   * Override the default addFieldMapping(), so we can create our special
   * field mapping class.
   * TODO: Find a cleaner way to just substitute a different mapping class
   *
   * @param string $destinationField
   *  Name of the destination field.
   * @param string $sourceField
   *  Name of the source field (optional).
   * @param boolean $warn_on_override
   *  Set to FALSE to prevent warnings when there's an existing mapping
   *  for this destination field.
   */
  public function addFieldMapping($destination_field, $source_field = NULL, $warn_on_override = TRUE) {

    // Warn of duplicate mappings
    if ($warn_on_override && !is_null($destination_field) && isset($this->fieldMappings[$destination_field])) {
      self::displayMessage(t('!name addFieldMapping: !dest was previously mapped, overridden', array(
        '!name' => $this->machineName,
        '!dest' => $destination_field,
      )), 'warning');
    }
    $mapping = new MigrateXMLFieldMapping($destination_field, $source_field);
    if (is_null($destination_field)) {
      $this->fieldMappings[] = $mapping;
    }
    else {
      $this->fieldMappings[$destination_field] = $mapping;
    }
    return $mapping;
  }

  /**
   * A normal $data_row has all the input data as top-level fields - in this
   * case, however, the data is embedded within a SimpleXMLElement object in
   * $data_row->xml. Explode that out to the normal form, and pass on to the
   * normal implementation.
   */
  protected function applyMappings() {

    // We only know what data to pull from the xpaths in the mappings.
    foreach ($this->fieldMappings as $mapping) {
      $source = $mapping
        ->getSourceField();
      if ($source) {
        $xpath = $mapping
          ->getXpath();
        if ($xpath) {

          // Derived class may override applyXpath()
          $this->sourceValues->{$source} = $this
            ->applyXpath($this->sourceValues, $xpath);
        }
      }
    }
    parent::applyMappings();
  }

  /**
   * Default implementation - straightforward xpath application
   *
   * @param $data_row
   * @param $xpath
   */
  public function applyXpath($data_row, $xpath) {
    $result = $data_row->xml
      ->xpath($xpath);
    if ($result) {
      if (count($result) > 1) {
        $return = array();
        foreach ($result as $record) {
          $return[] = (string) $record;
        }
        return $return;
      }
      else {
        return (string) $result[0];
      }
    }
    else {
      return NULL;
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Migration::$counts	protected	property	An array of counts. Initially used for cache hit/miss tracking.
Migration::$currentSourceKey	protected	property
Migration::$defaultRollbackAction	protected	property	The default rollback action for this migration. Can be overridden on a per-row basis by setting $row->rollbackAction in prepareRow().
Migration::$destination	protected	property	Destination object for the migration, derived from MigrateDestination.
Migration::$destinationValues	protected	property	The object currently being constructed
Migration::$fieldMappings	protected	property	Simple mappings between destination fields (keys) and source fields (values).
Migration::$highwaterField	protected	property	If present, an array with keys name and alias (optional). Name refers to the source columns used for tracking highwater marks. alias is an optional table alias.
Migration::$map	protected	property	Map object tracking relationships between source and destination data
Migration::$needsUpdate	public	property	Specify value of needs_update for current map row. Usually set by MigrateFieldHandler implementations.
Migration::$rollbackAction	public	property	The rollback action to be saved for the current row.
Migration::$rollbackBatchSize	protected	property	When performing a bulkRollback(), the maximum number of items to pass in a single call. Can be overridden in derived class constructor.
Migration::$source	protected	property	Source object for the migration, derived from MigrateSource.
Migration::$sourceValues	protected	property	The current data row retrieved from the source.
Migration::$systemOfRecord	protected	property
Migration::addSimpleMappings	public	function	Shortcut for adding several fields which have the same name on both source and destination sides.
Migration::addUnmigratedDestinations	public	function	Shortcut for adding several destination fields which are to be explicitly not migrated.
Migration::addUnmigratedSources	public	function	Shortcut for adding several source fields which are to be explicitly not migrated.
Migration::analyze	public	function	Perform an analysis operation - report on field values in the source.
Migration::beginProcess	protected	function	Override MigrationBase::beginProcess, to make sure the map/message tables are present. Overrides MigrationBase::beginProcess
Migration::checkStatus	protected	function	Standard top-of-loop stuff, common between rollback and import - check for exceptional conditions, and display feedback.
Migration::createStubWrapper	protected	function	If stub creation is enabled, try to create a stub and save the mapping.
Migration::deregisterMigration	public static	function	Deregister a migration - remove all traces of it from the database (without touching any content which was created by this migration). Overrides MigrationBase::deregisterMigration
Migration::DESTINATION		constant
Migration::endProcess	public	function	Override MigrationBase::endProcess, to call post hooks. Note that it must be public to be callable as the shutdown function. Overrides MigrationBase::endProcess
Migration::errorCount	public	function	Get the number of source records which failed to import. TODO: Doesn't yet account for informationals, or multiple errors for a source record.
Migration::getDestination	public	function
Migration::getFieldMappings	public	function
Migration::getHighwaterField	public	function
Migration::getMap	public	function
Migration::getSource	public	function
Migration::getSystemOfRecord	public	function
Migration::handleDedupe	protected	function	For fields which require uniqueness, assign a new unique value if necessary.
Migration::handleSourceMigration	protected	function	Look up a value migrated in another migration.
Migration::import	protected	function	Perform an import operation - migrate items from source to destination.
Migration::importedCount	public	function	Get the number of records successfully imported.
Migration::isComplete	public	function	Reports whether this migration process is complete (i.e., all available source rows have been processed). Overrides MigrationBase::isComplete
Migration::itemOptionExceeded	protected	function	Test whether we've exceeded the designated item limit.
Migration::messageCount	public	function	Get the number of messages associated with this migration
Migration::postImport	protected	function
Migration::postRollback	protected	function
Migration::preImport	protected	function	Default implementations of pre/post import/rollback methods. These call the destination methods (if they exist) - when overriding, always call parent::preImport() etc.
Migration::prepareKey	public	function	Default implementation of prepareKey. This method is called from the source plugin immediately after retrieving the raw data from the source - by default, it simply assigns the key values based on the field names passed to MigrateSQLMap(). Override…
Migration::prepareRow	public	function	Default implementation of prepareRow(). This method is called from the source plugin upon first pulling the raw data from the source.	1
Migration::prepareUpdate	public	function	Prepares this migration to run as an update - that is, in addition to unmigrated content (source records not in the map table) being imported, previously-migrated content will also be updated in place.
Migration::preRollback	protected	function
Migration::processedCount	public	function	Get the number of source records processed.
Migration::progressMessage	protected	function	Outputs a progress message, reflecting the current status of a migration process.
Migration::removeFieldMapping	public	function	Remove any existing mappings for a given destination or source field.
Migration::rollback	protected	function	Perform a rollback operation - remove migrated items from the destination.
Migration::saveMessage	public	function	Pass messages through to the map class Overrides MigrationBase::saveMessage
Migration::setUpdate	public	function	Set the specified row to be updated, if it exists.
Migration::SOURCE		constant	Indicate whether the primary system of record for this migration is the source, or the destination (Drupal). In the source case, migration of an existing object will completely replace the Drupal object with data from the source side. In the…
Migration::sourceCount	public	function	Convenience function to return count of total source records
Migration::updateCount	public	function	Get the number of records marked as needing update.
Migration::__construct	public	function	General initialization of a Migration object. Overrides MigrationBase::__construct	8
MigrationBase::$currentMigration	protected static	property	Track the migration currently running, so handlers can easily determine it without having to pass a Migration object everywhere.
MigrationBase::$dependencies	protected	property	List of other Migration classes which should be imported before this one. E.g., a comment migration class would typically have node and user migrations as dependencies.
MigrationBase::$description	protected	property	Detailed information describing the migration.
MigrationBase::$displayFunction	protected static	property	Name of a function for displaying feedback. It must take the message to display as its first argument, and a (string) message type as its second argument (see drush_log()).
MigrationBase::$enabled	protected	property	Disabling a migration prevents it from running with --all, or individually without --force
MigrationBase::$group	protected	property	The name of a migration group, used to collect related migrations.
MigrationBase::$issuePattern	protected	property	If provided, an URL for an issue tracking system containing :id where the issue number will go (e.g., 'http://example.com/project/ticket/:id').
MigrationBase::$logHistory	protected	property	Whether to maintain a history of migration processes in migrate_log
MigrationBase::$logID	protected	property	Primary key of the current history record (inserted at the beginning of a process, to be updated at the end)
MigrationBase::$machineName	protected	property	The machine name of this Migration object, derived by removing the 'Migration' suffix from the class name. Used to construct default map/message table names, displayed in drush migrate-status, key to migrate_status table...
MigrationBase::$memoryLimit	protected	property	The PHP memory_limit expressed in bytes.
MigrationBase::$memoryThreshold	protected	property	The fraction of the memory limit at which an operation will be interrupted. Can be overridden by a Migration subclass if one would like to push the envelope. Defaults to 85%.
MigrationBase::$migrations	protected static	property
MigrationBase::$options	protected	property	Save options passed to current operation
MigrationBase::$previousErrorHandler	protected	property	If we set an error handler (during import), remember the previous one so it can be restored.
MigrationBase::$processing	protected	property	Indicates that we are processing a rollback or import - used to avoid excess writes in endProcess()
MigrationBase::$starttime	protected	property	When the current operation started.
MigrationBase::$status	protected	property	Are we importing, rolling back, or doing nothing?
MigrationBase::$team	protected	property	MigrateTeamMember objects representing people involved with this migration.
MigrationBase::$timeLimit	protected	property	The PHP max_execution_time.
MigrationBase::$timeThreshold	protected	property	The fraction of the time limit at which an operation will be interrupted. Can be overridden by a Migration subclass if one would like to push the envelope. Defaults to 90%.
MigrationBase::$total_processed	protected	property	Number of "items" processed in the current migration process (whatever that means for the type of process)
MigrationBase::currentMigration	public static	function
MigrationBase::dependenciesComplete	protected	function	Reports whether all (hard) dependencies have completed migration
MigrationBase::displayMessage	public static	function	Output the given message appropriately (drush_print/drupal_set_message/etc.)
MigrationBase::errorHandler	public	function	Custom PHP error handler. TODO: Redundant with hook_watchdog?
MigrationBase::generateMachineName	protected	function	By default, the migration machine name is the class name (with the Migration suffix, if present, stripped).
MigrationBase::getDependencies	public	function
MigrationBase::getDescription	public	function
MigrationBase::getEnabled	public	function
MigrationBase::getGroup	public	function
MigrationBase::getHardDependencies	public	function
MigrationBase::getHighwater	public	function	Fetch the current highwater mark for updated content.
MigrationBase::getInstance	public static	function	Return the single instance of the given migration.
MigrationBase::getIssuePattern	public	function
MigrationBase::getItemLimit	public	function
MigrationBase::getLastImported	public	function	Retrieve the last time an import operation completed successfully.
MigrationBase::getLastThroughput	public	function	Retrieve the last throughput for current Migration (items / minute).
MigrationBase::getMachineName	public	function
MigrationBase::getMessageLevelName	public	function	Get human readable name for a message constant.
MigrationBase::getOption	public	function
MigrationBase::getSoftDependencies	public	function
MigrationBase::getStatus	public	function	Check the current status of a migration.
MigrationBase::getTeam	public	function
MigrationBase::getTimeLimit	public	function
MigrationBase::handleException	public	function	Takes an Exception object and both saves and displays it, pulling additional information on the location triggering the exception.
MigrationBase::incompleteDependencies	public	function	Returns an array of the migration's dependencies that are incomplete.
MigrationBase::isDynamic	public static	function	Identifies whether this migration is "dynamic" (that is, allows multiple instances distinguished by differing parameters). A dynamic class should override this with a return value of TRUE.	1
MigrationBase::loggingCallback	public	function	Database logging callback - called when there's a database error. We log non-critical stuff, and throw an exception otherwise TODO: Eliminate in favor of hook_watchdog()?
MigrationBase::machineFromClass	protected static	function
MigrationBase::memoryExceeded	protected	function	Test whether we've exceeded the desired memory threshold. If so, output a message.
MigrationBase::MESSAGE_ERROR		constant	Message types to be passed to saveMessage() and saved in message tables. MESSAGE_INFORMATIONAL represents a condition that did not prevent the operation from succeeding - all others represent different severities of conditions resulting in a source…
MigrationBase::MESSAGE_INFORMATIONAL		constant
MigrationBase::MESSAGE_NOTICE		constant
MigrationBase::MESSAGE_WARNING		constant
MigrationBase::processImport	public	function	Perform an operation during the import phase
MigrationBase::processRollback	public	function	Perform an operation during the rollback phase.
MigrationBase::registerMigration	public static	function	Register a new migration process in the migrate_status table. This will generally be used in two contexts - by the class detection code for static (one instance per class) migrations, and by the module implementing dynamic (parameterized class)…
MigrationBase::resetMigrations	public static	function	Clear the cached list of migration objects.
MigrationBase::resetStatus	public	function	Reset the status of the migration to IDLE (to be used when the status gets stuck, e.g. if a process core-dumped)
MigrationBase::RESULT_COMPLETED		constant	Codes representing the result of a rollback or import process.
MigrationBase::RESULT_DISABLED		constant
MigrationBase::RESULT_FAILED		constant
MigrationBase::RESULT_INCOMPLETE		constant
MigrationBase::RESULT_SKIPPED		constant
MigrationBase::RESULT_STOPPED		constant
MigrationBase::saveHighwater	protected	function	Save the highwater mark for this migration (but not when using an idlist).
MigrationBase::setDisplayFunction	public static	function
MigrationBase::staticInitialize	public static	function	Initialize static members, before any class instances are created.
MigrationBase::STATUS_DISABLED		constant
MigrationBase::STATUS_IDLE		constant	Codes representing the current status of a migration, and stored in the migrate_status table.
MigrationBase::STATUS_IMPORTING		constant
MigrationBase::STATUS_ROLLING_BACK		constant
MigrationBase::STATUS_STOPPING		constant
MigrationBase::stopProcess	public	function	Signal that any current import or rollback process should end itself at the earliest opportunity
MigrationBase::timeExceeded	protected	function	Test whether we're approaching the PHP time limit.
MigrationBase::timeOptionExceeded	protected	function	Test whether we've exceeded the designated time limit.
MigrationBase::timestamp	public static	function	Convert an incoming string (which may be a UNIX timestamp, or an arbitrarily-formatted date/time string) to a UNIX timestamp.
XMLMigration::addFieldMapping	public	function	Override the default addFieldMapping(), so we can create our special field mapping class. TODO: Find a cleaner way to just substitute a different mapping class Overrides Migration::addFieldMapping
XMLMigration::applyMappings	protected	function	A normal $data_row has all the input data as top-level fields - in this case, however, the data is embedded within a SimpleXMLElement object in $data_row->xml. Explode that out to the normal form, and pass on to the normal implementation. Overrides Migration::applyMappings
XMLMigration::applyXpath	public	function	Default implementation - straightforward xpath application

You are here

abstract class XMLMigration in Migrate 6.2

Hierarchy

File

Members

API Navigation