lib/classes/output/mustache_shorten_text_helper.php

   1 <?php
   2 // This file is part of Moodle - http://moodle.org/
   3 //
   4 // Moodle is free software: you can redistribute it and/or modify
   5 // it under the terms of the GNU General Public License as published by
   6 // the Free Software Foundation, either version 3 of the License, or
   7 // (at your option) any later version.
   8 //
   9 // Moodle is distributed in the hope that it will be useful,
  10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 // GNU General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU General Public License
  15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16
  17 /**
  18  * Mustache helper shorten text.
  19  *
  20  * @package    core
  21  * @category   output
  22  * @copyright  2017 Ryan Wyllie <ryan@moodle.com>
  23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24  */
  25
  26 namespace core\output;
  27
  28 defined('MOODLE_INTERNAL') || die();
  29
  30 use Mustache_LambdaHelper;
  31 use renderer_base;
  32
  33 /**
  34  * This class will call shorten_text with the section content.
  35  *
  36  * @copyright  2017 Ryan Wyllie <ryan@moodle.com>
  37  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  38  */
  39 class mustache_shorten_text_helper {
  40
  41     /**
  42      * Read a length and text component from the string.
  43      *
  44      * {{#shortentext}}50,Some test to shorten{{/shortentext}}
  45      *
  46      * Both args are required. The length must come first.
  47      *
  48      * @param string $args The text to parse for arguments.
  49      * @param Mustache_LambdaHelper $helper Used to render nested mustache variables.
  50      * @return string
  51      */
  52     public function shorten($args, Mustache_LambdaHelper $helper) {
  53         // Split the text into an array of variables.
  54         list($length, $text) = explode(',', $args, 2);
  55         $length = trim($length);
  56         $text = trim($text);
  57
  58         // Allow mustache tags in the text.
  59         $text = $helper->render($text);
  60
  61         return shorten_text($text, $length);
  62     }
  63 }
  64