commerce_line_item.info.inc in Commerce Core 7

Provides metadata for the line item entity.

File

modules/line_item/commerce_line_item.info.inc

<?php

/**
 * @file
 * Provides metadata for the line item entity.
 */

/**
 * Implements hook_entity_property_info().
 */
function commerce_line_item_entity_property_info() {
  $info = array();

  // Add meta-data about the basic commerce_line_item properties.
  $properties =& $info['commerce_line_item']['properties'];
  $properties['line_item_id'] = array(
    'label' => t('Line item ID'),
    'description' => t('The internal numeric ID of the line item.'),
    'type' => 'integer',
    'schema field' => 'line_item_id',
  );
  $properties['order_id'] = array(
    'label' => t('Order ID', array(), array(
      'context' => 'a drupal commerce order',
    )),
    'type' => 'integer',
    'description' => t('The unique ID of the order the line item belongs to.'),
    'setter callback' => 'entity_property_verbatim_set',
    'setter permission' => 'administer line items',
    'clear' => array(
      'order',
    ),
    'schema field' => 'order_id',
  );
  $properties['order'] = array(
    'label' => t('Order', array(), array(
      'context' => 'a drupal commerce order',
    )),
    'type' => 'commerce_order',
    'description' => t('The order the line item belongs to.'),
    'getter callback' => 'commerce_line_item_get_properties',
    'setter callback' => 'commerce_line_item_set_properties',
    'setter permission' => 'administer line items',
    'required' => TRUE,
    'computed' => TRUE,
    'clear' => array(
      'order_id',
    ),
  );
  $properties['type'] = array(
    'label' => t('Type'),
    'description' => t('The human readable name of the line item type.'),
    'type' => 'token',
    'setter callback' => 'entity_property_verbatim_set',
    'options list' => 'commerce_line_item_type_options_list',
    'required' => TRUE,
    'schema field' => 'type',
  );
  $properties['line_item_label'] = array(
    'label' => t('Line item label'),
    'description' => t('The label displayed with the line item.'),
    'type' => 'text',
    'setter callback' => 'entity_property_verbatim_set',
    'required' => TRUE,
    'schema field' => 'line_item_label',
  );
  $properties['quantity'] = array(
    'label' => t('Quantity'),
    'description' => t('Quantity associated with this line item'),
    'type' => 'decimal',
    'getter callback' => 'entity_property_verbatim_get',
    'setter callback' => 'entity_property_verbatim_set',
    'required' => TRUE,
    'schema field' => 'quantity',
  );
  $properties['created'] = array(
    'label' => t('Date created'),
    'description' => t('The date the line item was created.'),
    'type' => 'date',
    'setter callback' => 'entity_metadata_verbatim_set',
    'setter permission' => 'administer line items',
    'schema field' => 'created',
  );
  $properties['changed'] = array(
    'label' => t('Date changed'),
    'description' => t('The date the line item was most recently updated.'),
    'type' => 'date',
    'schema field' => 'changed',
  );
  $info['commerce_line_item']['bundles'] = array();
  foreach (commerce_line_item_type_get_name() as $type => $name) {
    $info['commerce_line_item']['bundles'][$type] = array(
      'label' => $name,
    );
  }
  return $info;
}

/**
 * Implements hook_entity_property_info_alter() on top of the Line Item module.
 */
function commerce_line_item_entity_property_info_alter(&$info) {

  // Move the price properties to the line item by default; as they are required
  // default fields, this makes dealing with them more convenient.
  $properties = array();
  foreach ($info['commerce_line_item']['bundles'] as $bundle => $bundle_info) {
    $bundle_info += array(
      'properties' => array(),
    );
    $properties += $bundle_info['properties'];
  }
  if (!empty($properties['commerce_unit_price'])) {
    $info['commerce_line_item']['properties']['commerce_unit_price'] = $properties['commerce_unit_price'];
  }
  if (!empty($properties['commerce_total'])) {
    $info['commerce_line_item']['properties']['commerce_total'] = $properties['commerce_total'];
  }
}

Functions

Name	Description
commerce_line_item_entity_property_info	Implements hook_entity_property_info().
commerce_line_item_entity_property_info_alter	Implements hook_entity_property_info_alter() on top of the Line Item module.