checklistapi.drush.inc in Checklist API 7

Drush commands for the Checklist API module.

File

checklistapi.drush.inc

<?php

/**
 * @file
 * Drush commands for the Checklist API module.
 */

/**
 * Implements hook_drush_command().
 */
function checklistapi_drush_command() {
  $items = array();

  // Table formatting isn't available until Drush 6.
  if (function_exists('drush_format_table')) {
    $items['checklistapi-list'] = array(
      'aliases' => array(
        'capi-list',
        'capil',
      ),
      'description' => 'Get an overview of your installed checklists with progress details.',
    );
    $items['checklistapi-info'] = array(
      'aliases' => array(
        'capi-info',
        'capii',
      ),
      'description' => 'Show detailed info for a given checklist.',
      'arguments' => array(
        'checklist' => 'The checklist machine name, e.g., "example_checklist".',
      ),
      'required-arguments' => TRUE,
    );
  }
  return $items;
}

/**
 * Implements hook_drush_help().
 */
function checklistapi_drush_help($section) {
  switch ($section) {
    case 'meta:checklistapi:title':
      return dt('Checklist API commands');
  }
}

/**
 * Drush callback for checklist listing.
 */
function drush_checklistapi_list() {
  $definitions = checklistapi_get_checklist_info();
  if (empty($definitions)) {
    return drush_print(dt('No checklists available.'));
  }

  // Build table rows.
  $rows = array();

  // The first row is the table header.
  $rows[] = array(
    dt('Checklist'),
    dt('Progress'),
    dt('Last updated'),
    dt('Last updated by'),
  );
  foreach ($definitions as $id => $definition) {
    $checklist = checklistapi_checklist_load($id);
    $row = array();
    $row[] = dt('!title (!id)', array(
      '!title' => strip_tags($checklist->title),
      '!id' => $id,
    ));
    $row[] = dt('@completed of @total (@percent%)', array(
      '@completed' => $checklist
        ->getNumberCompleted(),
      '@total' => $checklist
        ->getNumberOfItems(),
      '@percent' => round($checklist
        ->getPercentComplete()),
    ));
    $row[] = $checklist
      ->getLastUpdatedDate();
    $row[] = strip_tags($checklist
      ->getLastUpdatedUser());
    $rows[] = $row;
  }
  return drush_format_table($rows, TRUE);
}

/**
 * Implements drush_hook_COMMAND_validate().
 *
 * @see drush_checklistapi_info()
 */
function drush_checklistapi_info_validate() {
  $arguments = drush_get_arguments();
  $id = $arguments[1];
  $checklist = checklistapi_checklist_load($id);

  // Make sure the given checklist exists.
  if (!$checklist) {
    drush_set_error('CHECKLISTAPI_INVALID_ARGUMENT', dt('No such checklist "!id".', array(
      '!id' => $id,
    )));
  }
  drush_set_context('checklist', $checklist);
}

/**
 * Drush callback for checklist info.
 */
function drush_checklistapi_info() {
  $checklist = drush_get_context('checklist');

  // Print the help.
  if (!empty($checklist->help)) {
    drush_print(strip_tags($checklist->help));
  }

  // Print last updated and progress details.
  if ($checklist
    ->hasSavedProgress()) {
    drush_print('');
    drush_print(dt('Last updated @date by !user', array(
      '@date' => $checklist
        ->getLastUpdatedDate(),
      '!user' => strip_tags($checklist
        ->getLastUpdatedUser()),
    )));
    drush_print(dt('@completed of @total (@percent%) complete', array(
      '@completed' => $checklist
        ->getNumberCompleted(),
      '@total' => $checklist
        ->getNumberOfItems(),
      '@percent' => round($checklist
        ->getPercentComplete()),
    )));
  }

  // Loop through groups.
  $groups = $checklist->items;
  foreach (element_children($groups) as $group_key) {
    $group =& $groups[$group_key];

    // Print group title.
    drush_print('');
    drush_print(strip_tags($group['#title']) . ':');

    // Loop through items.
    foreach (element_children($group) as $item_key) {
      $item =& $group[$item_key];
      $saved_item = !empty($checklist->savedProgress[$item_key]) ? $checklist->savedProgress[$item_key] : 0;

      // Build title.
      $title = strip_tags($item['#title']);
      if ($saved_item) {

        // Append completion details.
        $user = user_load($saved_item['#uid']);
        $title .= dt(' - Completed @time by !user', array(
          '@time' => format_date($saved_item['#completed'], 'short'),
          '!user' => strip_tags($user->name),
        ));
      }

      // Print the list item.
      drush_print(dt(' [!x] !title', array(
        '!x' => $saved_item ? 'x' : ' ',
        '!title' => $title,
      )));
    }
  }
}

Functions

Name	Description
checklistapi_drush_command	Implements hook_drush_command().
checklistapi_drush_help	Implements hook_drush_help().
drush_checklistapi_info	Drush callback for checklist info.
drush_checklistapi_info_validate	Implements drush_hook_COMMAND_validate().
drush_checklistapi_list	Drush callback for checklist listing.