Mercurial > defr > drupal > scald > mee

annotate mee.module @ 3:d52c1baec6fb

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Implemented Scald CRUD triggers based on field value updates.
author Tom Wolf <tom@t-dub.net>
date Wed, 22 Apr 2009 23:32:15 -0500
parents 3d3d533f9eff
children e2bf7cf37972
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 );
tom@2 22
tom@2 23 $scald_config = variable_get('scald_config', 0);
tom@2 24 foreach ($scald_config->contexts as $context => $details) {
tom@2 25 $theme['mee_formatter_'. $context] = array(
tom@2 26 'arguments' => array('element' => NULL),
tom@2 27 'function' => 'theme_mee_context_formatter',
tom@2 28 );
tom@2 29 }
eads@0 30 return $theme;
eads@0 31 }
eads@0 32
eads@0 33 /**
eads@0 34 * Implementation of hook_field_info().
eads@0 35 */
eads@0 36 function mee_field_info() {
eads@0 37 return array(
eads@0 38 'multimedia_editorial_element' => array(
eads@0 39 'label' => t('Multimedia Editorial Element (MEE)'),
eads@0 40 'description' => t('MEE combines Scald, WYSIWYG, and DnD to create a multimedia enabled text field.'),
eads@0 41 ),
eads@0 42 );
eads@0 43 }
eads@0 44
eads@0 45 /**
eads@0 46 * Implementation of hook_field_settings().
eads@0 47 */
eads@0 48 function mee_field_settings($op, $field) {
eads@0 49 switch ($op) {
eads@0 50 case 'form':
eads@0 51 $form = array();
eads@0 52 $options = array(0 => t('Plain text'), 1 => t('Filtered text (user selects input format)'));
eads@0 53 $form['mee_processing'] = array(
eads@0 54 '#type' => 'radios',
eads@0 55 '#title' => t('Text processing'),
eads@0 56 '#default_value' => is_numeric($field['mee_processing']) ? $field['mee_processing'] : 1,
eads@0 57 '#options' => $options,
eads@0 58 '#description' => t('Filtered text, with a WYSIWYG editor defined on one or more input formats, is strongly recommended.'),
eads@0 59 );
eads@0 60 // @TODO Ask Drupal about available libraries
eads@0 61 $form['mee_dnd_callback_url'] = array(
eads@0 62 '#type' => 'textfield',
eads@0 63 '#title' => t('Library callback URL'),
eads@0 64 '#default_value' => url($field['mee_dnd_callback_url']) ? $field['mee_dnd_callback_url'] : '',
eads@0 65 '#description' => t('The absolute URL or relative path of a callback URL that provides proper JSON to the drag and drop library.'),
eads@0 66 );
tom@3 67 // @TODO: Add an "Editor Context" option on a per-field basis
eads@0 68 return $form;
eads@0 69
eads@0 70 case 'save':
eads@0 71 return array('mee_processing', 'mee_dnd_callback_url');
eads@0 72
eads@0 73 case 'database columns':
eads@0 74 $columns['value'] = array('type' => 'text', 'size' => 'big', 'not null' => FALSE, 'sortable' => TRUE);
eads@0 75 $columns['dnd_callback_url'] = array('type' => 'text', 'size' => 'small', 'not null' => FALSE);
eads@0 76 if (!empty($field['mee_processing'])) {
eads@0 77 $columns['format'] = array('type' => 'int', 'unsigned' => TRUE, 'not null' => FALSE);
eads@0 78 }
eads@0 79 return $columns;
eads@0 80
eads@0 81 case 'views data':
eads@0 82 return content_views_field_views_data($field);
eads@0 83 }
eads@0 84 }
eads@0 85
eads@0 86 /**
eads@0 87 * Implementation of hook_field().
eads@0 88 */
eads@0 89 function mee_field($op, &$node, $field, &$items, $teaser, $page) {
eads@0 90 switch ($op) {
tom@2 91 case 'presave':
tom@2 92 // @@@TODO: parse the field & replace editor reps with SAS
tom@2 93 break; // end 'submit'
tom@2 94
tom@2 95 case 'insert':
tom@2 96 foreach ($items as $delta => $item) {
tom@3 97 $scald_included = scald_included($item);
tom@3 98
tom@3 99 $temp_atom = new stdClass;
tom@3 100 $temp_atom->type = 'composite';
tom@3 101 $temp_atom->provider = 'mee';
tom@3 102 $temp_atom->base_id = $node->nid . ':' . $delta;
tom@3 103 $temp_atom->publisher = $node->uid;
tom@3 104 $temp_atom->title = $node->title;
tom@3 105 $temp_atom->authors = array(scald_uid_to_aid($node->uid));
tom@2 106 $temp_atom->relationships = empty($scald_included) ? array() : array('includes' => $scald_included);
tom@3 107
tom@2 108 $sid = scald_register_atom($temp_atom);
tom@2 109 }
tom@2 110 break; // end 'insert'
tom@2 111
tom@2 112 case 'update':
tom@2 113 foreach ($items as $delta => $item) {
tom@3 114 $scald_included = scald_included($item);
tom@2 115
tom@3 116 // @@@TODO: Handle failure of fetch
tom@3 117 $atom = scald_fetch(scald_search(array('base_id' => $node->nid . ':' . $delta), FALSE, TRUE));
tom@3 118 $atom->publisher = $node->uid;
tom@3 119 $atom->title = $node->title;
tom@3 120 $atom->authors = array(
tom@3 121 $temp_atom->relationships = empty($scald_included) ? array() : array('includes' => $scald_included);
tom@3 122
tom@3 123 scald_update_atom($atom);
tom@2 124 }
tom@2 125 break; // end 'update'
tom@2 126
tom@2 127 case 'delete':
tom@3 128 foreach ($items as $delta => $item) {
tom@3 129 scald_unregister_atom(scald_search(array('base_id' => $node->nid . ':' . $delta), FALSE, TRUE));
tom@3 130 }
tom@2 131 break; // end 'delete'
tom@2 132
eads@0 133 case 'sanitize':
eads@0 134 foreach ($items as $delta => $item) {
eads@0 135 if (!empty($field['mee_processing'])) {
eads@0 136 $check = is_null($node) || (isset($node->build_mode) && $node->build_mode == NODE_BUILD_PREVIEW);
eads@0 137 $text = isset($item['value']) ? check_markup($item['value'], $item['format'], $check) : '';
eads@0 138 }
eads@0 139 else {
eads@0 140 $text = check_plain($item['value']);
eads@0 141 }
eads@0 142 $items[$delta]['safe'] = $text;
eads@0 143 }
tom@2 144 break; // end 'sanitize'
eads@0 145 }
eads@0 146 }
eads@0 147
eads@0 148 /**
eads@0 149 * Implementation of hook_content_is_empty().
eads@0 150 */
eads@0 151 function mee_content_is_empty($item, $field) {
eads@0 152 if (empty($item['value']) && (string)$item['value'] !== '0') {
eads@0 153 return TRUE;
eads@0 154 }
eads@0 155 return FALSE;
eads@0 156 }
eads@0 157
eads@0 158 /**
eads@0 159 * Implementation of hook_field_formatter_info().
eads@0 160 */
eads@0 161 function mee_field_formatter_info() {
eads@0 162 $formatters = array(
eads@0 163 'default' => array(
eads@0 164 'label' => t('Filtered text'),
eads@0 165 'field types' => array('multimedia_editorial_element'),
eads@0 166 'multiple values' => CONTENT_HANDLE_CORE,
eads@0 167 ),
eads@0 168 'plain' => array(
eads@0 169 'label' => t('Plain text'),
eads@0 170 'field types' => array('multimedia_editorial_element'),
eads@0 171 'multiple values' => CONTENT_HANDLE_CORE,
eads@0 172 ),
eads@0 173 );
eads@0 174 //@TODO generate context processor based field formatters
eads@0 175 //foreach (scald_contexts() as $context) {
eads@0 176 // $formatters[$context] = array(
eads@0 177 // 'label' => t('Scald context processor: @context', array('@context' => $context),
eads@0 178 // 'field types' => 'mee',
eads@0 179 // );
eads@0 180 //}
eads@0 181 return $formatters;
eads@0 182 }
eads@0 183
eads@0 184 function theme_mee_formatter_default($element) {
eads@0 185 return $element['#item']['safe'];
eads@0 186 }
eads@0 187
eads@0 188 /**
eads@0 189 * Theme function for 'plain' text field formatter.
eads@0 190 */
eads@0 191 function theme_mee_formatter_plain($element) {
eads@0 192 return strip_tags($element['#item']['safe']);
eads@0 193 }
eads@0 194
eads@0 195 function theme_mee_context_formatter($element) {
eads@0 196 return 'foo';
eads@0 197 }
eads@0 198
eads@0 199 /**
eads@0 200 * Implementation of hook_widget_info().
eads@0 201 */
eads@0 202 function mee_widget_info() {
eads@0 203 return array(
eads@0 204 'mee_textarea' => array(
eads@0 205 'label' => t('MEE Textarea'),
eads@0 206 'field types' => array('multimedia_editorial_element'),
eads@0 207 'multiple values' => CONTENT_HANDLE_CORE,
eads@0 208 ),
eads@0 209 );
eads@0 210 }
eads@0 211
eads@0 212 /**
eads@0 213 * Implementation of FAPI hook_elements().
eads@0 214 *
eads@0 215 * Any FAPI callbacks needed for individual widgets can be declared here,
eads@0 216 * and the element will be passed to those callbacks for processing.
eads@0 217 *
eads@0 218 * Drupal will automatically theme the element using a theme with
eads@0 219 * the same name as the hook_elements key.
eads@0 220 */
eads@0 221 function mee_elements() {
eads@0 222 return array(
eads@0 223 'mee_textarea' => array(
eads@0 224 '#input' => TRUE,
eads@0 225 '#columns' => array('value', 'format'), '#delta' => 0,
eads@0 226 '#process' => array('mee_textarea_process', 'dnd_process_textarea'),
eads@0 227 '#filter_value' => FILTER_FORMAT_DEFAULT,
eads@0 228 ),
eads@0 229 );
eads@0 230 }
eads@0 231
eads@0 232 /**
eads@0 233 * Implementation of hook_widget_settings().
eads@0 234 */
eads@0 235 function mee_widget_settings($op, $widget) {
eads@0 236 switch ($op) {
eads@0 237 case 'form':
eads@0 238 $form = array();
eads@0 239 $rows = (isset($widget['rows']) && is_numeric($widget['rows'])) ? $widget['rows'] : 5;
eads@0 240 $size = (isset($widget['size']) && is_numeric($widget['size'])) ? $widget['size'] : 60;
eads@0 241 $form['rows'] = array(
eads@0 242 '#type' => 'textfield',
eads@0 243 '#title' => t('Rows'),
eads@0 244 '#default_value' => $rows,
eads@0 245 '#element_validate' => array('_mee_widget_settings_row_validate'),
eads@0 246 '#required' => TRUE,
eads@0 247 );
eads@0 248 $form['size'] = array('#type' => 'hidden', '#value' => $size);
eads@0 249 return $form;
eads@0 250
eads@0 251 case 'save':
eads@0 252 return array('rows', 'size');
eads@0 253 }
eads@0 254 }
eads@0 255
eads@0 256 function _mee_widget_settings_row_validate($element, &$form_state) {
eads@0 257 $value = $form_state['values']['rows'];
eads@0 258 if (!is_numeric($value) || intval($value) != $value || $value <= 0) {
eads@0 259 form_error($element, t('"Rows" must be a positive integer.'));
eads@0 260 }
eads@0 261 }
eads@0 262
eads@0 263 function _mee_widget_settings_size_validate($element, &$form_state) {
eads@0 264 $value = $form_state['values']['size'];
eads@0 265 if (!is_numeric($value) || intval($value) != $value || $value <= 0) {
eads@0 266 form_error($element, t('"Size" must be a positive integer.'));
eads@0 267 }
eads@0 268 }
eads@0 269
eads@0 270 /**
eads@0 271 * Implementation of hook_widget().
eads@0 272 *
eads@0 273 * Attach a single form element to the form. It will be built out and
eads@0 274 * validated in the callback(s) listed in hook_elements. We build it
eads@0 275 * out in the callbacks rather than here in hook_widget so it can be
eads@0 276 * plugged into any module that can provide it with valid
eads@0 277 * $field information.
eads@0 278 *
eads@0 279 * Content module will set the weight, field name and delta values
eads@0 280 * for each form element. This is a change from earlier CCK versions
eads@0 281 * where the widget managed its own multiple values.
eads@0 282 *
eads@0 283 * If there are multiple values for this field, the content module will
eads@0 284 * call this function as many times as needed.
eads@0 285 *
eads@0 286 * @param $form
eads@0 287 * the entire form array, $form['#node'] holds node information
eads@0 288 * @param $form_state
eads@0 289 * the form_state, $form_state['values'][$field['field_name']]
eads@0 290 * holds the field's form values.
eads@0 291 * @param $field
eads@0 292 * the field array
eads@0 293 * @param $items
eads@0 294 * array of default values for this field
eads@0 295 * @param $delta
eads@0 296 * the order of this item in the array of subelements (0, 1, 2, etc)
eads@0 297 *
eads@0 298 * @return
eads@0 299 * the form item for a single element for this field
eads@0 300 */
eads@0 301 function mee_widget(&$form, &$form_state, $field, $items, $delta = 0) {
eads@0 302 $element = array(
eads@0 303 '#type' => $field['widget']['type'],
eads@0 304 '#default_value' => isset($items[$delta]) ? $items[$delta] : '',
eads@0 305 );
eads@0 306 return $element;
eads@0 307 }
eads@0 308
eads@0 309 /**
eads@0 310 * Process an individual element.
eads@0 311 *
eads@0 312 * Build the form element. When creating a form using FAPI #process,
eads@0 313 * note that $element['#value'] is already set.
eads@0 314 *
eads@0 315 * The $fields array is in $form['#field_info'][$element['#field_name']].
eads@0 316 */
eads@0 317 function mee_textarea_process($element, $edit, $form_state, $form) {
eads@0 318 drupal_add_css(drupal_get_path('module', 'mee') .'/css/mee.css');
eads@0 319
eads@0 320 $field = $form['#field_info'][$element['#field_name']];
eads@0 321 $field_key = $element['#columns'][0];
eads@0 322 $element[$field_key] = array(
eads@0 323 '#type' => 'textarea',
eads@0 324 '#default_value' => isset($element['#value'][$field_key]) ? $element['#value'][$field_key] : NULL,
eads@0 325 '#rows' => !empty($field['widget']['rows']) ? $field['widget']['rows'] : 10,
eads@0 326 '#weight' => 0,
eads@0 327 // The following values were set by the content module and need
eads@0 328 // to be passed down to the nested element.
eads@0 329 '#title' => $element['#title'],
eads@0 330 '#description' => $element['#description'],
eads@0 331 '#required' => $element['#required'],
eads@0 332 '#field_name' => $element['#field_name'],
eads@0 333 '#type_name' => $element['#type_name'],
eads@0 334 '#delta' => $element['#delta'],
eads@0 335 '#columns' => $element['#columns'],
eads@0 336 '#prefix' => '<div class="mee-wrap-editor-library">',
eads@0 337 '#suffix' => '</div>',
eads@0 338 '#dnd-enabled' => TRUE,
eads@0 339 '#dnd-settings' => array(
eads@0 340 'drop_selector' => '#'. $element['#id'] .' .drop',
eads@0 341 'url' => $field['mee_dnd_callback_url'],
eads@0 342 ),
eads@0 343 );
eads@0 344
eads@0 345 if (!empty($field['mee_processing'])) {
eads@0 346 $filter_key = (count($element['#columns']) == 2) ? $element['#columns'][1] : 'format';
eads@0 347 $format = isset($element['#value'][$filter_key]) ? $element['#value'][$filter_key] : FILTER_FORMAT_DEFAULT;
eads@0 348 $parents = array_merge($element['#parents'] , array($filter_key));
eads@0 349 $element[$filter_key] = filter_form($format, 1, $parents);
eads@0 350 }
eads@0 351
eads@0 352 // Used so that hook_field('validate') knows where to flag an error.
eads@0 353 $element['_error_element'] = array(
eads@0 354 '#type' => 'value',
eads@0 355 '#value' => implode('][', array_merge($element['#parents'], array($field_key))),
eads@0 356 );
eads@0 357
eads@0 358
eads@0 359 return $element;
eads@0 360 }
eads@0 361
eads@0 362 /**
eads@0 363 * FAPI theme for an individual text elements.
eads@0 364 *
eads@0 365 * The textfield or textarea is already rendered by the
eads@0 366 * textfield or textarea themes and the html output
eads@0 367 * lives in $element['#children']. Override this theme to
eads@0 368 * make custom changes to the output.
eads@0 369 *
eads@0 370 * $element['#field_name'] contains the field name
eads@0 371 * $element['#delta] is the position of this element in the group
eads@0 372 */
eads@0 373 function theme_mee_textarea($element) {
eads@0 374 return $element['#children'];
eads@0 375 }
tom@2 376
tom@2 377
tom@2 378
tom@2 379
tom@2 380
tom@2 381
tom@2 382 /*******************************************************************************
tom@2 383 * SCALD HOOK IMPLEMENTATIONS
tom@2 384 ******************************************************************************/
tom@2 385
tom@2 386 /**
tom@2 387 * Implementation of hook_scald_provider().
tom@2 388 */
tom@2 389 function mee_scald_provider() {
tom@2 390 return array(
tom@2 391 'atoms' => array(
tom@2 392 'composite' => t('The MEE CCK field.'),
tom@2 393 ),
tom@2 394 );
tom@2 395 }
tom@2 396
tom@2 397
tom@2 398
tom@2 399 /**
tom@2 400 * Implementation of hook_scald_register_atom().
tom@2 401 */
tom@2 402 function mee_scald_register_atom($atom, $mode) {
tom@2 403
tom@2 404 } // end mee_scald_register_atom()
tom@2 405
tom@2 406
tom@2 407
tom@2 408 /**
tom@2 409 * Implementation of hook_scald_update_atom().
tom@2 410 */
tom@2 411 function mee_scald_update_atom($atom, $mode) {
tom@2 412
tom@2 413 } // end mee_scald_update_atom()
tom@2 414
tom@2 415
tom@2 416
tom@2 417 /**
tom@2 418 * Implementation of hook_scald_unregister_atom().
tom@2 419 */
tom@2 420 function mee_scald_unregister_atom($atom, $mode) {
tom@2 421
tom@2 422 } // end mee_scald_unregister_atom()
tom@2 423
tom@2 424
tom@2 425
tom@2 426 /**
tom@2 427 * Implementation of hook_scald_fetch().
tom@2 428 */
tom@2 429 function mee_scald_fetch(&$atom) {
tom@2 430 list($nid, $delta) = split(':', $atom->base_id);
tom@2 431 $node = node_load($nid);
tom@2 432 $atom->title = $node->title . '(' . $delta . ')';
tom@2 433 $atom->description = $atom->title; // @@@TODO: Maybe make this a better description?
tom@2 434 $atom->thumbnail_source = drupal_get_path('module', 'scald_composites') . '/assets/thumbnail_composite.png';
tom@2 435 } // end mee_scald_fetch()
tom@2 436
tom@2 437
tom@2 438
tom@2 439 /**
tom@2 440 * Implementation of hook_scald_prerender().
tom@2 441 */
tom@2 442 function mee_scald_prerender(&$atom, $mode) {
tom@2 443
tom@2 444 } // end mee_scald_prerender()
tom@2 445