entity_test.module

<?php

/**
 * @file
 * Test moduel for the entity API.
 */

/**
 * Implements hook_entity_info().
 */
function entity_test_entity_info() {
  $return = array(
    'entity_test' => array(
      'label' => t('Test Entity'),
      'plural label' => t('Test Entities'),
      'description' => t('An entity type used by the entity API tests.'),
      'entity class' => 'EntityClass',
      'controller class' => 'EntityAPIController',
      'base table' => 'entity_test',
      'fieldable' => TRUE,
      'entity keys' => array(
        'id' => 'pid',
        'bundle' => 'name',
      ),
      // Make use the class' label() and uri() implementation by default.
      'label callback' => 'entity_class_label',
      'uri callback' => 'entity_class_uri',
      'bundles' => array(),
      'bundle keys' => array(
        'bundle' => 'name',
      ),
      'module' => 'entity_test',
    ),
    'entity_test_type' => array(
      'label' => t('Test entity type'),
      'entity class' => 'Entity',
      'controller class' => 'EntityAPIControllerExportable',
      'base table' => 'entity_test_type',
      'fieldable' => FALSE,
      'bundle of' => 'entity_test',
      'exportable' => TRUE,
      'entity keys' => array(
        'id' => 'id',
        'name' => 'name',
      ),
      'module' => 'entity_test',
    ),

    'entity_test2' => array(
      'label' => t('Test Entity (revision support)'),
      'entity class' => 'EntityClassRevision',
      'controller class' => 'EntityAPIController',
      'base table' => 'entity_test2',
      'revision table' => 'entity_test2_revision',
      'fieldable' => TRUE,
      'entity keys' => array(
        'id' => 'pid',
        'revision' => 'revision_id',
      ),
      // Make use of the class label() and uri() implementation by default.
      'label callback' => 'entity_class_label',
      'uri callback' => 'entity_class_uri',
      'bundles' => array(),
      'bundle keys' => array(
        'bundle' => 'name',
      ),
    ),
  );

  // Add bundle info but bypass entity_load() as we cannot use it here.
  $types = db_select('entity_test_type', 'et')
    ->fields('et')
    ->execute()
    ->fetchAllAssoc('name');

  foreach ($types as $name => $type) {
    $return['entity_test']['bundles'][$name] = array(
      'label' => $type->label,
    );
  }

  // Support entity cache module.
  if (module_exists('entitycache')) {
    $return['entity_test']['field cache'] = FALSE;
    $return['entity_test']['entity cache'] = TRUE;
  }

  return $return;
}

/**
 * Gets an array of all test entity types, keyed by the name.
 *
 * @param $name
 *   If set, the type with the given name is returned.
 */
function entity_test_get_types($name = NULL) {
  $types = entity_load_multiple_by_name('entity_test_type', isset($name) ? array($name) : FALSE);
  return isset($name) ? reset($types) : $types;
}

/**
 * Load multiple test entities based on certain conditions.
 *
 * @param $pids
 *   An array of entity IDs.
 * @param $conditions
 *   An array of conditions to match against the {entity} table.
 * @param $reset
 *   A boolean indicating that the internal cache should be reset.
 * @return
 *   An array of test entity objects, indexed by pid.
 */
function entity_test_load_multiple($pids = array(), $conditions = array(), $reset = FALSE) {
  return entity_load('entity_test', $pids, $conditions, $reset);
}

/**
 * Delete multiple test entities.
 *
 * @param $pids
 *   An array of test entity IDs.
 */
function entity_test_delete_multiple(array $pids) {
  entity_get_controller('entity_test')->delete($pids);
}


/**
 * Main class for test entities.
 */
class EntityClass extends Entity {

  public function __construct(array $values = array(), $entityType = NULL) {
    parent::__construct($values, 'entity_test');
  }

