fusion_apply_rules.inc in Fusion Accelerator 7

Admin page callbacks for Fusion Apply module's rules.

File

fusion_apply/fusion_apply_rules.inc

<?php

/**
 * @file
 * Admin page callbacks for Fusion Apply module's rules.
 */

/**
 * Menu callback; displays the skin rules listing.
 */
function fusion_apply_rules() {
  $output = '';
  $headers = array(
    array(
      'data' => t('Title'),
      'field' => 'title',
    ),
    array(
      'data' => t('Type'),
      'field' => 'type',
    ),
    array(
      'data' => t('Operations'),
      'colspan' => 2,
    ),
  );
  $rules = fusion_apply_rule_load_multiple();
  $rows = array();
  foreach ($rules as $rule) {
    $row = array(
      check_plain($rule->title),
      check_plain($rule->rule_type),
      l(t('edit'), 'admin/appearance/fusion/rules/edit/' . $rule->rid),
      l(t('delete'), 'admin/appearance/fusion/rules/delete/' . $rule->rid),
    );
    $rows[] = $row;
  }
  $link = l(t('Create a new rule'), 'admin/appearance/fusion/rules/add');
  $row = array();
  if (empty($rows)) {
    $row[] = array(
      'data' => t('No rules have been set up yet. !url.', array(
        '!url' => $link,
      )),
      'colspan' => 4,
    );
  }
  else {
    $row[] = array(
      'data' => t('!url.', array(
        '!url' => $link,
      )),
      'colspan' => 4,
    );
  }
  $rows[] = $row;
  $output .= theme('table', array(
    'header' => $headers,
    'rows' => $rows,
  ));
  $output .= drupal_render($form);
  return $output;
}

/**
 * Menu callback; displays the edit form for a Fusion Apply rule.
 *
 * @ingroup forms
 */
function fusion_apply_rule_add($form, &$form_state) {
  $form = array();
  $form['#tree'] = TRUE;
  $form['rule']['title'] = array(
    '#type' => 'textfield',
    '#title' => t('Title'),
    '#default_value' => !empty($form_state['values']['rule']['title']) ? $form_state['values']['rule']['title'] : '',
    '#description' => t('Descriptive title for this rule; used by administrators.'),
    '#required' => TRUE,
  );
  $options = array(
    'page' => t('Page'),
  );
  foreach (list_themes() as $theme_name => $theme) {
    if (empty($theme->status)) {
      continue;
    }

    // Create a list options containing visible regions of this theme.
    $regions = array();
    foreach (system_region_list($theme_name, REGIONS_VISIBLE) as $region_name => $region) {
      $regions['region__' . $region_name] = $region;
    }

    // Group the list of options by theme.
    $key = t('@name Regions', array(
      '@name' => $theme->info['name'],
    ));
    $options[$key] = $regions;
  }
  $form['rule']['rule_type'] = array(
    '#type' => 'select',
    '#title' => t('Type'),
    '#options' => $options,
    '#default_value' => !empty($form_state['values']['rule']['rule_type']) ? $form_state['values']['rule']['rule_type'] : '',
    '#description' => t('Type of element the rule is applied to.'),
    '#required' => TRUE,
  );
  $form['buttons']['save'] = array(
    '#type' => 'submit',
    '#value' => t('Add'),
  );
  return $form;
}

/**
 * Process fusion_apply_rule_add() submissions.
 */
function fusion_apply_rule_add_submit($form, &$form_state) {
  $rule = new stdClass();
  $rule->rid = NULL;
  $rule->title = $form_state['values']['rule']['title'];
  $rule->rule_type = $form_state['values']['rule']['rule_type'];
  $rule->node_types = array();
  $rule->roles = array();
  $rule->visibility = 0;
  $rule->pages = '';
  fusion_apply_rule_save($rule);

  // Set rule id, if we inserted a new rule to allow others to know what rule they're working with.
  $form_state['values']['rule']['rid'] = $rule->rid;
  $form_state['redirect'] = 'admin/appearance/fusion/rules/edit/' . $rule->rid;
}

