linkit.field.inc in Linkit 7.3

Same filename and directory in other branches

7.2 linkit.field.inc

Implementation for Fields and Linkit.

Linkit can be added to any eligible element. Add a #linkit array to the field, with the following key/value pairs:

"profile": A Linkit field profile.
"enable": (optional) TRUE or FALSE.
"button_text": (optional) The text on the button.
"js_settings": (only used internal).

$form['my_field'] = array(
  '#type' => 'textfield',
  '#linkit' => array(
    'profile' => 'my_profile',
    'enable' => TRUE,
    'button_text' => t('Search'),
  ),
);

File

linkit.field.inc

View source

<?php

/**
 * @file
 * Implementation for Fields and Linkit.
 *
 * Linkit can be added to any eligible element.
 * Add a #linkit array to the field, with the following key/value pairs:
 * - "profile": A Linkit field profile.
 * - "enable": (optional) TRUE or FALSE.
 * - "button_text": (optional) The text on the button.
 * - "js_settings": (only used internal).
 *
 * @code
 * $form['my_field'] = array(
 *   '#type' => 'textfield',
 *   '#linkit' => array(
 *    'profile' => 'my_profile',
 *    'enable' => TRUE,
 *    'button_text' => t('Search'),
 *   ),
 * );
 * @endcode
 */

/**
 * Implements hook_linkit_allowed_field_types().
 */
function linkit_linkit_allowed_field_types() {
  $allowed_field_types = array(
    'text',
    'text_long',
    'text_with_summary',
    'link_field',
  );
  return $allowed_field_types;
}

/**
 * Get all allowed filed types.
 * @return
 *   An array of allowed filed types.
 */
function linkit_get_allowed_field_types() {

  // Get allowed field and widget types.
  $allowed_field_types = module_invoke_all('linkit_allowed_field_types');
  drupal_alter('linkit_allowed_field_types', $allowed_field_types);
  return $allowed_field_types;
}

/**
 * Implements hook_linkit_allowed_elements().
 */
function linkit_linkit_allowed_field_elements() {
  $allowed_elements = array(
    'textfield',
    'textarea',
    'textarea_with_summary',
    'link_field',
  );
  return $allowed_elements;
}

/**
 * Get all allowed filed elements.
 * @return
 *   An array of allowed filed elements.
 */
function linkit_get_allowed_field_elements() {

  // Get allowed field and widget types.
  $allowed_field_elements = module_invoke_all('linkit_allowed_field_elements');
  drupal_alter('linkit_allowed_field_elements', $allowed_field_elements);
  return $allowed_field_elements;
}

/**
 * Implements hook_linkit_allowed_field_widget_types().
 */
function linkit_linkit_allowed_field_widget_types() {
  $allowed_field_widget_types = array(
    'text_textfield',
    'text_textarea',
    'text_textarea_with_summary',
    'link_field',
  );
  return $allowed_field_widget_types;
}

/**
 * Get all allowed filed widget types.
 * @return
 *   An array of allowed filed widget types.
 */
function linkit_get_allowed_field_widget_types() {

  // Get allowed field and widget types.
  $allowed_field_widget_types = module_invoke_all('linkit_allowed_field_widget_types');
  drupal_alter('linkit_allowed_field_widget_types', $allowed_field_widget_types);
  return $allowed_field_widget_types;
}

/**
 * Implements hook_form_FIELD_UI_FIELD_EDIT_FORM_alter().
 */
function linkit_form_field_ui_field_edit_form_alter(&$form, &$form_state) {
  $instance = $form['#instance'];
  if (isset($form['locked']) && $form['locked']) {
    return;
  }

  // Get allowed field types.
  $allowed_field_types = linkit_get_allowed_field_types();

  // Get allowed field widget types.
  $allowed_field_widget_types = linkit_get_allowed_field_widget_types();
  $allowed_field = in_array($form['#field']['type'], $allowed_field_types);
  $allowed_widget = in_array($form['instance']['widget']['type']['#value'], $allowed_field_widget_types);

  // Add the linkit settings to the field instance form if it's valid.
  if ($allowed_field && $allowed_widget) {

    // Fieldset for Linkit settings on this field instance.
    $form['instance']['settings']['linkit'] = array(
      '#type' => 'fieldset',
      '#title' => t('Linkit field settings'),
      '#collapsible' => FALSE,
      '#collapsed' => FALSE,
    );

    // Enable Linkit on this field instance.
    $form['instance']['settings']['linkit']['enable'] = array(
      '#type' => 'checkbox',
      '#title' => t('Enable Linkit for this field.'),
      '#default_value' => isset($instance['settings']['linkit']['enable']) ? $instance['settings']['linkit']['enable'] : 0,
      '#description' => t('Do not use this for CKeditor and TinyMCE fields. You will have to configure this on the wysiwyg/ckeditor profile.'),
    );
    $profiles = linkit_profile_field_load_all();
    $options = array();
    foreach ($profiles as $profile) {
      $options[$profile->name] = $profile->admin_title;
    }

    // Sort the options.
    natsort($options);
    $form['instance']['settings']['linkit']['profile'] = array(
      '#type' => 'select',
      '#title' => t('Profile'),
      '#options' => $options,
      '#empty_option' => t('- Select a profile -'),
      '#default_value' => isset($instance['settings']['linkit']['profile']) ? $instance['settings']['linkit']['profile'] : '',
      '#states' => array(
        'invisible' => array(
          'input[name="instance[settings][linkit][enable]"]' => array(
            'checked' => FALSE,
          ),
        ),
        'required' => array(
          'input[name="instance[settings][linkit][enable]"]' => array(
            'checked' => TRUE,
          ),
        ),
      ),
      '#element_validate' => array(
        'linkit_field_profile_validate',
      ),
    );

    // Enable Linkit on this field instance.
    $form['instance']['settings']['linkit']['button_text'] = array(
      '#type' => 'textfield',
      '#title' => t('Button text that activates linkit modal.'),
      '#default_value' => isset($instance['settings']['linkit']['button_text']) ? $instance['settings']['linkit']['button_text'] : t('Search'),
    );
  }
}