  /**
   * Override buildContent() to add the username to the output.
   */
  public function buildContent($view_mode = 'full', $langcode = NULL) {
    $content['user'] = array(
      '#markup' => "User: ". format_username(user_load($this->uid)),
    );
    return entity_get_controller($this->entityType)->buildContent($this, $view_mode, $langcode, $content);
  }

  /**
   * Specifies the default label, which is picked up by label() by default.
   */
  protected function defaultLabel() {
    $type = entity_test_get_types($this->name);
    return $type->label;
  }

  /**
   * Specifies the default uri, which is picked up by uri() by default.
   */
  protected function defaultURI() {
    return array('path' => 'custom/' . $this->identifier());
  }
}

/**
 * Main class for test entities (with revision support).
 */
class EntityClassRevision extends EntityClass {

  public function __construct(array $values = array(), $entityType = NULL) {
    Entity::__construct($values, 'entity_test2');
  }

}

/**
 *
 *
 * Some hook implementations used by the tests.
 *
 *
 */


/**
 * Implements hook_entity_insert().
 */
function entity_test_entity_insert($entity, $entity_type) {
  if ($entity_type == 'entity_test_type') {
    $_SESSION['entity_hook_test']['entity_insert'][] = entity_id($entity_type, $entity);
  }
}

/**
 * Implements hook_entity_update().
 */
function entity_test_entity_update($entity, $entity_type) {
  $_SESSION['entity_hook_test']['entity_update'][] = entity_id($entity_type, $entity);
}

/**
 * Implements hook_entity_delete().
 */
function entity_test_entity_delete($entity, $entity_type) {
  if ($entity_type == 'entity_test_type') {
    $_SESSION['entity_hook_test']['entity_delete'][] = entity_id($entity_type, $entity);
  }
}

/**
 * Implements hook_entity_test_type_insert().
 */
function entity_test_entity_test_type_insert($entity) {
  $_SESSION['entity_hook_test']['entity_test_type_insert'][] = $entity->identifier();
}

/**
 * Implements hook_entity_test_type_update().
 */
function entity_test_entity_test_type_update($entity) {
  $_SESSION['entity_hook_test']['entity_test_type_update'][] = $entity->identifier();

  // Determine changes on update.
  if (!empty($entity->original) && $entity->original->label == 'test_changes') {
    if ($entity->original->label != $entity->label) {
      $entity->label .= '_update';
    }
  }
}

/**
 * Implements hook_entity_test_type_delete().
 */
function entity_test_entity_test_type_delete($entity) {
  $_SESSION['entity_hook_test']['entity_test_type_delete'][] = $entity->identifier();
}

/**
 * Implements hook_entity_test_type_presave().
 */
function entity_test_entity_test_type_presave($entity) {
  // Determine changes.
  if (!empty($entity->original) && $entity->original->label == 'test_changes') {
    if ($entity->original->label != $entity->label) {
      $entity->label .= '_presave';
    }
  }
}

/**
 * Implements hook_entity_property_info_alter() for testing an property of type
 * 'entity'.
 */
function entity_test_entity_property_info_alter(&$info) {
  $info['node']['properties']['reference'] = array(
    'label' => t('Test reference'),
    'description' => t('A generic entity reference.'),
    'getter callback' => 'entity_test_entity_getter',
    'setter callback' => 'entity_test_entity_setter',
    'type' => 'entity',
  );
}

/**
 * Getter callback for the 'reference' property.
 */
function entity_test_entity_getter($node) {
  if (empty($node->entity)) {
    $node->entity = array('type' => 'user', 'id' => $node->uid);
  }
  // We have to return the entity wrapped.
  return entity_metadata_wrapper($node->entity['type'], $node->entity['id']);
}

/**
 * Setter callback for the 'reference' property.
 */
function entity_test_entity_setter($node, $property_name, $wrapper) {
  // The entity has to be passed wrapped.
  $node->entity = array('type' => $wrapper->type(), 'id' => $wrapper->getIdentifier());
}