Mercurial > defr > drupal > scald > mee

annotate mee.module @ 0:548f63d8a41b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Blam, simple MEE cck field type.
author David Eads <eads@chicagotech.org>
date Tue, 10 Mar 2009 13:44:50 -0500
parents
children 3d3d533f9eff
rev   line source
eads@0 1 <?php
eads@0 2 // $Id;
eads@0 3 /**
eads@0 4 * @file
eads@0 5 * Defines a special textarea, with drag and drop media driven by Scald and
eads@0 6 * dnd.module when rich text editing is enabled on the textarea via the
eads@0 7 * WYSIWYG API.
eads@0 8 */
eads@0 9
eads@0 10 /**
eads@0 11 * Implementation of hook_theme().
eads@0 12 */
eads@0 13 function mee_theme() {
eads@0 14 $theme = array(
eads@0 15 'mee_textarea' => array(
eads@0 16 'arguments' => array('element' => NULL),
eads@0 17 ),
eads@0 18 'mee_formatter_default' => array(
eads@0 19 'arguments' => array('element' => NULL),
eads@0 20 ),
eads@0 21 );
eads@0 22 // @TODO enable!
eads@0 23 //foreach (scald_contexts() as $context) {
eads@0 24 // $theme['mee_formatter_'. $context] = array(
eads@0 25 // 'arguments' => array('element' => NULL),
eads@0 26 // 'function' => 'theme_mee_context_formatter',
eads@0 27 // );
eads@0 28 //}
eads@0 29 return $theme;
eads@0 30 }
eads@0 31
eads@0 32 /**
eads@0 33 * Implementation of hook_field_info().
eads@0 34 */
eads@0 35 function mee_field_info() {
eads@0 36 return array(
eads@0 37 'multimedia_editorial_element' => array(
eads@0 38 'label' => t('Multimedia Editorial Element (MEE)'),
eads@0 39 'description' => t('MEE combines Scald, WYSIWYG, and DnD to create a multimedia enabled text field.'),
eads@0 40 ),
eads@0 41 );
eads@0 42 }
eads@0 43
eads@0 44 /**
eads@0 45 * Implementation of hook_field_settings().
eads@0 46 */
eads@0 47 function mee_field_settings($op, $field) {
eads@0 48 switch ($op) {
eads@0 49 case 'form':
eads@0 50 $form = array();
eads@0 51 $options = array(0 => t('Plain text'), 1 => t('Filtered text (user selects input format)'));
eads@0 52 $form['mee_processing'] = array(
eads@0 53 '#type' => 'radios',
eads@0 54 '#title' => t('Text processing'),
eads@0 55 '#default_value' => is_numeric($field['mee_processing']) ? $field['mee_processing'] : 1,
eads@0 56 '#options' => $options,
eads@0 57 '#description' => t('Filtered text, with a WYSIWYG editor defined on one or more input formats, is strongly recommended.'),
eads@0 58 );
eads@0 59 // @TODO Ask Drupal about available libraries
eads@0 60 $form['mee_dnd_callback_url'] = array(
eads@0 61 '#type' => 'textfield',
eads@0 62 '#title' => t('Library callback URL'),
eads@0 63 '#default_value' => url($field['mee_dnd_callback_url']) ? $field['mee_dnd_callback_url'] : '',
eads@0 64 '#description' => t('The absolute URL or relative path of a callback URL that provides proper JSON to the drag and drop library.'),
eads@0 65 );
eads@0 66 return $form;
eads@0 67
eads@0 68 case 'save':
eads@0 69 return array('mee_processing', 'mee_dnd_callback_url');
eads@0 70
eads@0 71 case 'database columns':
eads@0 72 $columns['value'] = array('type' => 'text', 'size' => 'big', 'not null' => FALSE, 'sortable' => TRUE);
eads@0 73 $columns['dnd_callback_url'] = array('type' => 'text', 'size' => 'small', 'not null' => FALSE);
eads@0 74 if (!empty($field['mee_processing'])) {
eads@0 75 $columns['format'] = array('type' => 'int', 'unsigned' => TRUE, 'not null' => FALSE);
eads@0 76 }
eads@0 77 return $columns;
eads@0 78
eads@0 79 case 'views data':
eads@0 80 return content_views_field_views_data($field);
eads@0 81 }
eads@0 82 }
eads@0 83
eads@0 84 /**
eads@0 85 * Implementation of hook_field().
eads@0 86 */
eads@0 87 function mee_field($op, &$node, $field, &$items, $teaser, $page) {
eads@0 88 switch ($op) {
eads@0 89 case 'sanitize':
eads@0 90 foreach ($items as $delta => $item) {
eads@0 91 if (!empty($field['mee_processing'])) {
eads@0 92 $check = is_null($node) || (isset($node->build_mode) && $node->build_mode == NODE_BUILD_PREVIEW);
eads@0 93 $text = isset($item['value']) ? check_markup($item['value'], $item['format'], $check) : '';
eads@0 94 }
eads@0 95 else {
eads@0 96 $text = check_plain($item['value']);
eads@0 97 }
eads@0 98 $items[$delta]['safe'] = $text;
eads@0 99 }
eads@0 100 }
eads@0 101 }
eads@0 102
eads@0 103 /**
eads@0 104 * Implementation of hook_content_is_empty().
eads@0 105 */
eads@0 106 function mee_content_is_empty($item, $field) {
eads@0 107 if (empty($item['value']) && (string)$item['value'] !== '0') {
eads@0 108 return TRUE;
eads@0 109 }
eads@0 110 return FALSE;
eads@0 111 }
eads@0 112
eads@0 113 /**
eads@0 114 * Implementation of hook_field_formatter_info().
eads@0 115 */
eads@0 116 function mee_field_formatter_info() {
eads@0 117 $formatters = array(
eads@0 118 'default' => array(
eads@0 119 'label' => t('Filtered text'),
eads@0 120 'field types' => array('multimedia_editorial_element'),
eads@0 121 'multiple values' => CONTENT_HANDLE_CORE,
eads@0 122 ),
eads@0 123 'plain' => array(
eads@0 124 'label' => t('Plain text'),
eads@0 125 'field types' => array('multimedia_editorial_element'),
eads@0 126 'multiple values' => CONTENT_HANDLE_CORE,
eads@0 127 ),
eads@0 128 );
eads@0 129 //@TODO generate context processor based field formatters
eads@0 130 //foreach (scald_contexts() as $context) {
eads@0 131 // $formatters[$context] = array(
eads@0 132 // 'label' => t('Scald context processor: @context', array('@context' => $context),
eads@0 133 // 'field types' => 'mee',
eads@0 134 // );
eads@0 135 //}
eads@0 136 return $formatters;
eads@0 137 }
eads@0 138
eads@0 139 function theme_mee_formatter_default($element) {
eads@0 140 return $element['#item']['safe'];
eads@0 141 }
eads@0 142
eads@0 143 /**
eads@0 144 * Theme function for 'plain' text field formatter.
eads@0 145 */
eads@0 146 function theme_mee_formatter_plain($element) {
eads@0 147 return strip_tags($element['#item']['safe']);
eads@0 148 }
eads@0 149
eads@0 150 function theme_mee_context_formatter($element) {
eads@0 151 return 'foo';
eads@0 152 }
eads@0 153
eads@0 154 /**
eads@0 155 * Implementation of hook_widget_info().
eads@0 156 */
eads@0 157 function mee_widget_info() {
eads@0 158 return array(
eads@0 159 'mee_textarea' => array(
eads@0 160 'label' => t('MEE Textarea'),
eads@0 161 'field types' => array('multimedia_editorial_element'),
eads@0 162 'multiple values' => CONTENT_HANDLE_CORE,
eads@0 163 ),
eads@0 164 );
eads@0 165 }
eads@0 166
eads@0 167 /**
eads@0 168 * Implementation of FAPI hook_elements().
eads@0 169 *
eads@0 170 * Any FAPI callbacks needed for individual widgets can be declared here,
eads@0 171 * and the element will be passed to those callbacks for processing.
eads@0 172 *
eads@0 173 * Drupal will automatically theme the element using a theme with
eads@0 174 * the same name as the hook_elements key.
eads@0 175 */
eads@0 176 function mee_elements() {
eads@0 177 return array(
eads@0 178 'mee_textarea' => array(
eads@0 179 '#input' => TRUE,
eads@0 180 '#columns' => array('value', 'format'), '#delta' => 0,
eads@0 181 '#process' => array('mee_textarea_process', 'dnd_process_textarea'),
eads@0 182 '#filter_value' => FILTER_FORMAT_DEFAULT,
eads@0 183 ),
eads@0 184 );
eads@0 185 }
eads@0 186
eads@0 187 /**
eads@0 188 * Implementation of hook_widget_settings().
eads@0 189 */
eads@0 190 function mee_widget_settings($op, $widget) {
eads@0 191 switch ($op) {
eads@0 192 case 'form':
eads@0 193 $form = array();
eads@0 194 $rows = (isset($widget['rows']) && is_numeric($widget['rows'])) ? $widget['rows'] : 5;
eads@0 195 $size = (isset($widget['size']) && is_numeric($widget['size'])) ? $widget['size'] : 60;
eads@0 196 $form['rows'] = array(
eads@0 197 '#type' => 'textfield',
eads@0 198 '#title' => t('Rows'),
eads@0 199 '#default_value' => $rows,
eads@0 200 '#element_validate' => array('_mee_widget_settings_row_validate'),
eads@0 201 '#required' => TRUE,
eads@0 202 );
eads@0 203 $form['size'] = array('#type' => 'hidden', '#value' => $size);
eads@0 204 return $form;
eads@0 205
eads@0 206 case 'save':
eads@0 207 return array('rows', 'size');
eads@0 208 }
eads@0 209 }
eads@0 210
eads@0 211 function _mee_widget_settings_row_validate($element, &$form_state) {
eads@0 212 $value = $form_state['values']['rows'];
eads@0 213 if (!is_numeric($value) || intval($value) != $value || $value <= 0) {
eads@0 214 form_error($element, t('"Rows" must be a positive integer.'));
eads@0 215 }
eads@0 216 }
eads@0 217
eads@0 218 function _mee_widget_settings_size_validate($element, &$form_state) {
eads@0 219 $value = $form_state['values']['size'];
eads@0 220 if (!is_numeric($value) || intval($value) != $value || $value <= 0) {
eads@0 221 form_error($element, t('"Size" must be a positive integer.'));
eads@0 222 }
eads@0 223 }
eads@0 224
eads@0 225 /**
eads@0 226 * Implementation of hook_widget().
eads@0 227 *
eads@0 228 * Attach a single form element to the form. It will be built out and
eads@0 229 * validated in the callback(s) listed in hook_elements. We build it
eads@0 230 * out in the callbacks rather than here in hook_widget so it can be
eads@0 231 * plugged into any module that can provide it with valid
eads@0 232 * $field information.
eads@0 233 *
eads@0 234 * Content module will set the weight, field name and delta values
eads@0 235 * for each form element. This is a change from earlier CCK versions
eads@0 236 * where the widget managed its own multiple values.
eads@0 237 *
eads@0 238 * If there are multiple values for this field, the content module will
eads@0 239 * call this function as many times as needed.
eads@0 240 *
eads@0 241 * @param $form
eads@0 242 * the entire form array, $form['#node'] holds node information
eads@0 243 * @param $form_state
eads@0 244 * the form_state, $form_state['values'][$field['field_name']]
eads@0 245 * holds the field's form values.
eads@0 246 * @param $field
eads@0 247 * the field array
eads@0 248 * @param $items
eads@0 249 * array of default values for this field
eads@0 250 * @param $delta
eads@0 251 * the order of this item in the array of subelements (0, 1, 2, etc)
eads@0 252 *
eads@0 253 * @return
eads@0 254 * the form item for a single element for this field
eads@0 255 */
eads@0 256 function mee_widget(&$form, &$form_state, $field, $items, $delta = 0) {
eads@0 257 $element = array(
eads@0 258 '#type' => $field['widget']['type'],
eads@0 259 '#default_value' => isset($items[$delta]) ? $items[$delta] : '',
eads@0 260 );
eads@0 261 return $element;
eads@0 262 }
eads@0 263
eads@0 264 /**
eads@0 265 * Process an individual element.
eads@0 266 *
eads@0 267 * Build the form element. When creating a form using FAPI #process,
eads@0 268 * note that $element['#value'] is already set.
eads@0 269 *
eads@0 270 * The $fields array is in $form['#field_info'][$element['#field_name']].
eads@0 271 */
eads@0 272 function mee_textarea_process($element, $edit, $form_state, $form) {
eads@0 273 drupal_add_css(drupal_get_path('module', 'mee') .'/css/mee.css');
eads@0 274
eads@0 275 $field = $form['#field_info'][$element['#field_name']];
eads@0 276 $field_key = $element['#columns'][0];
eads@0 277 $element[$field_key] = array(
eads@0 278 '#type' => 'textarea',
eads@0 279 '#default_value' => isset($element['#value'][$field_key]) ? $element['#value'][$field_key] : NULL,
eads@0 280 '#rows' => !empty($field['widget']['rows']) ? $field['widget']['rows'] : 10,
eads@0 281 '#weight' => 0,
eads@0 282 // The following values were set by the content module and need
eads@0 283 // to be passed down to the nested element.
eads@0 284 '#title' => $element['#title'],
eads@0 285 '#description' => $element['#description'],
eads@0 286 '#required' => $element['#required'],
eads@0 287 '#field_name' => $element['#field_name'],
eads@0 288 '#type_name' => $element['#type_name'],
eads@0 289 '#delta' => $element['#delta'],
eads@0 290 '#columns' => $element['#columns'],
eads@0 291 '#prefix' => '<div class="mee-wrap-editor-library">',
eads@0 292 '#suffix' => '</div>',
eads@0 293 '#dnd-enabled' => TRUE,
eads@0 294 '#dnd-settings' => array(
eads@0 295 'drop_selector' => '#'. $element['#id'] .' .drop',
eads@0 296 'url' => $field['mee_dnd_callback_url'],
eads@0 297 ),
eads@0 298 );
eads@0 299
eads@0 300 if (!empty($field['mee_processing'])) {
eads@0 301 $filter_key = (count($element['#columns']) == 2) ? $element['#columns'][1] : 'format';
eads@0 302 $format = isset($element['#value'][$filter_key]) ? $element['#value'][$filter_key] : FILTER_FORMAT_DEFAULT;
eads@0 303 $parents = array_merge($element['#parents'] , array($filter_key));
eads@0 304 $element[$filter_key] = filter_form($format, 1, $parents);
eads@0 305 }
eads@0 306
eads@0 307 // Used so that hook_field('validate') knows where to flag an error.
eads@0 308 $element['_error_element'] = array(
eads@0 309 '#type' => 'value',
eads@0 310 '#value' => implode('][', array_merge($element['#parents'], array($field_key))),
eads@0 311 );
eads@0 312
eads@0 313
eads@0 314 return $element;
eads@0 315 }
eads@0 316
eads@0 317 /**
eads@0 318 * FAPI theme for an individual text elements.
eads@0 319 *
eads@0 320 * The textfield or textarea is already rendered by the
eads@0 321 * textfield or textarea themes and the html output
eads@0 322 * lives in $element['#children']. Override this theme to
eads@0 323 * make custom changes to the output.
eads@0 324 *
eads@0 325 * $element['#field_name'] contains the field name
eads@0 326 * $element['#delta] is the position of this element in the group
eads@0 327 */
eads@0 328 function theme_mee_textarea($element) {
eads@0 329 return $element['#children'];
eads@0 330 }