/**
 * Form builder for the rule configuration form.
 *
 * @param $rid
 *   The rule ID.
 *
 * @see fusion_apply_rule_edit_submit()
 * @ingroup forms
 */
function fusion_apply_rule_edit($form, &$form_state, $rid = NULL) {
  $form['rule'] = array(
    '#weight' => -1,
  );
  if (isset($form_state['values'])) {
    $rule = array(
      'title' => $form_state['values']['title'],
      'rule_type' => $form_state['values']['rule_type'],
      'node_types' => $form_state['values']['types'],
      'roles' => $form_state['values']['roles'],
      'visibility' => $form_state['values']['visibility'],
      'pages' => $form_state['values']['pages'],
    );
  }
  elseif (isset($rid) && ($rule = fusion_apply_rule_load($rid))) {
    $rule = (array) $rule;
    $form['rule']['rid'] = array(
      '#type' => 'value',
      '#value' => $rid,
    );
  }
  else {
    $rule = array(
      'title' => '',
      'rule_type' => '',
      'node_types' => array(),
      'roles' => array(),
      'visibility' => 0,
      'pages' => '',
    );
  }
  $form['rule']['title'] = array(
    '#type' => 'textfield',
    '#title' => t('Rule title'),
    '#default_value' => $rule['title'],
    '#description' => t('Descriptive title for this rule; used by administrators.'),
    '#required' => TRUE,
  );
  $form['rule']['rule_type'] = array(
    '#type' => 'hidden',
    '#value' => $rule['rule_type'],
  );
  $form['rule']['rule_type_displayed'] = array(
    '#type' => 'item',
    '#title' => t('Rule type'),
    '#markup' => $rule['rule_type'],
    '#description' => t('Type of element the rule is applied to.'),
  );

  // Visibility settings.
  $form['visibility_title'] = array(
    '#type' => 'item',
    '#title' => t('Visibility settings'),
  );
  $form['visibility'] = array(
    '#type' => 'vertical_tabs',
    '#attached' => array(
      'js' => array(
        drupal_get_path('module', 'fusion_apply_ui') . '/js/fusion_apply_ui.rules.js',
      ),
    ),
  );

  // Per-path visibility.
  $form['visibility']['path'] = array(
    '#type' => 'fieldset',
    '#title' => t('Pages'),
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
    '#group' => 'visibility',
    '#weight' => 0,
  );
  $access = user_access('use PHP for settings');
  if (isset($rule['visibility']) && $rule['visibility'] == FUSION_APPLY_RULE_VISIBILITY_PHP && !$access) {
    $form['visibility']['path']['visibility'] = array(
      '#type' => 'value',
      '#value' => FUSION_APPLY_RULE_VISIBILITY_PHP,
    );
    $form['visibility']['path']['pages'] = array(
      '#type' => 'value',
      '#value' => isset($rule['pages']) ? $rule['pages'] : '',
    );
  }
  else {
    $options = array(
      FUSION_APPLY_RULE_VISIBILITY_NOTLISTED => t('All pages except those listed'),
      FUSION_APPLY_RULE_VISIBILITY_LISTED => t('Only the listed pages'),
    );
    $description = t("Specify pages by using their paths. Enter one path per line. The '*' character is a wildcard. Example paths are %blog for the blog page and %blog-wildcard for every personal blog. %front is the front page.", array(
      '%blog' => 'blog',
      '%blog-wildcard' => 'blog/*',
      '%front' => '<front>',
    ));
    if (module_exists('php') && $access) {
      $options += array(
        FUSION_APPLY_RULE_VISIBILITY_PHP => t('Pages on which this PHP code returns <code>TRUE</code> (experts only)'),
      );
      $title = t('Pages or PHP code');
      $description .= ' ' . t('If the PHP option is chosen, enter PHP code between %php. Note that executing incorrect PHP code can break your Drupal site.', array(
        '%php' => '<?php ?>',
      ));
    }
    else {
      $title = t('Pages');
    }
    $form['visibility']['path']['visibility'] = array(
      '#type' => 'radios',
      '#title' => t('Show block on specific pages'),
      '#options' => $options,
      '#default_value' => isset($rule['visibility']) ? $rule['visibility'] : FUSION_APPLY_RULE_VISIBILITY_NOTLISTED,
    );
    $form['visibility']['path']['pages'] = array(
      '#type' => 'textarea',
      '#title' => '<span class="element-invisible">' . $title . '</span>',
      '#default_value' => isset($rule['pages']) ? $rule['pages'] : '',
      '#description' => $description,
    );
  }

  // Per-node visbility.
  $form['visibility']['node_type'] = array(
    '#type' => 'fieldset',
    '#title' => t('Content types'),
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
    '#group' => 'visibility',
    '#weight' => 5,
  );
  $form['visibility']['node_type']['types'] = array(
    '#type' => 'checkboxes',
    '#title' => t('Show block for specific content types'),
    '#default_value' => $rule['node_types'],
    '#options' => node_type_get_names(),
    '#description' => t('Show this block only on pages that display content of the given type(s). If you select no types, there will be no type-specific limitation.'),
  );

  // Per-role visibility.
  $role_options = array_map('check_plain', user_roles());
  $form['visibility']['role'] = array(
    '#type' => 'fieldset',
    '#title' => t('Roles'),
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
    '#group' => 'visibility',
    '#weight' => 10,
  );
  $form['visibility']['role']['roles'] = array(
    '#type' => 'checkboxes',
    '#title' => t('Show block for specific roles'),
    '#default_value' => $rule['roles'],
    '#options' => $role_options,
    '#description' => t('Show this rule only for the selected role(s). If you select no roles, the rule will be visible to all users.'),
  );
  $form['actions'] = array(
    '#type' => 'actions',
  );
  $form['actions']['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Save rule'),
  );
  if (isset($rule['rid'])) {
    $form['actions']['delete'] = array(
      '#type' => 'submit',
      '#value' => t('Delete'),
      '#submit' => array(
        'fusion_apply_rule_delete_submit',
      ),
    );
  }
  return $form;
}

