Proyectos de Subversion Moodle

Rev

| Ultima modificación | Ver Log |

Rev Autor Línea Nro. Línea
1 efrain 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
 * Transforms data to moodle_url.
19
 *
20
 * @package    block_dash
21
 * @copyright  2019 bdecent gmbh <https://bdecent.de>
22
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23
 */
24
 
25
namespace block_dash\local\data_grid\field\attribute;
26
 
27
use moodle_url;
28
 
29
/**
30
 * Transforms data to moodle_url.
31
 *
32
 * @package block_dash
33
 */
34
class moodle_url_attribute extends abstract_field_attribute {
35
 
36
    /**
37
     * After records are relieved from database each field has a chance to transform the data.
38
     * Example: Convert unix timestamp into a human readable date format
39
     *
40
     * @param mixed $data Raw data associated with this field definition.
41
     * @param \stdClass $record Full record from database.
42
     * @return mixed
43
     * @throws \coding_exception
44
     */
45
    public function transform_data($data, \stdClass $record) {
46
        $url = null;
47
        if ($this->get_option('url') instanceof \moodle_url && $url = $this->get_option('url')) {
48
            /** @var \moodle_url $url */
49
            $url = clone $url;
50
            foreach ($url->params() as $key => $value) {
51
                if (isset($record->$value)) {
52
                    $url->param($key, $record->$value);
53
                } else {
54
                    $url->param($key, $data);
55
                }
56
            }
57
        }
58
 
59
        return $url;
60
    }
61
 
62
    /**
63
     * Need custom value for transform data, which table uses the attribute dynamically.
64
     *
65
     * @return bool
66
     */
67
    public function is_needs_construct_data() {
68
        return true;
69
    }
70
 
71
    /**
72
     * Set the options before transform the data. this will usefull for dynamic field setup.
73
     *
74
     * @param string $field
75
     * @param string $customvalue
76
     * @return void
77
     */
78
    public function set_transform_field($field, $customvalue=null) {
79
        if ($customvalue !== null) {
80
            $this->set_option('url', new moodle_url($customvalue));
81
        }
82
    }
83
}