coffee.hooks.inc in Coffee 7

The hooks that are used by Coffee includes an example of hook_coffee_command()

File

coffee.hooks.inc

<?php

/**
 * @file
 * The hooks that are used by Coffee
 * includes an example of hook_coffee_command()
 */

/**
 * The default implementation of Coffee.
 * It will look in the menu_links table for administrative links based on
 * the user input.
 *
 * @param string $input
 *   The user input that will be used to query the database.
 */
function coffee_redirect($input) {

  // Glue the arguments together if there are more than 3 arguments.
  // This happens when the user $input typed a / in the input field.
  $arguments = arg();
  if (count($arguments) > 3) {
    $argument_query = array_splice($arguments, 3);
    $input = implode('/', $argument_query);
  }
  $input = '%' . check_plain($input) . '%';

  // Build the query for the result set.
  // Look up items in the menu_links table.
  // Limit the result set to 7.
  $query = db_select('menu_links', 'ml');

  // Join menu_router table, for the menu link description.
  $query
    ->innerJoin('menu_router', 'mr', 'ml.link_path = mr.path');
  $query
    ->fields('ml', array(
    'link_path',
    'link_title',
  ));

  // Look for management links and devel (if it is installed).
  $query
    ->condition('ml.menu_name', array(
    'management',
    'devel',
  ))
    ->condition(db_or()
    ->condition('ml.link_path', $input, 'LIKE')
    ->condition('ml.link_title', $input, 'LIKE')
    ->condition('mr.description', $input, 'LIKE'))
    ->condition('ml.link_path', '%\\%%', 'NOT LIKE')
    ->condition('ml.link_path', '%help%', 'NOT LIKE')
    ->condition('ml.link_title', '%%', '<>')
    ->orderBy('ml.link_title', 'ASC');

  // Execute the query above.
  $result = $query
    ->execute();
  if (is_object($result)) {
    $return = array();
    foreach ($result as $record) {

      // Load the menu item and check if the user has persmission.
      $item = menu_get_item($record->link_path);

      // Only add items to the return array if the user has access.
      if ($item['access']) {
        $match = array(
          'path' => $record->link_path,
          'title' => $record->link_title,
        );

        // Make this the top item if the title is an exact match.
        if (drupal_strtolower(trim($record->link_title)) == drupal_strtolower(trim($input, '% '))) {
          array_unshift($return, $match);
        }
        else {
          $return[] = $match;
        }
      }
    }
  }
  else {
    return FALSE;
  }

  // Return only a slice of a maximum of 7 results.
  if (is_array($return)) {
    $number_of_items = variable_get('coffee_number_of_results', 7);
    $return = array_slice($return, 0, $number_of_items);
  }
  return $return;
}

/**
 * Implements hook_coffee_command().
 */
function coffee_coffee_command($op) {
  switch ($op) {

    // Example usage of how a result array should be formatted.
    case 'help':
      $return['help'] = array(
        'path' => 'admin/help/coffee',
        'title' => 'Coffee Help',
      );
      break;

    // Display the links of the node/add page.
    case 'add':

      // This method is used in the core nodes module.
      $path = 'node/add';
      $item = menu_get_item($path);
      $content_types = system_admin_menu_block($item);
      $return = array();
      foreach ($content_types as $content_type) {
        $return[] = array(
          'path' => $content_type['link_path'],
          'title' => $content_type['link_title'],
        );
      }
      break;
  }
  if (isset($return)) {
    return $return;
  }
}

Functions

Name	Description
coffee_coffee_command	Implements hook_coffee_command().
coffee_redirect	The default implementation of Coffee. It will look in the menu_links table for administrative links based on the user input.