class MigrateDestinationUserRelationships in Migrate Extras 7.2

Destination class implementing migration into user_relationships table.

Hierarchy

• class \MigrateDestination
  • class \MigrateDestinationUserRelationships

File

./user_relationships.inc, line 11

Import User Relationships.

class MigrateDestinationUserRelationships extends MigrateDestination {
  protected $typeID;
  protected $typeName;

  /**
   * Construct a destination for the specified user relationship type. Interprets
   * the type as a type name - if that fails, assumes it's a type ID (rtid).
   *
   * @param mixed $type_name
   *  Name of a user relationship type, or its rtid.
   */
  public function __construct($type_name) {
    parent::__construct();
    $type = user_relationships_type_load(array(
      'name' => $type_name,
    ));
    if ($type) {
      $this->typeName = $type_name;
      $this->typeID = $type->rtid;
    }
    else {
      $type = user_relationships_type_load($type_name);
      $this->typeName = $type->name;
      $this->typeID = $type_name;
    }
  }
  public static function getKeySchema() {
    return array(
      'rid' => array(
        'type' => 'int',
        'not null' => TRUE,
        'description' => 'Relationship ID',
      ),
    );
  }

  /**
   * Delete a membership.
   *
   * @param $id
   *  ID to be deleted.
   */
  public function rollback(array $id) {
    migrate_instrument_start(__METHOD__);
    if ($relationship = user_relationships_load(array(
      'rid' => $id['destid1'],
    ))) {
      $account = new stdClass();
      user_relationships_delete_relationship(current($relationship), $account);
    }
    migrate_instrument_stop(__METHOD__);
  }

  /**
   * Import a single membership.
   *
   * @param $entity
   *  Object object to build. Prefilled with any fields mapped in the Migration.
   * @param $row
   *  Raw source data object - passed through to prepare/complete handlers.
   * @return array
   *  Array of key fields of the object that was saved if
   *  successful. FALSE on failure.
   */
  public function import(stdClass $entity, stdClass $row) {

    // Normalize to unix timestamps.
    foreach (array(
      'created_at',
      'updated_at',
    ) as $property) {
      if (isset($entity->{$property})) {
        $entity->{$property} = Migration::timestamp($entity->{$property});
      }
    }
    $entity->rtid = $this->typeID;
    $op = isset($entity->op) ? $entity->op : 'approve';
    if ($saved = user_relationships_save_relationship($entity, $op)) {
      return array(
        $saved->rid,
      );
    }
  }
  public function fields() {
    return array(
      'rid' => 'Relationship ID',
      'requester_id' => 'User ID of relationship requestor',
      'requestee_id' => 'User ID of relationship requestee',
      'approved' => 'Whether the requestee approved the relationship',
      'created_at' => 'Timestamp when the relationship was created',
      'updated_at' => 'Timestamp when the relationship was last updated',
      'flags' => 'UR_OK (0) or UR_BANNED (1)',
      'op' => 'Default value is \'approve\'. Sent as second param to user_relationships_save_relationship().',
    );
  }
  public function __toString() {
    return t('User relationship type: !type', array(
      '!type' => $this->typeName,
    ));
  }

}

Members

Name	Modifiers	Type	Description	Overrides
MigrateDestination::$numCreated	protected	property	Maintain stats on the number of destination objects created or updated.
MigrateDestination::$numUpdated	protected	property
MigrateDestination::getCreated	public	function
MigrateDestination::getUpdated	public	function
MigrateDestination::resetStats	public	function	Reset numCreated and numUpdated back to 0.
MigrateDestinationUserRelationships::$typeID	protected	property
MigrateDestinationUserRelationships::$typeName	protected	property
MigrateDestinationUserRelationships::fields	public	function	Derived classes must implement fields(), returning a list of available destination fields. Overrides MigrateDestination::fields
MigrateDestinationUserRelationships::getKeySchema	public static	function
MigrateDestinationUserRelationships::import	public	function	Import a single membership. Overrides MigrateDestination::import
MigrateDestinationUserRelationships::rollback	public	function	Delete a membership.
MigrateDestinationUserRelationships::__construct	public	function	Construct a destination for the specified user relationship type. Interprets the type as a type name - if that fails, assumes it's a type ID (rtid). Overrides MigrateDestination::__construct
MigrateDestinationUserRelationships::__toString	public	function	Derived classes must implement __toString(). Overrides MigrateDestination::__toString