Merge branch 'MDL-62899-search-icons-master' of https://github.com/dmitriim/moodle
[moodle.git] / search / classes / document_icon.php
CommitLineData
66f145ef
DM
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 * Document icon class.
19 *
20 * @package core_search
21 * @copyright 2018 Dmitrii Metelkin <dmitriim@catalyst-au.net>
22 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23 */
24
25namespace core_search;
26
27defined('MOODLE_INTERNAL') || die();
28
29/**
30 * Represents a document icon.
31 *
32 * @package core_search
33 * @copyright 2018 Dmitrii Metelkin <dmitriim@catalyst-au.net>
34 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
35 */
36class document_icon {
37 /**
38 * Icon file name.
39 * @var string
40 */
41 protected $name;
42
43 /** Icon file component.
44 * @var string
45 */
46 protected $component;
47
48 /**
49 * Constructor.
50 *
51 * @param string $name Icon name.
52 * @param string $component Icon component.
53 */
54 public function __construct($name, $component = 'moodle') {
55 $this->name = $name;
56 $this->component = $component;
57 }
58
59 /**
60 * Returns name of the icon file.
61 *
62 * @return string
63 */
64 public function get_name() {
65 return $this->name;
66 }
67
68 /**
69 * Returns the component of the icon file.
70 *
71 * @return string
72 */
73 public function get_component() {
74 return $this->component;
75 }
76
77}