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 that will convert a timestamp to a date string.
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
26namespace core\output;
27
28defined('MOODLE_INTERNAL') || die();
29
30use Mustache_LambdaHelper;
31
32/**
33 * Mustache helper that will convert a timestamp to a date string.
34 *
35 * @copyright  2017 Ryan Wyllie <ryan@moodle.com>
36 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
37 */
38class mustache_user_date_helper {
39
40    /**
41     * Read a timestamp and format from the string.
42     *
43     * {{#userdate}}1487655635, %Y %m %d{{/userdate}}
44     *
45     * There is a list of formats in lang/en/langconfig.php that can be used as the date format.
46     *
47     * Both args are required. The timestamp must come first.
48     *
49     * @param string $args The text to parse for arguments.
50     * @param Mustache_LambdaHelper $helper Used to render nested mustache variables.
51     * @return string
52     */
53    public function transform($args, Mustache_LambdaHelper $helper) {
54        // Split the text into an array of variables.
55        list($timestamp, $format) = explode(',', $args, 2);
56        $timestamp = trim($timestamp);
57        $format = trim($format);
58
59        $timestamp = $helper->render($timestamp);
60        $format = $helper->render($format);
61
62        return userdate($timestamp, $format);
63    }
64}
65