link.module 2.75 KB
Newer Older
1 2 3 4 5 6 7
<?php

/**
 * @file
 * Defines simple link field types.
 */

8 9
use Drupal\Core\Entity\EntityInterface;

10 11 12 13 14 15 16 17
/**
 * Implements hook_help().
 */
function link_help($path, $arg) {
  switch ($path) {
    case 'admin/help#link':
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
18
      $output .= '<p>' . t('The Link module defines a simple link field type for the Field module. Links are external URLs, can have an optional link text for each link, and they can be formatted when displayed. See the <a href="@field-help">Field module help page</a> for more information about fields.', array('@field-help' => url('admin/help/field'))) . '</p>';
19 20 21 22 23 24 25 26 27 28
      return $output;
  }
}

/**
 * Implements hook_field_info().
 */
function link_field_info() {
  $types['link'] = array(
    'label' => t('Link'),
29
    'description' => t('Stores a URL string, optional varchar link text, and optional blob of attributes to assemble a link.'),
30 31 32 33 34
    'instance_settings' => array(
      'title' => DRUPAL_OPTIONAL,
    ),
    'default_widget' => 'link_default',
    'default_formatter' => 'link',
35
    'class' => '\Drupal\link\Type\LinkItem',
36 37 38 39 40 41 42 43 44 45
  );
  return $types;
}

/**
 * Implements hook_field_instance_settings_form().
 */
function link_field_instance_settings_form($field, $instance) {
  $form['title'] = array(
    '#type' => 'radios',
46
    '#title' => t('Allow link text'),
47 48 49 50 51 52 53 54 55 56 57 58 59
    '#default_value' => isset($instance['settings']['title']) ? $instance['settings']['title'] : DRUPAL_OPTIONAL,
    '#options' => array(
      DRUPAL_DISABLED => t('Disabled'),
      DRUPAL_OPTIONAL => t('Optional'),
      DRUPAL_REQUIRED => t('Required'),
    ),
  );
  return $form;
}

/**
 * Implements hook_field_is_empty().
 */
60
function link_field_is_empty($item, $field_type) {
61 62 63 64 65 66
  return !isset($item['url']) || $item['url'] === '';
}

/**
 * Implements hook_field_presave().
 */
67
function link_field_presave(EntityInterface $entity, $field, $instance, $langcode, &$items) {
68
  foreach ($items as $delta => &$item) {
69
    // Trim any spaces around the URL and link text.
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86
    $item['url'] = trim($item['url']);
    $item['title'] = trim($item['title']);
  }
}

/**
 * Implements hook_theme().
 */
function link_theme() {
  return array(
    'link_formatter_link_separate' => array(
      'variables' => array('title' => NULL, 'url_title' => NULL, 'href' => NULL, 'options' => array()),
    ),
  );
}

/**
87
 * Formats a link as separate link title and URL elements.
88 89 90 91 92 93 94 95 96 97 98
 */
function theme_link_formatter_link_separate($vars) {
  $output = '';
  $output .= '<div class="link-item">';
  if (!empty($vars['title'])) {
    $output .= '<div class="link-title">' . check_plain($vars['title']) . '</div>';
  }
  $output .= '<div class="link-url">' . l($vars['url_title'], $vars['href'], $vars['options']) . '</div>';
  $output .= '</div>';
  return $output;
}