You are here

function checklistapi_get_checklist_info in Checklist API 7

Same name and namespace in other branches
  1. 8 checklistapi.module \checklistapi_get_checklist_info()

Gets checklist definitions.

Parameters

string $id: (optional) A checklist ID. Defaults to NULL.

Return value

array|false The definition of the specified checklist, or FALSE if no such checklist exists, or an array of all checklist definitions if none is specified.

7 calls to checklistapi_get_checklist_info()
ChecklistapiChecklist::saveProgress in lib/Drupal/checklistapi/ChecklistapiChecklist.php
Saves checklist progress to a Drupal variable.
checklistapi_checklist_load in ./checklistapi.module
Loads a checklist object.
checklistapi_help in ./checklistapi.module
Implements hook_help().
checklistapi_menu in ./checklistapi.module
Implements hook_menu().
checklistapi_permission in ./checklistapi.module
Implements hook_permission().

... See full list

File

./checklistapi.module, line 62
An API for creating fillable, persistent checklists.

Code

function checklistapi_get_checklist_info($id = NULL) {
  $definitions =& drupal_static(__FUNCTION__);
  if (!isset($definitions)) {

    // Get definitions.
    $definitions = module_invoke_all('checklistapi_checklist_info');
    $definitions = checklistapi_sort_array($definitions);

    // Let other modules alter them.
    drupal_alter('checklistapi_checklist_info', $definitions);
    $definitions = checklistapi_sort_array($definitions);

    // Inject checklist IDs.
    foreach ($definitions as $key => $value) {
      $definitions[$key] = array(
        '#id' => $key,
      ) + $definitions[$key];
    }
  }
  if (!empty($id)) {
    return !empty($definitions[$id]) ? $definitions[$id] : FALSE;
  }
  return $definitions;
}