MDL-40759 icons: Refactor to allow theme icon systems
[moodle.git] / lib / classes / output / icon_system_font.php
CommitLineData
95b06c13
DW
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 * Contains class \core\output\icon_system
19 *
20 * @package core
21 * @category output
22 * @copyright 2016 Damyon Wiese
23 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24 */
25
26namespace core\output;
27
95b06c13
DW
28/**
29 * Class allowing different systems for mapping and rendering icons.
30 *
31 * Possible icon styles are:
32 * 1. standard - image tags are generated which point to pix icons stored in a plugin pix folder.
33 * 2. fontawesome - font awesome markup is generated with the name of the icon mapped from the moodle icon name.
34 * 3. inline - inline tags are used for svg and png so no separate page requests are made (at the expense of page size).
35 *
36 * @package core
37 * @category output
38 * @copyright 2016 Damyon Wiese
39 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
40 */
41abstract class icon_system_font extends icon_system {
42
95b06c13
DW
43}
44