fusion_apply.handlers.inc in Fusion Accelerator 7

Defines the various default handler functions to support Fusion Apply.

File

fusion_apply/fusion_apply.handlers.inc

<?php

/**
 * @file
 * Defines the various default handler functions to support Fusion Apply.
 */

/*
 * Fusion Apply access handler.
 *
 * @param $op
 *   What kind of action is being performed. Possible values:
 *   - access Fusion: Access to edit Fusion Apply's settings.
 *   - access Fusion classes: Access to edit Fusion Apply's additional classes.
 * @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
 *   TRUE if we get access, FALSE otherwise.
 */
function fusion_apply_access_handler($op, &$form, $form_state) {
  switch ($op) {
    case 'edit skin settings':
      return user_access('edit skin settings') || user_access('administer fusion');
    case 'edit advanced skin settings':
      return user_access('edit advanced skin settings') || user_access('administer fusion');
  }
}

/**
 * Fusion Apply form index handler.
 *
 * @param $op
 *   What kind of action is being performed. Possible values:
 *   - form: The form elements 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 fusion_apply_index_handler($op, &$form, $form_state) {
  switch ($op) {
    case 'form':
      if (empty($form['fusion_apply']['element']['#value'])) {
        trigger_error(sprintf("The form with form_id '%' is not a valid Fusion form.", $form['form_id']['#value']), E_USER_ERROR);
        return FALSE;
      }
      return $form['fusion_apply']['element']['#value'];
    case 'submit':
      if (empty($form_state['values']['element'])) {
        trigger_error(sprintf("The form with form_id '%' is not a valid Fusion form.", $form['form_id']['#value']), E_USER_ERROR);
        return FALSE;
      }
      return $form_state['values']['element'];
  }
}

/**
 * Fusion Apply data handler.
 *
 * @param &$form
 *   Passes in the $form parameter from hook_form_submit().
 * @param $form_state
 *   Passes in the $form_state parameter from hook_form_submit().
 * @param $theme
 *   The theme that is currently being processed.
 * @param $module
 *   The module that is currently being processed.
 * @param $form_settings
 *   The settings from hook_fusion_apply_config() for the form that's currently being
 *   processed.
 *
 * @return
 *   A Fusion Apply settings object.
 */
function fusion_apply_data_handler(&$form, $form_state, $theme, $module, $form_settings) {

  // Ensure we have the required index_handler
  if (empty($form_settings['index_handler'])) {
    trigger_error(sprintf("No index_handler was found for form_id '%s' in module '%s'.", $form_id, $module), E_USER_ERROR);
  }
  $element = fusion_apply_handler('form_index_handler', 'form', $form_settings['index_handler'], $form, $form_state);
  $params = array(
    'theme' => $theme,
    'module' => $module,
    'element' => $element,
  );
  return fusion_apply_skin_load_multiple(fusion_apply_skin_get_sids($params));
}

/**
 * Fusion Apply submit handler.
 *
 * @param &$form
 *   Passes in the $form parameter from hook_form_submit().
 * @param $form_state
 *   Passes in the $form_state parameter from hook_form_submit().
 * @param $module
 *   The module that is currently being processed.
 * @param $form_settings
 *   The settings from hook_fusion_apply_config() for the form that's currently being
 *   processed.
 */
function fusion_apply_submit_handler(&$form, $form_state, $module, $form_settings) {
  if (!($element = fusion_apply_handler('form_index_handler', 'submit', $form_settings['index_handler'], $form, $form_state))) {

    // We require a valid element to continue.
    // @todo This should really be in a validation handler.
    drupal_set_message(t("Skin settings weren't saved due to an error."), 'error');
    return;
  }
  if (isset($form_state['values']['fusion_apply_settings'][$module . '_group'])) {
    foreach ($form_state['values']['fusion_apply_settings'][$module . '_group'] as $theme_name => $theme) {

      // Process widgets.
      if (!empty($theme['groups']) && is_array($theme['groups'])) {
        foreach ($theme['groups'] as $skin_name => $options) {
          if ($skin_name == '_additional' && !user_access('edit advanced skin settings')) {

            // This user doesn't have access to alter these options.
            continue;
          }

          // Convert manually entered classes into an array.
          if ($skin_name == '_additional') {
            $options = explode(' ', $options['_additional']);
          }
          elseif (!is_array($options)) {
            $options = array(
              $options,
            );
          }

          // Sanitize options.
          $options = _fusion_apply_array_strip_empty($options);

          // Find existing skin.
          $params = array(
            'theme' => $theme_name,
            'module' => $module,
            'element' => $element,
            'skin' => $skin_name,
          );
          $sids = fusion_apply_skin_get_sids($params);
          unset($skin);
          if (!empty($sids)) {
            $sid = reset($sids);
            $skin = fusion_apply_skin_load($sid);
          }
          if (empty($options)) {
            if (!empty($skin)) {

              // Delete this skin configuration.
              fusion_apply_skin_delete($skin->sid);
            }
            continue;
          }
          if (empty($skin)) {

            // It doesn't exist, so create a new skin.
            $skin = new stdClass();
            $skin->theme = $theme_name;
            $skin->module = $module;
            $skin->element = $element;
            $skin->skin = $skin_name;
          }
          $skin->options = $options;
          $skin->status = 1;

          // Save skin.
          if (!fusion_apply_skin_save($skin)) {
            drupal_set_message(t("Fusion settings for %skin weren't saved due to an error.", array(
              '%skin' => $skin_name,
            )), 'error');
          }
        }
      }
    }
  }
}

/**
 * Implements hook_fusion_apply_api_VERSION().
 */
function fusion_apply_fusion_apply_api_2() {
}

/**
 * Helper function for built-in integration code.
 */
function fusion_apply_fusion_apply_api_modules() {
  return array(
    'path' => drupal_get_path('module', 'fusion_apply') . '/modules',
  );
}
function block_fusion_apply_api_2() {
  return fusion_apply_fusion_apply_api_modules();
}
function comment_fusion_apply_api_2() {
  return fusion_apply_fusion_apply_api_modules();
}
function node_fusion_apply_api_2() {
  return fusion_apply_fusion_apply_api_modules();
}
function panels_fusion_apply_api_2() {
  return fusion_apply_fusion_apply_api_modules();
}
function views_fusion_apply_api_2() {
  return fusion_apply_fusion_apply_api_modules();
}

Functions

Name	Description
block_fusion_apply_api_2
comment_fusion_apply_api_2
fusion_apply_access_handler
fusion_apply_data_handler	Fusion Apply data handler.
fusion_apply_fusion_apply_api_2	Implements hook_fusion_apply_api_VERSION().
fusion_apply_fusion_apply_api_modules	Helper function for built-in integration code.
fusion_apply_index_handler	Fusion Apply form index handler.
fusion_apply_submit_handler	Fusion Apply submit handler.
node_fusion_apply_api_2
panels_fusion_apply_api_2
views_fusion_apply_api_2