/**
 * Form submission handler for the rule configuration form.
 *
 * @see fusion_apply_rule_edit()
 */
function fusion_apply_rule_edit_submit($form, &$form_state) {
  $rule = new stdClass();
  $rule->rid = !empty($form_state['values']['rid']) ? $form_state['values']['rid'] : NULL;
  $rule->rule_type = $form_state['values']['rule_type'];
  $rule->title = $form_state['values']['title'];
  $rule->node_types = array_filter($form_state['values']['types']);
  $rule->roles = $form_state['values']['roles'];
  $rule->visibility = (int) $form_state['values']['visibility'];
  $rule->pages = trim($form_state['values']['pages']);
  fusion_apply_rule_save($rule);

  // Set rule id, if we inserted a new rule to allow others to know what rule they're working with.
  $form_state['values']['rid'] = $rule->rid;
  $form_state['redirect'] = 'admin/appearance/fusion/rules';
}

/**
 * Called from within the rule edit form; redirects to fusion_apply_rule_delete_confirm().
 *
 * @ingroup forms
 */
function fusion_apply_rule_delete_submit($form, &$form_state) {
  $destination = array();
  if (isset($_REQUEST['destination'])) {
    $destination = drupal_get_destination();
    unset($_REQUEST['destination']);
  }
  $form_state['redirect'] = array(
    'admin/appearance/fusion/rules/delete/' . $form_state['values']['rid'],
    $destination,
  );
}

