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 namespace core\output;
  18
  19 use Mustache_LambdaHelper;
  20
  21 /**
  22  * This class will call shorten_text with the section content.
  23  *
  24  * @package core
  25  * @copyright  2017 Ryan Wyllie <ryan@moodle.com>
  26  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  27  */
  28 class mustache_shorten_text_helper {
  29     /**
  30      * Read a length and text component from the string.
  31      *
  32      * {{#shortentext}}50,Some test to shorten{{/shortentext}}
  33      *
  34      * Both args are required. The length must come first.
  35      *
  36      * @param string $args The text to parse for arguments.
  37      * @param Mustache_LambdaHelper $helper Used to render nested mustache variables.
  38      * @return string
  39      */
  40     public function shorten($args, Mustache_LambdaHelper $helper) {
  41         // Split the text into an array of variables.
  42         [$length, $text] = explode(',', $args, 2);
  43         $length = trim($length);
  44         $text = trim($text);
  45
  46         // Allow mustache tags in the length and text.
  47         $text = $helper->render($text);
  48         $length = $helper->render($length);
  49
  50         return shorten_text($text, $length);
  51     }
  52 }