class MigrateRedirectEntityHandler in Redirect 7

@file Migrate support for Redirect module.

Hierarchy

• class \MigrateHandler
  • class \MigrateDestinationHandler
    • class \MigrateRedirectEntityHandler

1 string reference to 'MigrateRedirectEntityHandler'

redirect_migrate_api in ./redirect.migrate.inc

Implements hook_migrate_api().

File

./redirect.migrate.inc, line 8

Migrate support for Redirect module.

class MigrateRedirectEntityHandler extends MigrateDestinationHandler {

  /**
   * Constructor.
   */
  public function __construct() {
    $this
      ->registerTypes(array(
      'entity',
    ));
  }

  /**
   * Overrides fields().
   */
  public function fields() {
    return array(
      'migrate_redirects' => t('Original path(s) to redirect from.'),
      'migrate_redirects_language' => t('The language this redirect applies to.'),
    );
  }

  /**
   * Validates a redirect.
   *
   * We need to check if a redirect already exists. Calling redirect_save on an
   * already existing redirect will throw a db error due to duplicate entries.
   *
   * This function is similar to the validate function in the redirect module
   * but the feedback is handled via the Migrate's saveMessage functionality.
   *
   * @return bool
   *   TRUE if the redirect is valid and can be saved.
   */
  protected function redirectValidate($redirect) {
    $redirect = (object) $redirect;

    // Check that there there are no redirect loops.
    $migration = Migration::currentMigration();
    if (url($redirect->source) == url($redirect->redirect)) {
      $migration
        ->saveMessage(t('Redirect to self (!redirect) ignored', array(
        '!redirect' => $redirect->redirect,
      )), MigrationBase::MESSAGE_INFORMATIONAL);
      return FALSE;
    }
    redirect_hash($redirect);
    if ($existing = redirect_load_by_hash($redirect->hash)) {
      if ($redirect->rid != $existing->rid) {
        $migration
          ->saveMessage(t('The source path is already being redirected.'), MigrationBase::MESSAGE_INFORMATIONAL);
        return FALSE;
      }
    }
    return TRUE;
  }

  /**
   * Get redirects from entity or row.
   */
  protected function getRedirects($entity, $row) {

    // If there are multiple redirects defined for the entity, they will be in
    // $row. If there is just one, it will be in $entity.
    if (!empty($row->migrate_redirects)) {
      $migrate_redirects = $row->migrate_redirects;
    }
    else {
      $migrate_redirects = isset($entity->migrate_redirects) ? $entity->migrate_redirects : NULL;
    }

    // If it is not an array already, make it one now.
    if ($migrate_redirects && !is_array($migrate_redirects)) {
      $migrate_redirects = array(
        $migrate_redirects,
      );
    }
    return $migrate_redirects;
  }

  /**
   * Determine the language for the current redirect.
   *
   * Look for a language setting in this order:
   * - specified in the migration mapping
   * - migration-specific language defined on the entity
   * - entity language
   * - default to LANGUAGE_NONE.
   *
   * @param object $entity
   *   The Drupal entity.
   * @param object $row
   *   The row being migrated.
   *
   * @return string
   *   a language code
   */
  protected function getRedirectLanguage($entity, $row) {
    if (!empty($row->migrate_redirects_language)) {
      $language = $row->migrate_redirects_language;
    }
    elseif (!empty($entity->migrate_redirects_language)) {
      $language = $entity->migrate_redirects_language;
    }
    elseif (!empty($entity->language)) {
      $language = $entity->language;
    }
    else {
      $language = LANGUAGE_NONE;
    }
    return $language;
  }

  /**
   * Overrides complete().
   *
   * @param object $entity
   *   The Drupal entity.
   * @param stdClass $row
   *   The row being migrated.
   */
  public function complete($entity, stdClass $row) {
    $migration = Migration::currentMigration();
    $destination = $migration
      ->getDestination();
    $entity_type = $destination
      ->getEntityType();
    $migrate_redirects = $this
      ->getRedirects($entity, $row);
    $redirect_destination = entity_uri($entity_type, $entity);

    // We looked up the destination entity_type in the constructor.
    if (!empty($migrate_redirects) && !empty($redirect_destination)) {
      foreach ($migrate_redirects as $path) {
        $redirect_defaults = array(
          'status_code' => 301,
        );
        if (isset($entity->uid)) {
          $redirect_defaults['uid'] = $entity->uid;
        }
        $redirect_defaults['language'] = $this
          ->getRedirectLanguage($entity, $row);
        $redirect = new stdClass();
        redirect_object_prepare($redirect, $redirect_defaults);
        $redirect->redirect = $redirect_destination['path'];
        $parsed = redirect_parse_url($path);
        $redirect->source = isset($parsed['path']) ? ltrim($parsed['path'], '/') : '';
        if (!empty($parsed['query'])) {
          $redirect->source_options['query'] = $parsed['query'];
        }

        // Only save if the redirect does not already exist.
        if ($this
          ->redirectValidate($redirect)) {
          redirect_save($redirect);
        }
      }
    }
    elseif (!empty($migrate_redirects) && empty($redirect_destination)) {
      $migration
        ->saveMessage(t('The redirect path is empty.'), MigrationBase::MESSAGE_INFORMATIONAL);
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
MigrateHandler::$dependencies	protected	property	List of other handler classes which should be invoked before the current one.
MigrateHandler::$typesHandled	protected	property	List of "types" handled by this handler. Depending on the kind of handler, these may be destination types, field types, etc.
MigrateHandler::getDependencies	public	function
MigrateHandler::getTypesHandled	public	function
MigrateHandler::handlesType	public	function	Does this handler handle the given type?	1
MigrateHandler::registerTypes	protected	function	Register a list of types handled by this class
MigrateRedirectEntityHandler::complete	public	function	Overrides complete().
MigrateRedirectEntityHandler::fields	public	function	Overrides fields().
MigrateRedirectEntityHandler::getRedirectLanguage	protected	function	Determine the language for the current redirect.
MigrateRedirectEntityHandler::getRedirects	protected	function	Get redirects from entity or row.
MigrateRedirectEntityHandler::redirectValidate	protected	function	Validates a redirect.
MigrateRedirectEntityHandler::__construct	public	function	Constructor. Overrides MigrateHandler::__construct