text.module 8.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160
  1. <?php
  2. /**
  3. * @file
  4. * Defines simple text field types.
  5. */
  6. use Drupal\Component\Utility\Html;
  7. use Drupal\Component\Utility\Unicode;
  8. use Drupal\Core\Routing\RouteMatchInterface;
  9. use Drupal\filter\Entity\FilterFormat;
  10. /**
  11. * Implements hook_help().
  12. */
  13. function text_help($route_name, RouteMatchInterface $route_match) {
  14. switch ($route_name) {
  15. case 'help.page.text':
  16. $output = '';
  17. $output .= '<h3>' . t('About') . '</h3>';
  18. $output .= '<p>' . t('The Text module allows you to create short and long text fields with optional summaries. See the <a href=":field">Field module help</a> and the <a href=":field_ui">Field UI help</a> pages for general information on fields and how to create and manage them. For more information, see the <a href=":text_documentation">online documentation for the Text module</a>.', [':field' => \Drupal::url('help.page', ['name' => 'field']), ':field_ui' => (\Drupal::moduleHandler()->moduleExists('field_ui')) ? \Drupal::url('help.page', ['name' => 'field_ui']) : '#', ':text_documentation' => 'https://www.drupal.org/documentation/modules/text']) . '</p>';
  19. $output .= '<h3>' . t('Uses') . '</h3>';
  20. $output .= '<dl>';
  21. $output .= '<dt>' . t('Managing and displaying text fields') . '</dt>';
  22. $output .= '<dd>' . t('The <em>settings</em> and <em>display</em> of the text field can be configured separately. See the <a href=":field_ui">Field UI help</a> for more information on how to manage fields and their display.', [':field_ui' => (\Drupal::moduleHandler()->moduleExists('field_ui')) ? \Drupal::url('help.page', ['name' => 'field_ui']) : '#']) . '</dd>';
  23. $output .= '<dt>' . t('Creating short text fields') . '</dt>';
  24. $output .= '<dd>' . t('If you choose <em>Text (plain)</em> or <em>Text (formatted)</em> as the field type on the <em>Manage fields</em> page, then a field with a single row is displayed. You can change the maximum text length in the <em>Field settings</em> when you set up the field.') . '</dd>';
  25. $output .= '<dt>' . t('Creating long text fields') . '</dt>';
  26. $output .= '<dd>' . t('If you choose <em>Text (plain, long)</em>, <em>Text (formatted, long)</em>, or <em>Text (formatted, long, with summary)</em> on the <em>Manage fields</em> page, then users can insert text of unlimited length. On the <em>Manage form display</em> page, you can set the number of rows that are displayed to users.') . '</dd>';
  27. $output .= '<dt>' . t('Trimming the text length') . '</dt>';
  28. $output .= '<dd>' . t('On the <em>Manage display</em> page you can choose to display a trimmed version of the text, and if so, where to cut off the text.') . '</dd>';
  29. $output .= '<dt>' . t('Displaying summaries instead of trimmed text') . '</dt>';
  30. $output .= '<dd>' . t('As an alternative to using a trimmed version of the text, you can enter a separate summary by choosing the <em>Text (formatted, long, with summary)</em> field type on the <em>Manage fields</em> page. Even when <em>Summary input</em> is enabled, and summaries are provided, you can display <em>trimmed</em> text nonetheless by choosing the appropriate format on the <em>Manage display</em> page.') . '</dd>';
  31. $output .= '<dt>' . t('Using text formats and editors') . '</dt>';
  32. $output .= '<dd>' . t('If you choose <em>Text (plain)</em> or <em>Text (plain, long)</em> you restrict the input to <em>Plain text</em> only. If you choose <em>Text (formatted)</em>, <em>Text (formatted, long)</em>, or <em>Text (formatted, long with summary)</em> you allow users to write formatted text. Which options are available to individual users depends on the settings on the <a href=":formats">Text formats and editors page</a>.', [':formats' => \Drupal::url('filter.admin_overview')]) . '</dd>';
  33. $output .= '</dl>';
  34. return $output;
  35. }
  36. }
  37. /**
  38. * Generates a trimmed, formatted version of a text field value.
  39. *
  40. * If the end of the summary is not indicated using the <!--break--> delimiter
  41. * then we generate the summary automatically, trying to end it at a sensible
  42. * place such as the end of a paragraph, a line break, or the end of a sentence
  43. * (in that order of preference).
  44. *
  45. * @param $text
  46. * The content for which a summary will be generated.
  47. * @param $format
  48. * The format of the content. If the line break filter is present then we
  49. * treat newlines embedded in $text as line breaks. If the htmlcorrector
  50. * filter is present, it will be run on the generated summary (if different
  51. * from the incoming $text).
  52. * @param $size
  53. * The desired character length of the summary. If omitted, the default value
  54. * will be used. Ignored if the special delimiter is present in $text.
  55. *
  56. * @return
  57. * The generated summary.
  58. */
  59. function text_summary($text, $format = NULL, $size = NULL) {
  60. if (!isset($size)) {
  61. $size = \Drupal::config('text.settings')->get('default_summary_length');
  62. }
  63. // Find where the delimiter is in the body
  64. $delimiter = strpos($text, '<!--break-->');
  65. // If the size is zero, and there is no delimiter, the entire body is the summary.
  66. if ($size == 0 && $delimiter === FALSE) {
  67. return $text;
  68. }
  69. // If a valid delimiter has been specified, use it to chop off the summary.
  70. if ($delimiter !== FALSE) {
  71. return substr($text, 0, $delimiter);
  72. }
  73. // Retrieve the filters of the specified text format, if any.
  74. if (isset($format)) {
  75. $filter_format = FilterFormat::load($format);
  76. // If the specified format does not exist, return nothing. $text is already
  77. // filtered text, but the remainder of this function will not be able to
  78. // ensure a sane and secure summary.
  79. if (!$filter_format || !($filters = $filter_format->filters())) {
  80. return '';
  81. }
  82. }
  83. // If we have a short body, the entire body is the summary.
  84. if (Unicode::strlen($text) <= $size) {
  85. return $text;
  86. }
  87. // If the delimiter has not been specified, try to split at paragraph or
  88. // sentence boundaries.
  89. // The summary may not be longer than maximum length specified. Initial slice.
  90. $summary = Unicode::truncate($text, $size);
  91. // Store the actual length of the UTF8 string -- which might not be the same
  92. // as $size.
  93. $max_rpos = strlen($summary);
  94. // How much to cut off the end of the summary so that it doesn't end in the
  95. // middle of a paragraph, sentence, or word.
  96. // Initialize it to maximum in order to find the minimum.
  97. $min_rpos = $max_rpos;
  98. // Store the reverse of the summary. We use strpos on the reversed needle and
  99. // haystack for speed and convenience.
  100. $reversed = strrev($summary);
  101. // Build an array of arrays of break points grouped by preference.
  102. $break_points = [];
  103. // A paragraph near the end of sliced summary is most preferable.
  104. $break_points[] = ['</p>' => 0];
  105. // If no complete paragraph then treat line breaks as paragraphs.
  106. $line_breaks = ['<br />' => 6, '<br>' => 4];
  107. // Newline only indicates a line break if line break converter
  108. // filter is present.
  109. if (isset($format) && $filters->has('filter_autop') && $filters->get('filter_autop')->status) {
  110. $line_breaks["\n"] = 1;
  111. }
  112. $break_points[] = $line_breaks;
  113. // If the first paragraph is too long, split at the end of a sentence.
  114. $break_points[] = ['. ' => 1, '! ' => 1, '? ' => 1, '。' => 0, '؟ ' => 1];
  115. // Iterate over the groups of break points until a break point is found.
  116. foreach ($break_points as $points) {
  117. // Look for each break point, starting at the end of the summary.
  118. foreach ($points as $point => $offset) {
  119. // The summary is already reversed, but the break point isn't.
  120. $rpos = strpos($reversed, strrev($point));
  121. if ($rpos !== FALSE) {
  122. $min_rpos = min($rpos + $offset, $min_rpos);
  123. }
  124. }
  125. // If a break point was found in this group, slice and stop searching.
  126. if ($min_rpos !== $max_rpos) {
  127. // Don't slice with length 0. Length must be <0 to slice from RHS.
  128. $summary = ($min_rpos === 0) ? $summary : substr($summary, 0, 0 - $min_rpos);
  129. break;
  130. }
  131. }
  132. // If the htmlcorrector filter is present, apply it to the generated summary.
  133. if (isset($format) && $filters->has('filter_htmlcorrector') && $filters->get('filter_htmlcorrector')->status) {
  134. $summary = Html::normalize($summary);
  135. }
  136. return $summary;
  137. }