twitter_block.admin.inc in Twitter Block 7.2

Admin page callbacks for the Twitter Block module.

File

twitter_block.admin.inc

<?php

/**
 * @file
 * Admin page callbacks for the Twitter Block module.
 */

/**
 * Implements hook_admin_settings() for module settings configuration.
 */
function twitter_block_admin_settings_form($form, &$form_state) {

  // Advanced feature configurations.
  $form['advanced'] = array(
    '#type' => 'fieldset',
    '#title' => t('Advanced settings'),
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
  );
  $form['advanced']['twitter_block_cache'] = array(
    '#type' => 'checkbox',
    '#title' => t('Locally cache widget code'),
    '#description' => t("If checked, the widget code is retrieved from Twitter and cached locally. It is updated daily from Twitter's servers to ensure updates to widget code are reflected in the local copy."),
    '#default_value' => variable_get('twitter_block_cache', 0),
  );
  return system_settings_form($form);
}

/**
 * Form constructor for the add block form.
 *
 * @see twitter_block_add_block_form_validate()
 * @see twitter_block_add_block_form_submit()
 * @ingroup forms
 */
function twitter_block_add_block_form($form, &$form_state) {
  module_load_include('inc', 'block', 'block.admin');
  $form = block_admin_configure($form, $form_state, 'twitter_block', NULL);

  // Other modules should be able to use hook_form_block_add_block_form_alter()
  // to modify this form, so add a base form ID.
  $form_state['build_info']['base_form_id'] = 'block_add_block_form';

  // Prevent block_add_block_form_validate/submit() from being automatically
  // added because of the base form ID by providing these handlers manually.
  $form['#validate'] = array(
    'twitter_block_add_block_form_validate',
  );
  $form['#submit'] = array(
    'twitter_block_add_block_form_submit',
  );
  return $form;
}

/**
 * Form validation handler for twitter_block_add_block_form().
 *
 * @see twitter_block_add_block_form()
 * @see twitter_block_add_block_form_submit()
 */
function twitter_block_add_block_form_validate($form, &$form_state) {
  $unique_description = (bool) db_query_range('SELECT 1 FROM {twitter_block} WHERE info = :info', 0, 1, array(
    ':info' => $form_state['values']['info'],
  ))
    ->fetchField();
  if (empty($form_state['values']['info']) || $unique_description) {
    form_set_error('info', t('Ensure that each block description is unique.'));
  }
  $unique_widget_id = (bool) db_query_range('SELECT 1 FROM {twitter_block} WHERE widget_id = :widget_id', 0, 1, array(
    ':widget_id' => $form_state['values']['widget_id'],
  ))
    ->fetchField();
  if (empty($form_state['values']['widget_id']) || $unique_widget_id) {
    form_set_error('widget_id', t('Ensure that each block widget ID is unique.'));
  }
}

/**
 * Form submission handler for twitter_block_add_block_form().
 *
 * Saves the new custom Twitter block.
 *
 * @see twitter_block_add_block_form()
 * @see twitter_block_add_block_form_validate()
 */
