class CommerceOrderEntityController in Commerce Core 7

The controller class for orders contains methods for the order CRUD operations. The load method is inherited from the default controller.

Hierarchy

class \DrupalDefaultEntityController implements DrupalEntityControllerInterface
- class \DrupalCommerceEntityController implements DrupalCommerceEntityControllerInterface
  - class \CommerceOrderEntityController

Expanded class hierarchy of CommerceOrderEntityController

1 string reference to 'CommerceOrderEntityController'

commerce_order_entity_info in modules/order/commerce_order.module: Implements hook_entity_info().

File

modules/order/includes/commerce_order.controller.inc, line 12: The controller for the order entity containing the CRUD operations.

View source

class CommerceOrderEntityController extends DrupalCommerceEntityController {

  /**
   * Create a default order.
   *
   * @param array $values
   *   An array of values to set, keyed by property name.
   *
   * @return
   *   An order object with all default fields initialized.
   */
  public function create(array $values = array()) {
    $values += array(
      'order_id' => NULL,
      'order_number' => NULL,
      'revision_id' => NULL,
      'uid' => '',
      'mail' => !empty($values['uid']) && ($account = user_load($values['uid'])) ? $account->mail : '',
      'data' => array(),
      'created' => '',
      'changed' => '',
      'placed' => '',
      'hostname' => '',
    );
    return parent::create($values);
  }

  /**
   * Saves an order.
   *
   * When saving an order without an order ID, this function will create a new
   * order at that time. For new orders, it will also determine and save the
   * order number and then save the initial revision of the order. Subsequent
   * orders that should be saved as new revisions should set $order->revision to
   * TRUE and include a log string in $order->log.
   *
   * @param $order
   *   The full order object to save.
   * @param $transaction
   *   An optional transaction object.
   *
   * @return
   *   SAVED_NEW or SAVED_UPDATED depending on the operation performed.
   */
  public function save($order, DatabaseTransaction $transaction = NULL) {
    if (!isset($transaction)) {
      $transaction = db_transaction();
      $started_transaction = TRUE;
    }
    try {
      global $user;

      // Determine if we will be inserting a new order.
      $order->is_new = empty($order->order_id);

      // Set the timestamp fields.
      if ($order->is_new) {
        if (empty($order->created)) {
          $order->created = REQUEST_TIME;
        }
        if (empty($order->changed)) {
          $order->changed = REQUEST_TIME;
        }
        if (empty($order->revision_timestamp)) {
          $order->revision_timestamp = REQUEST_TIME;
        }
        if (empty($order->hostname)) {
          $order->hostname = ip_address();
        }
      }
      else {

        // Otherwise if the order is not new but comes from an entity_create()
        // or similar function call that initializes the created timestamp, uid,
        // and hostname values to empty strings, unset them to prevent
        // destroying existing data in those properties on update.
        if ($order->created === '') {
          unset($order->created);
        }
        if ($order->uid === '') {
          unset($order->uid);
        }
        if ($order->hostname === '') {
          unset($order->hostname);
        }
        $time = time();
        $order->changed = $time;
        $order->revision_timestamp = $time;
      }
      $order->revision_hostname = ip_address();
      $order->revision_uid = $user->uid;

      // Recalculate the order total using the current line item data.
      commerce_order_calculate_total($order);
      if ($order->is_new || !empty($order->revision)) {

        // When inserting either a new order or revision, $order->log must be set
        // because {commerce_order_revision}.log is a text column and therefore
        // cannot have a default value. However, it might not be set at this
        // point, so we ensure that it is at least an empty string in that case.
        if (!isset($order->log)) {
          $order->log = '';
        }
      }
      elseif (empty($order->log)) {

        // If we are updating an existing order without adding a new revision,
        // we need to make sure $order->log is unset whenever it is empty. As
        // long as $order->log is unset, drupal_write_record() will not attempt
        // to update the existing database column when re-saving the revision.
        unset($order->log);
      }
      return parent::save($order, $transaction);
    } catch (Exception $e) {
      if (!empty($started_transaction)) {
        $transaction
          ->rollback();
        watchdog_exception($this->entityType, $e);
      }
      throw $e;
    }
  }

  /**
   * Unserializes the data property of loaded orders.
   */
  public function attachLoad(&$queried_orders, $revision_id = FALSE) {
    foreach ($queried_orders as $order_id => &$order) {
      $order->data = unserialize($order->data);
    }

    // Call the default attachLoad() method. This will add fields and call
    // hook_commerce_order_load().
    parent::attachLoad($queried_orders, $revision_id);
  }