/**
 * Validation callback; Only validate the profile field if linkit is enabled on
 * the instance.
 *
 * @see linkit_form_field_ui_field_edit_form_alter()
 */
function linkit_field_profile_validate($element, &$form_state, $form) {
  if (isset($form_state['values']['instance']['settings']['linkit']['enable']) && $form_state['values']['instance']['settings']['linkit']['enable']) {
    if (empty($element['#value'])) {
      form_error($element, t('You must select an profile.'));
    }
  }
}

/**
 * After build callback.
 *
 * @param array $element
 *   Form API element.
 * @param array $form_state
 *   State of form the element belongs to.
 *
 * @return array
 *   Form API element with attached Linkit functionality.
 */
function linkit_field_element_after_build(array $element, array &$form_state) {

  // Default settings.
  $settings = array(
    'profile' => NULL,
    'enable' => TRUE,
    'button_text' => t('Search'),
    'js_settings' => array(),
  );

  // For Field API elements, merge settings from field instance.
  if (isset($element['#entity_type'])) {
    $instance = field_info_instance($element['#entity_type'], $element['#field_name'], $element['#bundle']);
    if (isset($instance['settings']['linkit'])) {
      $settings = array_merge($settings, $instance['settings']['linkit']);
    }

    // Special treatment for link fields.
    if ($element['#type'] == 'link_field') {
      $settings['js_settings']['source'] = $element['url']['#id'];

      // @see link_field_info()
      // @see link_field_instance_settings_form()
      //
      // Link fields have a title field, but value could
      // be changed only for those options.
      if (in_array($instance['settings']['title'], array(
        'optional',
        'required',
      ))) {
        $settings['js_settings']['titleField'] = $element['title']['#id'];
      }
    }
  }

  // Allow dynamically adding to any eligible element type.
  if (!empty($element['#linkit'])) {
    $settings = array_merge($settings, $element['#linkit']);
  }

  // If profile is empty or disabled, skip the rest.
  if (empty($settings['profile']) || empty($settings['enable'])) {
    return $element;
  }

  // Load the profile.

  /* @var \LinkitProfile $profile */
  $profile = linkit_profile_load($settings['profile']);
  if (!$profile || !isset($profile->data['insert_plugin']['plugin'])) {
    return $element;
  }

  // Load the insert plugin for the profile.
  $insert_plugin = linkit_insert_plugin_load($profile->data['insert_plugin']['plugin']);
  $js_settings = $settings['js_settings'] + array(
    'helper' => 'field',
    'source' => $element['#id'],
    'profile' => $profile->name,
    'insertPlugin' => $profile->data['insert_plugin']['plugin'],
  );

  // Add Linkit dialog button to the element suffix.
  $element['#field_suffix'] = l($settings['button_text'], '', array(
    'attributes' => array(
      'class' => array(
        "button",
        "linkit-field-button",
        "linkit-field-{$js_settings['source']}",
      ),
    ),
  ));

  // Attach js files and settings Linkit needs.
  $element['#attached']['library'][] = array(
    'linkit',
    'base',
  );
  $element['#attached']['library'][] = array(
    'linkit',
    'field',
  );
  $element['#attached']['js'][] = $insert_plugin['javascript'];
  $element['#attached']['js'][] = array(
    'type' => 'setting',
    'data' => array(
      'linkit' => array(
        'fields' => array(
          $element['#id'] => $js_settings,
        ),
      ),
    ),
  );
  return $element;
}

Functions

Name	Description
linkit_field_element_after_build	After build callback.
linkit_field_profile_validate	Validation callback; Only validate the profile field if linkit is enabled on the instance.
linkit_form_field_ui_field_edit_form_alter	Implements hook_form_FIELD_UI_FIELD_EDIT_FORM_alter().
linkit_get_allowed_field_elements	Get all allowed filed elements.
linkit_get_allowed_field_types	Get all allowed filed types.
linkit_get_allowed_field_widget_types	Get all allowed filed widget types.
linkit_linkit_allowed_field_elements	Implements hook_linkit_allowed_elements().
linkit_linkit_allowed_field_types	Implements hook_linkit_allowed_field_types().
linkit_linkit_allowed_field_widget_types	Implements hook_linkit_allowed_field_widget_types().

You are here

linkit.field.inc in Linkit 7.3

File

Functions

API Navigation