footer.php 3.08 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.

/**
 * Contains class block_rss_client\output\footer
 *
 * @package   block_rss_client
 * @copyright 2015 Howard County Public School System
 * @author    Brendan Anderson <brendan_anderson@hcpss.org>
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

namespace block_rss_client\output;

defined('MOODLE_INTERNAL') || die();

/**
 * Class to help display an RSS Block footer
 *
 * @package   block_rss_client
 * @copyright 2015 Howard County Public School System
 * @author    Brendan Anderson <brendan_anderson@hcpss.org>
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
class footer implements \renderable, \templatable {

    /**
     * The link provided in the RSS channel
     *
43
     * @var \moodle_url|null
44
45
46
     */
    protected $channelurl;

47
48
49
50
51
52
53
    /**
     * Link to manage feeds, only provided if a feed has failed.
     *
     * @var \moodle_url|null
     */
    protected $manageurl = null;

54
55
56
    /**
     * Constructor
     *
57
     * @param \moodle_url $channelurl (optional) The link provided in the RSS channel
58
     */
59
    public function __construct($channelurl = null) {
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
        $this->channelurl = $channelurl;
    }

    /**
     * Set the channel url
     *
     * @param \moodle_url $channelurl
     * @return \block_rss_client\output\footer
     */
    public function set_channelurl(\moodle_url $channelurl) {
        $this->channelurl = $channelurl;

        return $this;
    }

75
76
77
78
79
80
81
82
83
84
    /**
     * Record the fact that there is at least one failed feed (and the URL for viewing
     * these failed feeds).
     *
     * @param \moodle_url $manageurl the URL to link to for more information
     */
    public function set_failed(\moodle_url $manageurl) {
        $this->manageurl = $manageurl;
    }

85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
    /**
     * Get the channel url
     *
     * @return \moodle_url
     */
    public function get_channelurl() {
        return $this->channelurl;
    }

    /**
     * Export context for use in mustache templates
     *
     * @see templatable::export_for_template()
     * @param renderer_base $output
     * @return stdClass
     */
    public function export_for_template(\renderer_base $output) {
        $data = new \stdClass();
        $data->channellink = clean_param($this->channelurl, PARAM_URL);
104
105
106
107
        if ($this->manageurl) {
            $data->hasfailedfeeds = true;
            $data->manageurl = clean_param($this->manageurl, PARAM_URL);
        }
108
109
110
111

        return $data;
    }
}