function twitter_block_add_block_form_submit($form, &$form_state) {

  // The serialized 'data' column contains the timeline settings.
  $data = array(
    'theme' => $form_state['values']['theme'],
    'link_color' => $form_state['values']['link_color'],
    'width' => $form_state['values']['width'],
    'height' => $form_state['values']['height'],
    'chrome' => $form_state['values']['chrome'],
    'border_color' => $form_state['values']['border_color'],
    'language' => $form_state['values']['language'],
    'tweet_limit' => $form_state['values']['tweet_limit'],
    'related' => $form_state['values']['related'],
    'polite' => $form_state['values']['polite'],
  );

  // Save the block configuration.
  $delta = db_insert('twitter_block')
    ->fields(array(
    'info' => $form_state['values']['info'],
    'widget_id' => $form_state['values']['widget_id'],
    'username' => $form_state['values']['username'],
    'data' => serialize($data),
  ))
    ->execute();

  // Store block delta to allow other modules to work with new block.
  $form_state['values']['delta'] = $delta;

  // Run the normal new block submission (borrowed from block_add_block_form_submit).
  $query = db_insert('block')
    ->fields(array(
    'visibility',
    'pages',
    'custom',
    'title',
    'module',
    'theme',
    'status',
    'weight',
    'delta',
    'cache',
  ));
  foreach (list_themes() as $key => $theme) {
    if ($theme->status) {
      $query
        ->values(array(
        'visibility' => (int) $form_state['values']['visibility'],
        'pages' => trim($form_state['values']['pages']),
        'custom' => (int) $form_state['values']['custom'],
        'title' => $form_state['values']['title'],
        'module' => $form_state['values']['module'],
        'theme' => $theme->name,
        'status' => 0,
        'weight' => 0,
        'delta' => $delta,
        'cache' => DRUPAL_NO_CACHE,
      ));
    }
  }
  $query
    ->execute();
  $query = db_insert('block_role')
    ->fields(array(
    'rid',
    'module',
    'delta',
  ));
  foreach (array_filter($form_state['values']['roles']) as $rid) {
    $query
      ->values(array(
      'rid' => $rid,
      'module' => $form_state['values']['module'],
      'delta' => $delta,
    ));
  }
  $query
    ->execute();

  // Store regions per theme for this block.
  foreach ($form_state['values']['regions'] as $theme => $region) {
    db_merge('block')
      ->key(array(
      'theme' => $theme,
      'delta' => $delta,
      'module' => $form_state['values']['module'],
    ))
      ->fields(array(
      'region' => $region == BLOCK_REGION_NONE ? '' : $region,
      'pages' => trim($form_state['values']['pages']),
      'status' => (int) ($region != BLOCK_REGION_NONE),
    ))
      ->execute();
  }
  drupal_set_message(t('The block has been created.'));
  cache_clear_all();
  $form_state['redirect'] = 'admin/structure/block';
}

/**
 * Form constructor for the custom Twitter block deletion form.
 *
 * @param $delta
 *   The unique ID of the block within the context of $module.
 *
 * @see twitter_block_delete_submit()
 */
function twitter_block_delete($form, &$form_state, $delta) {
  $block = block_load('twitter_block', $delta);
  $twitter_block = twitter_block_block_get($block->delta);
  $form['info'] = array(
    '#type' => 'hidden',
    '#value' => $twitter_block['info'] ? $twitter_block['info'] : $twitter_block['title'],
  );
  $form['bid'] = array(
    '#type' => 'hidden',
    '#value' => $block->delta,
  );
  return confirm_form($form, t('Are you sure you want to delete the block %name?', array(
    '%name' => $twitter_block['info'],
  )), 'admin/structure/block', '', t('Delete'), t('Cancel'));
}

/**
 * Form submission handler for twitter_block_delete().
 *
 * @see twitter_block_delete()
 */
function twitter_block_delete_submit($form, &$form_state) {
  db_delete('twitter_block')
    ->condition('bid', $form_state['values']['bid'])
    ->execute();
  db_delete('block')
    ->condition('module', 'twitter_block')
    ->condition('delta', $form_state['values']['bid'])
    ->execute();
  db_delete('block_role')
    ->condition('module', 'twitter_block')
    ->condition('delta', $form_state['values']['bid'])
    ->execute();
  drupal_set_message(t('The block %name has been removed.', array(
    '%name' => $form_state['values']['info'],
  )));
  cache_clear_all();
  $form_state['redirect'] = 'admin/structure/block';
  return;
}

Functions

Name	Description
twitter_block_add_block_form	Form constructor for the add block form.
twitter_block_add_block_form_submit	Form submission handler for twitter_block_add_block_form().
twitter_block_add_block_form_validate	Form validation handler for twitter_block_add_block_form().
twitter_block_admin_settings_form	Implements hook_admin_settings() for module settings configuration.
twitter_block_delete	Form constructor for the custom Twitter block deletion form.
twitter_block_delete_submit	Form submission handler for twitter_block_delete().