' . t('The color code in this field is @code', array('@code' => $item['rgb'])) . '
'; } break; // This formatter adds css to the page changing the '.region-content' area's // background color. If there are many fields, the last one will win. case 'field_example_color_background': foreach ($items as $delta => $item) { drupal_add_css('div.region-content { background-color:' . $item['rgb'] . ';}', array('type' => 'inline') ); $element[$delta]['#markup'] = '' . t('The content area color has been changed to @code', array('@code' => $item['rgb'])) . '
'; } break; } return $element; } /************************************************************************** * Field Type API: Widget * * The widget is the form element used to receive input from the user * when the field is being populated. **************************************************************************/ /** * Implements hook_field_widget_info(). * * Three widgets are provided. * - A simple text-only widget where the user enters the '#ffffff'. * - A 3-textfield widget that gathers the red, green, and blue values * separately. * - A farbtastic colorpicker widget that chooses the value graphically. */ function field_example_field_widget_info() { return array( 'field_example_text' => array( 'label' => t('RGB value as #ffffff'), 'field types' => array('field_example_rgb'), ), 'field_example_3text' => array( 'label' => t('RGB text field'), 'field types' => array('field_example_rgb'), ), 'field_example_colorpicker' => array( 'label' => t('Color Picker'), 'field types' => array('field_example_rgb'), ), ); } /** * Implements hook_field_widget_form(). * * Three different forms are provided, for the three widget types. * * The 'field_example_colorpicker' and 'field_example_text' are essentially * the same, but field_example_colorpicker adds a javascript colorpicker * helper. * * field_example_3text displays three text fields, one each for red, green, * and blue. However, the field type defines a single text column, * rgb, which needs an HTML color spec. Define an element validate * handler that converts our r, g, and b fields into a simulated single * 'rgb' form element. */ function field_example_field_widget_form(&$form, &$form_state, $field, $instance, $langcode, $items, $delta, $element) { $value = isset($items[$delta]['rgb']) ? $items[$delta]['rgb'] : ''; $element += array( '#delta' => $delta, ); $element['rgb'] = array(); switch ($instance['widget']['type']) { case 'field_example_colorpicker': $element['rgb'] += array( '#suffix' => '', '#attributes' => array('class' => array('edit-field-example-colorpicker')), '#attached' => array( // Add Farbtastic color picker. 'library' => array( array('system', 'farbtastic'), ), // Add javascript to trigger the colorpicker. 'js' => array(drupal_get_path('module', 'field_example') . '/field_example.js'), ), ); // DELIBERATE fall-through: From here on the field_example_text and // field_example_colorpicker are exactly the same. case 'field_example_text': $element['rgb'] += array( '#type' => 'textfield', '#default_value' => $value, // Allow a slightly larger size that the field length to allow for some // configurations where all characters won't fit in input field. '#size' => 7, '#maxlength' => 7, ); break; case 'field_example_3text': // Convert rgb value into r, g, and b for #default_value. if (isset($items[$delta]['rgb'])) { preg_match_all('@..@', substr($items[$delta]['rgb'], 1), $match); } else { $match = array(array()); } // A fieldset to hold the three text fields. $element += array( '#type' => 'fieldset', '#element_validate' => array('field_example_3text_validate'), // The following is set so that the validation function will be able // to access external value information which otherwise would be // unavailable. '#delta' => $delta, '#attached' => array( 'css' => array(drupal_get_path('module', 'field_example') . '/field_example.css'), ), ); // Create a textfield for saturation values for Red, Green, and Blue. foreach (array('r' => t('Red'), 'g' => t('Green'), 'b' => t('Blue')) as $key => $title) { $element[$key] = array( '#type' => 'textfield', '#title' => $title, '#size' => 2, '#default_value' => array_shift($match[0]), '#attributes' => array('class' => array('rgb-entry')), // '#description' => t('The 2-digit hexadecimal representation of the @color saturation, like "a1" or "ff"', array('@color' => $title)), ); } break; } return $element; } /** * Validate the individual fields and then convert them into a single HTML RGB * value as text. */ function field_example_3text_validate($element, &$form_state) { $delta = $element['#delta']; // TODO: Isn't there a better way to find out which element? $field = $form_state['field'][$element['#field_name']][$element['#language']]['field']; $field_name = $field['field_name']; if (isset($form_state['values'][$field_name][$element['#language']][$delta])) { $values = $form_state['values'][$field_name][$element['#language']][$delta]; foreach (array('r', 'g', 'b') as $colorfield) { $val = hexdec($values[$colorfield]); // If they left any empty, we'll set the value empty and quit. if (strlen($values[$colorfield]) == 0) { form_set_value($element, array('rgb' => NULL), $form_state); return; } // If they gave us anything that's not hex, reject it. if ( (strlen($values[$colorfield]) != 2) || $val < 0 || $val > 255) { form_error($element[$colorfield], t("Saturation value must be a 2-digit hexadecimal value between 00 and ff.")); } } $value = sprintf('#%02s%02s%02s', $values['r'], $values['g'], $values['b']); form_set_value($element, array('rgb' => $value), $form_state); } } /** * Implements hook_field_widget_error(). */ function field_example_field_widget_error($element, $error, $form, &$form_state) { switch ($error['error']) { case 'field_example_invalid': form_error($element, $error['message']); break; } } /** * Implements hook_menu(). * * Provides a simple user interface that tells the developer where to go. */ function field_example_menu() { $items['examples/field_example'] = array( 'title' => 'Field Example', 'page callback' => '_field_example_page', 'access callback' => TRUE, ); return $items; } /** * A simple page to explain to the developer what to do. */ function _field_example_page() { return t("The Field Example provides a field composed of an HTML RGB value, like #ff00ff. To use it, add the field to a content type."); }