/**
 * Menu callback; displays the delete confirmation for a skins rule.
 *
 * @param $rid
 *   The rule ID.
 *
 * @ingroup forms
 */
function fusion_apply_rule_delete_confirm($form, &$form_state, $rid) {
  $form['rid'] = array(
    '#type' => 'value',
    '#value' => $rid,
  );
  $rule = fusion_apply_rule_load($rid);
  return confirm_form($form, t('Are you sure you want to delete %title?', array(
    '%title' => $rule->title,
  )), isset($_GET['destination']) ? $_GET['destination'] : 'admin/appearance/fusion/rules', t('This action cannot be undone.'), t('Delete'), t('Cancel'));
}

/**
 * Process fusion_apply_rule_delete_confirm() submissions.
 */
function fusion_apply_rule_delete_confirm_submit($form, &$form_state) {
  if ($form_state['values']['confirm']) {
    fusion_apply_rule_delete($form_state['values']['rid']);
  }
  $form_state['redirect'] = 'admin/appearance/fusion/rules';
}

/**
 * @defgroup skin page rule handlers
 * @{
 */

/**
 * Implementation of hook_fusion_apply_config_info().
 */
function fusion_apply_fusion_apply_config_info() {
  $data['rules']['preprocess']['html'] = array(
    'index_handler' => 'rules_fusion_apply_preprocess_index_handler',
  );
  $data['rules']['preprocess']['region'] = array(
    'index_handler' => 'rules_fusion_apply_preprocess_index_handler',
  );
  if (module_exists('fusion_apply_ui')) {
    $data['rules']['form']['fusion_apply_rule_edit'] = array(
      'index_handler' => 'rules_fusion_apply_form_index_handler',
      'preprocess_hook_callback' => 'rules_fusion_apply_preprocess_hook_callback',
      'title' => t('rule settings'),
      'fusion_apply_weight' => 0,
      'collapsed' => FALSE,
    );
    $data['rules']['form']['fusion_apply_ui_form'] = array(
      'preprocess_hook_callback' => 'rules_fusion_apply_preprocess_hook_callback',
      'title' => t('rule settings'),
      'collapsed' => FALSE,
    );
    $data['rules']['contextual_links']['html'] = array(
      'contextual_links_handler' => 'rules_fusion_apply_contextual_links',
    );
    $data['rules']['contextual_links']['region'] = array(
      'contextual_links_handler' => 'rules_fusion_apply_contextual_links',
    );
  }
  return $data;
}

/**
 * Fusion Apply form index handler.
 *
 * @param $op
 *   What kind of action is being performed. Possible values:
 *   - 'form': the form elements for Fusion Apply are being inserted in a form.
 *   - 'submit': the form has been submitted.
 * @param &$form
 *   - For 'form', passes in the $form parameter from hook_form_alter().
 *   - For 'submit', passes in the $form parameter from hook_form_submit().
 * @param $form_state
 *   - For 'form', passes in the $form_state parameter from hook_form_alter().
 *   - For 'submit', passes in the $form_state parameter from hook_form_submit().
 * @return
 *   The index where we can find our values in Fusion Apply's data structure.
 */
function rules_fusion_apply_form_index_handler($op, &$form, $form_state) {
  switch ($op) {
    case 'form':
      if (!empty($form['rule']['rid']['#value'])) {
        return $form['rule']['rid']['#value'];
      }
      else {
        return 0;
      }
    case 'submit':
      return $form_state['values']['rid'];
  }
}

/**
 * Fusion Apply preprocess_hook_callback.
 *
 * @param &$form
 *   Passes in the $form parameter from hook_form_alter().
 * @param $form_state
 *   Passes in the $form_state parameter from hook_form_alter().
 * @return
 *   The preprocess_hook we wish to use.
 */
