handlers.inc in Skinr 6

Defines the various handler objects to support Skinr.

File

includes/handlers.inc

<?php

/**
 * @file
 * Defines the various handler objects to support Skinr.
 */

/*
 * Skinr access handler.
 *
 * @param $op
 *   What kind of action is being performed. Possible values:
 *   - "access skinr": access to edit skinr's selector
 *   - "access skinr classes": access to edit skinr'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 if we don't.
 */
function skinr_access_handler($op, &$form, $form_state) {
  switch ($op) {
    case 'access skinr':
      return user_access('access skinr') || user_access('administer skinr');
    case 'access skinr classes':
      return user_access('access skinr classes') || user_access('administer skinr');
  }
}

/*
 * Skinr 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 $module
 *   The module that is currently being processed.
 * @param $form_settings
 *   The settings from hook_skinr_data() for the form that's currently being
 *   processed.
 * @return
 *   TRUE if we get access, FALSE if we don't.
 */
function skinr_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);
  }
  $index = skinr_handler('form_index_handler', 'form', $form_settings['index_handler'], $form, $form_state);
  return skinr_get($theme, $module, $index);
}

/**
 * Skinr 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_skinr_data() for the form that's currently being
 *   processed.
 * @return
 *   TRUE if we get access, FALSE if we don't.
 */
function skinr_submit_handler(&$form, $form_state, $module, $form_settings) {
  if (isset($form_state['values']['skinr_settings'][$module . '_group'])) {
    foreach ($form_state['values']['skinr_settings'][$module . '_group'] as $theme_name => $theme) {
      if (!empty($theme['widgets']) && is_array($theme['widgets']) || isset($theme['advanced']['_additional'])) {
        $hook = $module;
        $key = skinr_handler('form_index_handler', 'submit', $form_settings['index_handler'], $form, $form_state);
        $value = array();
        $saved = skinr_get($theme_name, $hook, $key);
        if (!empty($theme['widgets']) && is_array($theme['widgets'])) {
          foreach ($theme['widgets'] as $skin_id => $skin_value) {
            $skin_value = is_array($skin_value) ? _skinr_array_strip_empty($skin_value) : $skin_value;
            if (!empty($skin_value)) {
              $value[$skin_id] = $skin_value;
            }
          }
        }
        if (isset($theme['advanced']['_additional'])) {
          $theme['advanced']['_additional'] = trim($theme['advanced']['_additional']);
          if (!empty($theme['advanced']['_additional'])) {
            $value['_additional'] = $theme['advanced']['_additional'];
          }
        }
        else {
          if (!user_access('access skinr classes') && isset($saved['_additional'])) {

            // The user didn't have access to change this. Ensure the existing
            // custom classes remain by populating the element with the
            // previously saved values.
            $value['_additional'] = $saved['_additional'];
          }
        }
        if (isset($theme['advanced']['_template'])) {
          $theme['advanced']['_template'] = trim($theme['advanced']['_template']);
          if (!empty($theme['advanced']['_template'])) {
            $value['_template'] = $theme['advanced']['_template'];
          }
        }
        else {
          if (!user_access('access skinr classes') && isset($saved['_template'])) {

            // The user didn't have access to change this. Ensure the existing
            // template selection remains by populating the element with the
            // previously saved values.
            $value['_template'] = $saved['_template'];
          }
        }
        if (empty($key)) {

          // We didn't receive a valid key, so raise an error
          drupal_set_message(t("Skinr settings weren't saved due to an error."), 'error');
        }
        skinr_set($theme_name, $hook, $key, $value);
      }
    }
  }
}

/**
 * Helper function to remove unchecked entries from checkbox form element.
 */
function _skinr_array_strip_empty($array) {
  $new_array = array();
  foreach ($array as $key => $value) {
    if (!empty($value)) {
      $new_array[$key] = $value;
    }
  }
  return $new_array;
}

// Declare API compatibility on behalf of core modules:

/**
 * Implementation of hook_skinr_api().
 *
 * This one is used as the base to reduce errors when updating.
 */
function skinr_skinr_api() {
  return array(
    'api' => 1,
    'path' => drupal_get_path('module', 'skinr') . '/modules',
  );
}
function block_skinr_api() {
  return skinr_skinr_api();
}
function comment_skinr_api() {
  return skinr_skinr_api();
}
function node_skinr_api() {
  return skinr_skinr_api();
}
function panels_skinr_api() {
  return skinr_skinr_api();
}
function views_skinr_api() {
  return skinr_skinr_api();
}

Functions

Name	Description
block_skinr_api
comment_skinr_api
node_skinr_api
panels_skinr_api
skinr_access_handler
skinr_data_handler
skinr_skinr_api	Implementation of hook_skinr_api().
skinr_submit_handler	Skinr submit handler.
views_skinr_api
_skinr_array_strip_empty	Helper function to remove unchecked entries from checkbox form element.