' . t("The Text module defines various text field types for the Field module. A text field may contain plain text only, or optionally, may use Drupal's text filters to securely manage HTML output. Text input fields may be either a single line (text field), multiple lines (text area), or for greater input control, a select box, checkbox, or radio buttons. If desired, the field can be validated, so that it is limited to a set of allowed values. See the Field module help page for more information about fields.", array('@field-help' => url('admin/help/field'), '@filter-help' => url('admin/help/filter'))) . '
'; return $output; } } /** * Implements hook_field_info(). * * Field settings: * - max_length: The maximum length for a varchar field. * Instance settings: * - text_processing: Whether text input filters should be used. * - display_summary: Whether the summary field should be displayed. When * empty and not displayed the summary will take its value from the trimmed * value of the main text field. */ function text_field_info() { return array( 'text' => array( 'label' => t('Text'), 'description' => t('This field stores varchar text in the database.'), 'settings' => array('max_length' => 255), 'instance_settings' => array('text_processing' => 0), 'default_widget' => 'text_textfield', 'default_formatter' => 'text_default', 'field item class' => '\Drupal\text\Type\TextItem', ), 'text_long' => array( 'label' => t('Long text'), 'description' => t('This field stores long text in the database.'), 'instance_settings' => array('text_processing' => 0), 'default_widget' => 'text_textarea', 'default_formatter' => 'text_default', 'field item class' => '\Drupal\text\Type\TextItem', ), 'text_with_summary' => array( 'label' => t('Long text and summary'), 'description' => t('This field stores long text in the database along with optional summary text.'), 'instance_settings' => array('text_processing' => 1, 'display_summary' => 0), 'default_widget' => 'text_textarea_with_summary', 'default_formatter' => 'text_default', 'field item class' => '\Drupal\text\Type\TextSummaryItem', ), ); } /** * Implements hook_field_settings_form(). */ function text_field_settings_form($field, $instance, $has_data) { $settings = $field['settings']; $form = array(); if ($field['type'] == 'text') { $form['max_length'] = array( '#type' => 'number', '#title' => t('Maximum length'), '#default_value' => $settings['max_length'], '#required' => TRUE, '#description' => t('The maximum length of the field in characters.'), '#min' => 1, // @todo: If $has_data, add a validate handler that only allows // max_length to increase. '#disabled' => $has_data, ); } return $form; } /** * Implements hook_field_instance_settings_form(). */ function text_field_instance_settings_form($field, $instance) { $settings = $instance['settings']; $form['text_processing'] = array( '#type' => 'radios', '#title' => t('Text processing'), '#default_value' => $settings['text_processing'], '#options' => array( t('Plain text'), t('Filtered text (user selects text format)'), ), ); if ($field['type'] == 'text_with_summary') { $form['display_summary'] = array( '#type' => 'checkbox', '#title' => t('Summary input'), '#default_value' => $settings['display_summary'], '#description' => t('This allows authors to input an explicit summary, to be displayed instead of the automatically trimmed text when using the "Summary or trimmed" display type.'), ); } return $form; } /** * Implements hook_field_validate(). * * Possible error codes: * - text_value_max_length: The value exceeds the maximum length. * - text_summary_max_length: The summary exceeds the maximum length. */ function text_field_validate(EntityInterface $entity = NULL, $field, $instance, $langcode, $items, &$errors) { foreach ($items as $delta => $item) { // @todo Length is counted separately for summary and value, so the maximum // length can be exceeded very easily. foreach (array('value', 'summary') as $column) { if (!empty($item[$column])) { if (!empty($field['settings']['max_length']) && drupal_strlen($item[$column]) > $field['settings']['max_length']) { switch ($column) { case 'value': $message = t('%name: the text may not be longer than %max characters.', array('%name' => $instance['label'], '%max' => $field['settings']['max_length'])); break; case 'summary': $message = t('%name: the summary may not be longer than %max characters.', array('%name' => $instance['label'], '%max' => $field['settings']['max_length'])); break; } $errors[$field['field_name']][$langcode][$delta][] = array( 'error' => "text_{$column}_length", 'message' => $message, ); } } } } } /** * Implements hook_field_load(). * * Where possible, the function generates the sanitized version of each field * early so that it is cached in the field cache. This avoids the need to look * up the field in the filter cache separately. */ function text_field_load($entity_type, $entities, $field, $instances, $langcode, &$items) { foreach ($entities as $id => $entity) { foreach ($items[$id] as $delta => $item) { // Only process items with a cacheable format, the rest will be handled // by formatters if needed. if (empty($instances[$id]['settings']['text_processing']) || filter_format_allowcache($item['format'])) { $items[$id][$delta]['safe_value'] = isset($item['value']) ? _text_sanitize($instances[$id], $langcode, $item, 'value') : ''; if ($field['type'] == 'text_with_summary') { $items[$id][$delta]['safe_summary'] = isset($item['summary']) ? _text_sanitize($instances[$id], $langcode, $item, 'summary') : ''; } } } } } /** * Implements hook_field_is_empty(). */ function text_field_is_empty($item, $field) { if (!isset($item['value']) || $item['value'] === '') { return !isset($item['summary']) || $item['summary'] === ''; } return FALSE; } /** * Sanitizes the 'value' or 'summary' data of a text value. * * Depending on whether the field instance uses text processing, data is run * through check_plain() or check_markup(). * * @param $instance * The instance definition. * @param $langcode * The language associated with $item. * @param $item * The field value to sanitize. * @param $column * The column to sanitize (either 'value' or 'summary'). * * @return * The sanitized string. */ function _text_sanitize($instance, $langcode, $item, $column) { // If the value uses a cacheable text format, text_field_load() precomputes // the sanitized string. if (isset($item["safe_$column"])) { return $item["safe_$column"]; } if ($instance['settings']['text_processing']) { return check_markup($item[$column], $item['format'], $langcode); } // Escape all HTML and retain newlines. // @see \Drupal\text\Plugin\field\formatter\TextPlainFormatter return nl2br(check_plain($item[$column])); } /** * Generates a trimmed, formatted version of a text field value. * * If the end of the summary is not indicated using the delimiter * then we generate the summary automatically, trying to end it at a sensible * place such as the end of a paragraph, a line break, or the end of a sentence * (in that order of preference). * * @param $text * The content for which a summary will be generated. * @param $format * The format of the content. If the PHP filter is present and $text contains * PHP code, we do not split it up to prevent parse errors. If the line break * filter is present then we treat newlines embedded in $text as line breaks. * If the htmlcorrector filter is present, it will be run on the generated * summary (if different from the incoming $text). * @param $size * The desired character length of the summary. If omitted, the default value * will be used. Ignored if the special delimiter is present in $text. * * @return * The generated summary. */ function text_summary($text, $format = NULL, $size = NULL) { if (!isset($size)) { $size = config('text.settings')->get('default_summary_length'); } // Find where the delimiter is in the body $delimiter = strpos($text, ''); // If the size is zero, and there is no delimiter, the entire body is the summary. if ($size == 0 && $delimiter === FALSE) { return $text; } // If a valid delimiter has been specified, use it to chop off the summary. if ($delimiter !== FALSE) { return substr($text, 0, $delimiter); } // We check for the presence of the PHP evaluator filter in the current // format. If the body contains PHP code, we do not split it up to prevent // parse errors. if (isset($format)) { $filters = filter_list_format($format); if (isset($filters['php_code']) && $filters['php_code']->status && strpos($text, '' => 0); // If no complete paragraph then treat line breaks as paragraphs. $line_breaks = array('