function rules_fusion_apply_preprocess_hook_callback(&$form, $form_state) {
  $preprocess_hooks = array();
  if (!empty($form['rule'])) {
    $hooks = explode('__', $form['rule']['rule_type']['#value']);
  }
  else {
    $rule = fusion_apply_rule_load($form['fusion_apply']['element']['#value']);
    $hooks = explode('__', $rule->rule_type);
  }
  while (count($hooks)) {
    $preprocess_hooks[] = implode('__', $hooks);
    array_pop($hooks);
  }
  return $preprocess_hooks;
}

/**
 * Fusion Apply preprocess index handler.
 *
 * @param &$variables
 *   Passes in the $variables parameter from module_preprocess().
 * @return
 *   The index where we can find our values in Fusion Apply's data structure. If an
 *   array is returned, it will loop through each index in Fusion Apply's data
 *   structure and merge the returned classes.
 */
function rules_fusion_apply_preprocess_index_handler(&$variables) {
  if (!empty($variables['region'])) {
    $rule_type = 'region__' . $variables['region'];
  }
  else {
    $rule_type = 'page';
  }
  $rules = fusion_apply_rule_load_multiple(array(), array(
    'rule_type' => $rule_type,
  ));

  // Find any page level Fusion Apply options and return an array of them.
  $indices = array();
  foreach ($rules as $rule) {
    if (fusion_apply_rule_is_visible($rule->rid)) {
      $indices[] = $rule->rid;
    }
  }
  return $indices;
}

/**
 * Fusion Apply contextual links handler.
 *
 * @param &$variables
 *   Passes in the $variables parameter from fusion_apply_preprocess().
 * @return
 *   An associative array. Each value is an array that forms the function
 *   arguments for menu_contextual_links(). For example:
 *   @code
 *    $links = array(
 *      'fusion_apply-modulename' => array(
 *        'admin/appearance/fusion/edit', array('system', 'navigation')),
 *      ),
 *      'fusion_apply-modulename-1' => array(
 *        'admin/appearance/fusion/edit', array('system', 'something-else')),
 *      ),
 *    );
 *   @endcode
 */
function rules_fusion_apply_contextual_links(&$variables) {
  if (!empty($variables['region'])) {
    $rule_type = 'region__' . $variables['region'];
  }
  else {
    $rule_type = 'page';
  }
  $rules = fusion_apply_rule_load_multiple(array(), array(
    'rule_type' => $rule_type,
  ));
  $links = array();
  $counter = 1;
  foreach ($rules as $rule) {
    if (fusion_apply_rule_is_visible($rule->rid)) {
      $links['fusion_apply-rule-' . $counter++] = array(
        'admin/config/fusion/edit/nojs',
        array(
          'rule',
          $rule->rid,
        ),
      );
    }
  }
  return $links;
}

/**
 * @}
 */

Functions

Name	Description
fusion_apply_fusion_apply_config_info	Implementation of hook_fusion_apply_config_info().
fusion_apply_rules	Menu callback; displays the skin rules listing.
fusion_apply_rule_add	Menu callback; displays the edit form for a Fusion Apply rule.
fusion_apply_rule_add_submit	Process fusion_apply_rule_add() submissions.
fusion_apply_rule_delete_confirm	Menu callback; displays the delete confirmation for a skins rule.
fusion_apply_rule_delete_confirm_submit	Process fusion_apply_rule_delete_confirm() submissions.
fusion_apply_rule_delete_submit	Called from within the rule edit form; redirects to fusion_apply_rule_delete_confirm().
fusion_apply_rule_edit	Form builder for the rule configuration form.
fusion_apply_rule_edit_submit	Form submission handler for the rule configuration form.
rules_fusion_apply_contextual_links	Fusion Apply contextual links handler.
rules_fusion_apply_form_index_handler	Fusion Apply form index handler.
rules_fusion_apply_preprocess_hook_callback	Fusion Apply preprocess_hook_callback.
rules_fusion_apply_preprocess_index_handler	Fusion Apply preprocess index handler.