shortcut.inc in Patterns 7

Patterns component for shortcut.

There are seven forms in the shortcut module. They can be separated into three kinds: set, link, switch for user.

set(three forms): add a shortcut set: just give a name for the new shortcut set. delete a shortcut set: just supply a shortcut set's name. rename a shortcut set: need two name, one is used to define tht shortcut set which will be modified, the other is the new name.

link(three forms): add a shortcut link: supply the name of a shortcut set which the new link will be in,supply the link's title and path. delete a shortcut link: just give the link's id, the id is in the menu_links table of the database. edit a shortcut link: need the link's id, need the link's new title or/and new path.

switch for user(one forms); need a user's name need a shortcut set'name the user will use the shortcut set.

File

patterns_components/components/shortcut.inc

<?php

/**
 * @file
 * Patterns component for shortcut.
 *
 * There are seven forms in the shortcut module. They can be separated into three kinds:
 * set, link, switch for user.
 *
 * set(three forms):
 *     add a shortcut set: just give a name for the new shortcut set.
 *     delete a shortcut set: just supply a shortcut set's name.
 *     rename a shortcut set: need two name, one is used to define tht shortcut set which will be modified, the other is the new name.
 *
 * link(three forms):
 *     add a shortcut link: supply the name of a shortcut set which the new link will be in,supply the link's title and path.
 *     delete a shortcut link: just give the link's id, the id is in the menu_links table of the database.
 *     edit a shortcut link: need the link's id, need the link's new title or/and new path.
 *
 * switch for user(one forms);
 *     need a user's name
 *     need a shortcut set'name
 *     the user will use the shortcut set.
 */

/**
 * hook_patterns()
 */
function shortcut_patterns($data = NULL) {
  $files = array(
    'modules/shortcut/shortcut.admin.inc',
  );
  $actions['shortcut_set'] = array(
    PATTERNS_INFO => t('create/delete/modify shortcut set'),
    PATTERNS_CREATE => array(
      'shortcut_set_add_form',
    ),
    PATTERNS_MODIFY => array(
      'shortcut_set_edit_form',
    ),
    PATTERNS_DELETE => array(
      'shortcut_set_delete_form',
    ),
    PATTERNS_FILES => $files,
  );
  $actions['shortcut_link'] = array(
    PATTERNS_INFO => t('add a new link to one shortcut_set'),
    PATTERNS_CREATE => array(
      'shortcut_link_add',
    ),
    PATTERNS_MODIFY => array(
      'shortcut_link_edit',
    ),
    PATTERNS_DELETE => array(
      'shortcut_link_delete',
    ),
    PATTERNS_FILES => $files,
  );
  $actions['shortcut_set_user'] = array(
    PATTERNS_INFO => t('one user get one shortcut_set'),
    PATTERNS_MODIFY => array(
      'shortcut_set_switch',
    ),
    PATTERNS_FILES => $files,
  );
  return $actions;
}
function shortcut_patterns_export_all_set($args = NULL, &$result = NULL) {
  $info = shortcut_patterns();
  $form_id = current($info['shortcut_set'][PATTERNS_MODIFY]);
  $sets = shortcut_sets();
  $result = array();
  foreach ($sets as $set_name => $value) {
    $set_object = shortcut_set_load($set_name);
    $result = array_merge($result, patterns_export_actions_from_form($form_id, $set_object, 'shortcut_set', PATTERNS_MODIFY));
    return $result;
  }
  return $result;
}

/*
function shortcut_patterns_export_all_link($args = NULL, &$result = NULL) {
 $info = shortcut_patterns();
 $form_id = current($info['shortcut_link'][PATTERNS_MODIFY]);
 $sets = shortcut_sets();
 $result = array();
 foreach ($sets as $set_name => $value) {
   $set = shortcut_set_load($set_name);
   $result = array_merge($result, patterns_export_actions_from_form($form_id, $set, 'shortcut_link', PATTERNS_MODIFY));
 }
 return $result;
}
*/

/**
 * hook_patterns_prepare()
 */
function shortcut_patterns_prepare($action, $tag, &$data) {

  // for set.
  if ($tag == 'shortcut_set') {
    if ($action == PATTERNS_CREATE) {
      $data['new'] = $data['shortcut_set_name'];
    }
    if ($action == PATTERNS_MODIFY) {
      $data['title'] = $data['newname'];
      $data['searchtitle'] = $data['oldname'];
    }
    if ($action == PATTERNS_DELETE) {
      $data['searchtitle'] = $data['name'];
    }
  }

  // for switch user
  if ($tag == 'shortcut_set_user') {
    $data['searchtitle'] = $data['name'];
    $data['account'] = NULL;
  }

  // for link
  if ($tag == 'shortcut_link') {
    if ($action == PATTERNS_CREATE) {
      $data['searchtitle'] = $data['shortcut_set_name'];
      $data['shortcut_link']['link_title'] = $data['shortcut_link_title'];
      $data['shortcut_link']['link_path'] = $data['shortcut_link_path'];
    }
    if ($action == PATTERNS_MODIFY) {
      $data['shortcut_link']['link_title'] = $data['new_link_title'];
      $data['shortcut_link']['link_path'] = $data['new_link_path'];
    }
  }
  return patterns_results();
}

/**
 * hook_patterns_validate()
 */
