function commerce_recurring_rules_get_due_items in Commerce Recurring Framework 7.2

Return recurring entities with due dates.

1 string reference to 'commerce_recurring_rules_get_due_items'

commerce_recurring_rules_action_info in ./commerce_recurring.rules.inc

Implements hook_rules_action_info().

File

./commerce_recurring.rules.inc, line 408

Rules integration for recurring entities.

Code

function commerce_recurring_rules_get_due_items($number_items = 0, $due_date = NULL) {
  if (empty($due_date)) {
    $due_date = new DateObject();
    $due_date = $due_date
      ->getTimestamp();
  }
  $query = new EntityFieldQuery();
  $query
    ->entityCondition('entity_type', 'commerce_recurring', '=');
  $query
    ->propertyCondition('status', TRUE, '=');
  $query
    ->propertyCondition('due_date', $due_date, '<');
  if ($number_items > 0) {
    $query
      ->range(0, $number_items);
  }
  $result = $query
    ->execute();
  $recurring_entities = array();
  if (!empty($result['commerce_recurring'])) {
    foreach ($result['commerce_recurring'] as $recurring_entity) {
      $recurring_entities[] = entity_load_single('commerce_recurring', $recurring_entity->id);
    }
  }
  return array(
    'commerce_recurring_entities' => $recurring_entities,
  );
}