  /**
   * Deletes multiple orders by ID.
   *
   * @param $order_ids
   *   An array of order IDs to delete.
   * @param $transaction
   *   An optional transaction object.
   *
   * @return boolean
   *   TRUE on success, FALSE otherwise.
   */
  public function delete($order_ids, DatabaseTransaction $transaction = NULL) {
    if (!empty($order_ids)) {
      $orders = $this
        ->load($order_ids, array());

      // Ensure the orders can actually be deleted.
      foreach ((array) $orders as $order_id => $order) {
        if (in_array(FALSE, module_invoke_all('commerce_order_can_delete', $order))) {
          unset($orders[$order_id]);
        }
      }

      // If none of the specified orders can be deleted, return FALSE.
      if (empty($orders)) {
        return FALSE;
      }
      parent::delete($order_ids, $transaction);
      return TRUE;
    }
    else {
      return FALSE;
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CommerceOrderEntityController::attachLoad	public	function	Unserializes the data property of loaded orders. Overrides DrupalDefaultEntityController::attachLoad
CommerceOrderEntityController::create	public	function	Create a default order. Overrides DrupalCommerceEntityController::create
CommerceOrderEntityController::delete	public	function	Deletes multiple orders by ID. Overrides DrupalCommerceEntityController::delete
CommerceOrderEntityController::save	public	function	Saves an order. Overrides DrupalCommerceEntityController::save
DrupalCommerceEntityController::$controllerTransaction	protected	property	Stores our transaction object, necessary for pessimistic locking to work.
DrupalCommerceEntityController::$lockedEntities	protected	property	Stores the ids of locked entities, necessary for knowing when to release a lock by committing the transaction.
DrupalCommerceEntityController::$unchangedEntities	protected	property	Stores the ids of unchanged entities, necessary for knowing if we're dealing with unchanged entities before acting on them.
DrupalCommerceEntityController::buildContent	public	function	Builds a structured array representing the entity's content. Overrides EntityAPIControllerInterface::buildContent	2
DrupalCommerceEntityController::buildQuery	protected	function	Override of DrupalDefaultEntityController::buildQuery(). Overrides DrupalDefaultEntityController::buildQuery
DrupalCommerceEntityController::export	public	function	Implements EntityAPIControllerInterface. Overrides EntityAPIControllerInterface::export
DrupalCommerceEntityController::import	public	function	Implements EntityAPIControllerInterface. Overrides EntityAPIControllerInterface::import
DrupalCommerceEntityController::invoke	public	function	(Internal use) Invokes a hook on behalf of the entity. Overrides EntityAPIControllerInterface::invoke
DrupalCommerceEntityController::isUnchanged	public	function	Implements DrupalCommerceEntityControllerInterface::isUnchanged(). Overrides DrupalCommerceEntityControllerInterface::isUnchanged
DrupalCommerceEntityController::releaseLock	protected	function	Checks the list of tracked locked entities, and if it's empty, commits the transaction in order to remove the acquired locks.
DrupalCommerceEntityController::resetCache	public	function	Implements DrupalEntityControllerInterface::resetCache(). Overrides DrupalDefaultEntityController::resetCache
DrupalCommerceEntityController::view	public	function	Generate an array for rendering the given entities. Overrides EntityAPIControllerInterface::view
DrupalDefaultEntityController::$cache	protected	property	Whether this entity type should use the static cache.
DrupalDefaultEntityController::$entityCache	protected	property	Static cache of entities, keyed by entity ID.
DrupalDefaultEntityController::$entityInfo	protected	property	Array of information about the entity.
DrupalDefaultEntityController::$entityType	protected	property	Entity type for this controller instance.
DrupalDefaultEntityController::$hookLoadArguments	protected	property	Additional arguments to pass to hook_TYPE_load().
DrupalDefaultEntityController::$idKey	protected	property	Name of the entity's ID field in the entity database table.
DrupalDefaultEntityController::$revisionKey	protected	property	Name of entity's revision database table field, if it supports revisions.
DrupalDefaultEntityController::$revisionTable	protected	property	The table that stores revisions, if the entity supports revisions.
DrupalDefaultEntityController::cacheGet	protected	function	Gets entities from the static cache.	1
DrupalDefaultEntityController::cacheSet	protected	function	Stores entities in the static entity cache.
DrupalDefaultEntityController::cleanIds	protected	function	Ensures integer entity IDs are valid.
DrupalDefaultEntityController::filterId	protected	function	Callback for array_filter that removes non-integer IDs.
DrupalDefaultEntityController::load	public	function	Implements DrupalEntityControllerInterface::load(). Overrides DrupalEntityControllerInterface::load
DrupalDefaultEntityController::__construct	public	function	Constructor: sets basic variables.

You are here

class CommerceOrderEntityController in Commerce Core 7

Hierarchy

File

Members

API Navigation