boxes.admin.inc in Boxes 7

File

boxes.admin.inc

<?php

/**
 * Generate form for creating new boxes.
 */
function boxes_add_form($form, $form_state, $plugin_key) {
  $form_state['box'] = boxes_factory($plugin_key);
  $form = boxes_box_form($form, $form_state);
  $form['delta'] = array(
    '#type' => 'textfield',
    '#title' => t('Machine name'),
    '#description' => t('Lowercase letters, numbers and underscores only'),
    '#required' => TRUE,
    '#element_validate' => array(
      'boxes_validate_delta',
    ),
    '#size' => 32,
    '#maxlength' => 32,
    '#weight' => -20,
  );
  $form['submit']['#attributes']['class'] = array();
  return $form;
}

/**
 * Validate handler for box delta.
 */
function boxes_validate_delta($element, &$form_state) {
  if (!preg_match('!^[a-z0-9_]+$!', $element['#value'])) {
    form_error($element, t('The machine-readable name must contain only lowercase letters, numbers, and underscores.'));
  }
  if (strpos($element['#value'], 'boxes_add__') === 0 || boxes_box_load($element['#value'])) {
    form_error($element, t('The machine-readable name is already taken.'));
  }
}

/**
 * Submit handler for box_add_form.
 */
function boxes_add_form_submit($form, &$form_state) {
  $box = boxes_factory($form_state['values']['plugin_key'], $form_state['values']);
  $box
    ->save();
  drupal_set_message(t('%name has been created.', array(
    '%name' => $box->description,
  )));
  $form_state['redirect'] = 'admin/structure/block';
}

/**
 * Box deletion form.
 */
function boxes_delete_form($form, $form_state, $box) {
  $form['delta'] = array(
    '#type' => 'hidden',
    '#value' => $box->delta,
  );
  if ($box->export_type & EXPORT_IN_DATABASE && $box->export_type & EXPORT_IN_CODE) {
    return confirm_form($form, t('Are you sure you want to revert the block %name?', array(
      '%name' => $box->title,
    )), 'admin/structure/block', '', t('Revert'), t('Cancel'));
  }
  elseif (!($box->export_type & EXPORT_IN_CODE)) {
    return confirm_form($form, t('Are you sure you want to delete the block %name?', array(
      '%name' => $box->title,
    )), 'admin/structure/block', '', t('Delete'), t('Cancel'));
  }
  drupal_not_found();
  die;
}

/**
 * Submit handler for boxes_delete_form
 */
function boxes_delete_form_submit($form, &$form_state) {
  boxes_box_load($form_state['values']['delta'])
    ->delete();
  $form_state['redirect'] = 'admin/structure/block';
}

/**
 * Theme function for the form.
 */
function theme_boxes_box($variables) {
  $block = $variables['block'];
  $empty = '';

  // Box is empty
  if ((empty($block['title']) || $block['title'] == '<none>') && empty($block['content'])) {

    // add a class to mark the box as empty
    $empty = ' box-empty';

    // show something if the block is empty but the user has the permission to edit it
    if (boxes_access_edit()) {
      $block['content'] = t('This box appears empty when displayed on this page. This is simply placeholder text.');
    }
    else {
      return;
    }
  }
  $output = "<div id='boxes-box-" . $block['delta'] . "' class='boxes-box" . (!empty($block['editing']) ? ' boxes-box-editing' : '') . $empty . "'>";
  $output .= '<div class="boxes-box-content">' . $block['content'] . '</div>';
  if (!empty($block['controls'])) {
    $output .= '<div class="boxes-box-controls">';
    $output .= $block['controls'];
    $output .= '</div>';
  }
  if (!empty($block['editing'])) {
    $output .= '<div class="box-editor">' . drupal_render($block['editing']) . '</div>';
  }
  $output .= '</div>';
  return $output;
}

/**
 * Menu callback for settings form.
 */
function boxes_settings($form, $form_state) {
  $form['boxes_edit_location'] = array(
    '#title' => t('Edit location'),
    '#type' => 'radios',
    '#options' => array(
      BOXES_EDIT_SEPARATE_PAGE => t('Separate page'),
      BOXES_EDIT_IN_PLACE => t('Edit in place'),
    ),
    '#default_value' => variable_get('boxes_edit_location', BOXES_EDIT_IN_PLACE),
    '#description' => t('Boxes can either be edited directly where they are displayed, or on a separate page.'),
  );
  return system_settings_form($form);
}

Functions

Name	Description
boxes_add_form	Generate form for creating new boxes.
boxes_add_form_submit	Submit handler for box_add_form.
boxes_delete_form	Box deletion form.
boxes_delete_form_submit	Submit handler for boxes_delete_form
boxes_settings	Menu callback for settings form.
boxes_validate_delta	Validate handler for box delta.
theme_boxes_box	Theme function for the form.