function shortcut_patterns_validate($action, $tag, &$data) {
  $status = PATTERNS_SUCCESS;
  $msg = '';

  //for link's edit and delete.

  //these two form have the third parm:$shortcut_link, follow code provide the parm.
  if ($tag == 'shortcut_link') {
    $set_name = '';
    if ($action == PATTERNS_MODIFY || $action == PATTERNS_DELETE) {
      $set_name = db_select('shortcut_set', 'ss')
        ->fields('ss', array(
        'set_name',
      ))
        ->condition('title', $data['set_name'])
        ->execute()
        ->fetchField();
      if ($set_name == FALSE) {
        $status = PATTERNS_ERR;
        $msg = 'Shortcut Error:there is no such name shortcut set!';
        return patterns_results($status, $msg);
      }
      else {
        $shortcutlink = db_select('menu_links', 'ml')
          ->fields('ml')
          ->condition('menu_name', $set_name)
          ->condition('link_title', $data['link_title'])
          ->execute()
          ->fetchAssoc();

        //follow line is for test

        //drupal_set_message(t('the %acc is %mlid  dfldjdkfdld',array('%acc' =>$shortcutlink['link_title'],'%mlid' => $shortcutlink['mlid'])));
        if ($shortcutlink == FALSE) {
          $status = PATTERNS_ERR;
          $msg = 'Shortcut Error:there is no such name shortcut link!';
          return patterns_results($status, $msg);
        }
        $data['shortcut_link_parm'] = $shortcutlink;
      }
    }
  }

  //for set's edit&delete and link's add and switch user.

  //these three form(switch user just use the $set) have the third parm:$shortcut_set, follow code provide the parm.
  if ($tag == 'shortcut_set' && $action != PATTERNS_CREATE || $tag == 'shortcut_link' && $action == PATTERNS_CREATE || $tag == 'shortcut_set_user') {
    $set = db_select('shortcut_set', 'ss')
      ->fields('ss', array(
      'set_name',
    ))
      ->condition('title', $data['searchtitle'])
      ->execute()
      ->fetchField();
    if ($set == FALSE) {
      $status = PATTERNS_ERR;
      $msg = 'Shortcut Error:there is no such name shortcut set';
      return patterns_results($status, $msg);
    }
    else {
      module_load_include('module', 'shortcut');
      $shortcutsetobj = shortcut_set_load($set);
      $data['shortcut_set_obj'] = $shortcutsetobj;
      if ($tag == 'shortcut_set_user') {
        $data['set'] = $set;
        $data['new'] = $data['name'];
      }
    }
    if ($tag == 'shortcut_set_user') {

      // This form has the third parm: $account, the following code provides it.
      if (isset($data['user'])) {
        module_load_include('module', 'user');
        if (($data['account'] = user_load_by_name($data['user'])) == FALSE) {
          $status = PATTERNS_ERR;
          $msg = 'Shortcut Error:there is no such a user.';
          return patterns_results($status, $msg);
        }
      }
    }
  }
  return patterns_results($status, $msg);
}

/**
 * hook_patterns_callbacks()
 */
function shortcut_patterns_callbacks($action, $tag, &$data) {
  $allform = shortcut_patterns();
  $result = $allform[$tag][$action];
  return patterns_results(PATTERNS_SUCCESS, t('Execution successful(in callbacks function)'), $result);
}

/**
 * hook_patterns_build()
 */
function shortcut_patterns_build($action, $form_id, &$data = NULL, &$a) {
  module_load_include('inc', 'shortcut', 'shortcut.admin');
  return patterns_results(PATTERNS_SUCCESS, t('Execution successful(in build function)'), $data);
}

/**
 * hook_patterns_params()
 */
function shortcut_patterns_params($action, $form_id, &$data = NULL, &$a) {

  //provide the third parm.
  switch ($form_id) {
    case 'shortcut_set_edit_form':
    case 'shortcut_set_delete_form':
    case 'shortcut_link_add':
      $result = array(
        $data['shortcut_set_obj'],
      );
      break;
    case 'shortcut_set_switch':
      $result = array(
        $data['account'],
      );
      break;
    case 'shortcut_link_delete':
    case 'shortcut_link_edit':
      $result = array(
        $data['shortcut_link_parm'],
      );
      break;
  }
  return patterns_results(PATTERNS_SUCCESS, t('Execution successful'), $result);
}

/**
 * hook_patterns_get_arguments()
 */
function shortcut_patterns_get_arguments($action, $tag, $form_id, &$loop = FALSE) {
  if ($tag == "shortcut_set") {
    $loop = TRUE;
    $return = array();
    $sets = shortcut_sets();
    foreach ($sets as $set_name => $value) {
      array_merge($return, array(
        'oldname' => $value['title'],
      ));
      return $return;
    }
    return $return;
  }
}

/**
 * hook_patterns_cleanup()
 */
function shortcut_patterns_cleanup($action, $tag, &$data) {
  return patterns_results();
}

Functions

Name	Description
shortcut_patterns	hook_patterns()
shortcut_patterns_build	hook_patterns_build()
shortcut_patterns_callbacks	hook_patterns_callbacks()
shortcut_patterns_cleanup	hook_patterns_cleanup()
shortcut_patterns_export_all_set
shortcut_patterns_get_arguments	hook_patterns_get_arguments()
shortcut_patterns_params	hook_patterns_params()
shortcut_patterns_prepare	hook_patterns_prepare()
shortcut_patterns_validate	hook_patterns_validate()