public function colorbox_handler_field_colorbox::options_form in Colorbox 7.2

Same name and namespace in other branches

1. 6 views/colorbox_handler_field_colorbox.inc \colorbox_handler_field_colorbox::options_form()
2. 7 views/colorbox_handler_field_colorbox.inc \colorbox_handler_field_colorbox::options_form()

Options for form.

@codingStandardsIgnoreStart

Overrides views_handler_field::options_form

File

views/colorbox_handler_field_colorbox.inc, line 51

Views handlers for Colorbox module.

Class

colorbox_handler_field_colorbox

A handler to provide a field that is completely custom by the administrator.

Code

public function options_form(&$form, &$form_state) {

  // @codingStandardsIgnoreEnd
  parent::options_form($form, $form_state);

  // Get a list of the available fields and arguments for trigger field and
  // token replacement.
  $options = array();
  $fields = array(
    'trigger_field' => t('- None -'),
  );
  foreach ($this->view->display_handler
    ->get_handlers('field') as $field => $handler) {
    $options[t('Fields')]["[{$field}]"] = $handler
      ->ui_name();

    // We only use fields up to (and including) this one.
    if ($field == $this->options['id']) {
      break;
    }
    $fields[$field] = $handler->definition['title'];
  }

  // This lets us prepare the key as we want it printed.
  $count = 0;
  foreach ($this->view->display_handler
    ->get_handlers('argument') as $handler) {
    $options[t('Arguments')]['%' . ++$count] = t('@argument title', array(
      '@argument' => $handler
        ->ui_name(),
    ));
    $options[t('Arguments')]['!' . $count] = t('@argument input', array(
      '@argument' => $handler
        ->ui_name(),
    ));
  }
  $this
    ->document_self_tokens($options[t('Fields')]);

  // Default text.
  $patterns = t('<p>You must add some additional fields to this display before using this field. These fields may be marked as <em>Exclude from display</em> if you prefer. Note that due to rendering order, you cannot use fields that come after this field; if you need a field not listed here, rearrange your fields.</p>');

  // We have some options, so make a list.
  if (!empty($options)) {
    $patterns = t('<p>The following tokens are available for this field. Note that due to rendering order, you cannot use fields that come after this field; if you need a field not listed here, rearrange your fields.
If you would like to have the characters %5B and %5D please use the html entity codes \'%5B\' or  \'%5D\' or they will get replaced with empty space.</p>');
    foreach (array_keys($options) as $type) {
      if (!empty($options[$type])) {
        $items = array();
        foreach ($options[$type] as $key => $value) {
          $items[] = $key . ' == ' . $value;
        }
        $patterns .= theme('item_list', array(
          'items' => $items,
          'type' => $type,
        ));
      }
    }
  }
  $form['trigger_field'] = array(
    '#type' => 'select',
    '#title' => t('Trigger field'),
    '#description' => t('Select the field that should be turned into the trigger for the Colorbox.  Only fields that appear before this one in the field list may be used.'),
    '#options' => $fields,
    '#default_value' => $this->options['trigger_field'],
    '#weight' => -12,
  );
  $form['popup'] = array(
    '#type' => 'textarea',
    '#title' => t('Popup'),
    '#description' => t('The Colorbox popup content. You may include HTML. You may enter data from this view as per the "Replacement patterns" below.'),
    '#default_value' => $this->options['popup'],
    '#weight' => -11,
  );
  $form['caption'] = array(
    '#type' => 'textfield',
    '#title' => t('Caption'),
    '#description' => t('The Colorbox Caption. You may include HTML. You may enter data from this view as per the "Replacement patterns" below.'),
    '#default_value' => $this->options['caption'],
    '#weight' => -10,
  );
  $form['gid'] = array(
    '#type' => 'checkbox',
    '#title' => t('Automatic generated Colorbox gallery'),
    '#description' => t('Enable Colorbox gallery using a generated gallery id for this view.'),
    '#default_value' => $this->options['gid'],
    '#weight' => -9,
  );
  $form['custom_gid'] = array(
    '#type' => 'textfield',
    '#title' => t('Custom Colorbox gallery'),
    '#description' => t('Enable Colorbox gallery with a given string as gallery. Overrides the automatically generated gallery id above. You may enter data from this view as per the "Replacement patterns" below.'),
    '#default_value' => $this->options['custom_gid'],
    '#weight' => -8,
  );
  $form['width'] = array(
    '#type' => 'textfield',
    '#title' => t('Width'),
    '#description' => t('Specify the width of the Colorbox popup window. Because the content is dynamic, we cannot detect this value automatically. Example: "100%", 500, "500px".'),
    '#default_value' => $this->options['width'],
    '#weight' => -6,
  );
  $form['height'] = array(
    '#type' => 'textfield',
    '#title' => t('Height'),
    '#description' => t('Specify the height of the Colorbox popup window. Because the content is dynamic, we cannot detect this value automatically. Example: "100%", 500, "500px".'),
    '#default_value' => $this->options['height'],
    '#weight' => -7,
  );
  $form['patterns'] = array(
    '#type' => 'fieldset',
    '#title' => t('Replacement patterns'),
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
    '#value' => $patterns,
  );
}