Merge branch 'MDL-58356-master' of git://github.com/damyon/moodle
[moodle.git] / lib / classes / output / icon_system_fontawesome.php
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/>.
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  */
26 namespace core\output;
28 use renderer_base;
29 use pix_icon;
31 defined('MOODLE_INTERNAL') || die();
33 /**
34  * Class allowing different systems for mapping and rendering icons.
35  *
36  * Possible icon styles are:
37  *   1. standard - image tags are generated which point to pix icons stored in a plugin pix folder.
38  *   2. fontawesome - font awesome markup is generated with the name of the icon mapped from the moodle icon name.
39  *   3. inline - inline tags are used for svg and png so no separate page requests are made (at the expense of page size).
40  *
41  * @package    core
42  * @category   output
43  * @copyright  2016 Damyon Wiese
44  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
45  */
46 class icon_system_fontawesome extends icon_system_font {
48     /**
49      * @var array $map Cached map of moodle icon names to font awesome icon names.
50      */
51     private $map = [];
53     public function get_core_icon_map() {
54         return [
55             'core:docs' => 'fa-info-circle',
56             'core:help' => 'fa-question-circle text-info',
57             'core:req' => 'fa-exclamation-circle text-danger',
58             'core:a/add_file' => 'fa-file-o',
59             'core:a/create_folder' => 'fa-folder-o',
60             'core:a/download_all' => 'fa-download',
61             'core:a/help' => 'fa-question-circle text-info',
62             'core:a/logout' => 'fa-sign-out',
63             'core:a/refresh' => 'fa-refresh',
64             'core:a/search' => 'fa-search',
65             'core:a/setting' => 'fa-cog',
66             'core:a/view_icon_active' => 'fa-th',
67             'core:a/view_list_active' => 'fa-list',
68             'core:a/view_tree_active' => 'fa-folder',
69             'core:b/bookmark-new' => 'fa-bookmark',
70             'core:b/document-edit' => 'fa-pencil',
71             'core:b/document-new' => 'fa-file-o',
72             'core:b/document-properties' => 'fa-info',
73             'core:b/edit-copy' => 'fa-files-o',
74             'core:b/edit-delete' => 'fa-trash',
75             'core:e/abbr' => 'fa-comment',
76             'core:e/absolute' => 'fa-crosshairs',
77             'core:e/accessibility_checker' => 'fa-universal-access',
78             'core:e/acronym' => 'fa-comment',
79             'core:e/advance_hr' => 'fa-arrows-h',
80             'core:e/align_center' => 'fa-align-center',
81             'core:e/align_left' => 'fa-align-left',
82             'core:e/align_right' => 'fa-align-right',
83             'core:e/anchor' => 'fa-chain',
84             'core:e/backward' => 'fa-undo',
85             'core:e/bold' => 'fa-bold',
86             'core:e/bullet_list' => 'fa-list-ul',
87             'core:e/cell_props' => 'fa-info',
88             'core:e/cite' => 'fa-quote-right',
89             'core:e/cleanup_messy_code' => 'fa-eraser',
90             'core:e/clear_formatting' => 'fa-i-cursor',
91             'core:e/copy' => 'fa-clone',
92             'core:e/cut' => 'fa-scissors',
93             'core:e/decrease_indent' => 'fa-outdent',
94             'core:e/delete_col' => 'fa-minus',
95             'core:e/delete_row' => 'fa-minus',
96             'core:e/delete' => 'fa-minus',
97             'core:e/delete_table' => 'fa-minus',
98             'core:e/document_properties' => 'fa-info',
99             'core:e/emoticons' => 'fa-smile-o',
100             'core:e/find_replace' => 'fa-search-plus',
101             'core:e/forward' => 'fa-arrow-right',
102             'core:e/fullpage' => 'fa-arrows-alt',
103             'core:e/fullscreen' => 'fa-arrows-alt',
104             'core:e/help' => 'fa-question-circle',
105             'core:e/increase_indent' => 'fa-indent',
106             'core:e/insert_col_after' => 'fa-columns',
107             'core:e/insert_col_before' => 'fa-columns',
108             'core:e/insert_date' => 'fa-calendar',
109             'core:e/insert_edit_image' => 'fa-picture-o',
110             'core:e/insert_edit_link' => 'fa-link',
111             'core:e/insert_edit_video' => 'fa-video-camera',
112             'core:e/insert_file' => 'fa-file',
113             'core:e/insert_horizontal_ruler' => 'fa-arrows-h',
114             'core:e/insert_nonbreaking_space' => 'fa-square-o',
115             'core:e/insert_page_break' => 'fa-level-down',
116             'core:e/insert_row_after' => 'fa-plus',
117             'core:e/insert_row_before' => 'fa-plus',
118             'core:e/insert' => 'fa-plus',
119             'core:e/insert_time' => 'fa-clock-o',
120             'core:e/italic' => 'fa-italic',
121             'core:e/justify' => 'fa-align-justify',
122             'core:e/layers_over' => 'fa-level-up',
123             'core:e/layers' => 'fa-window-restore',
124             'core:e/layers_under' => 'fa-level-down',
125             'core:e/left_to_right' => 'fa-chevron-right',
126             'core:e/manage_files' => 'fa-files-o',
127             'core:e/math' => 'fa-calculator',
128             'core:e/merge_cells' => 'fa-compress',
129             'core:e/new_document' => 'fa-file-o',
130             'core:e/numbered_list' => 'fa-list-ol',
131             'core:e/page_break' => 'fa-level-down',
132             'core:e/paste' => 'fa-clipboard',
133             'core:e/paste_text' => 'fa-clipboard',
134             'core:e/paste_word' => 'fa-clipboard',
135             'core:e/prevent_autolink' => 'fa-exclamation',
136             'core:e/preview' => 'fa-search-plus',
137             'core:e/print' => 'fa-print',
138             'core:e/question' => 'fa-question',
139             'core:e/redo' => 'fa-repeat',
140             'core:e/remove_link' => 'fa-chain-broken',
141             'core:e/remove_page_break' => 'fa-remove',
142             'core:e/resize' => 'fa-expand',
143             'core:e/restore_draft' => 'fa-undo',
144             'core:e/restore_last_draft' => 'fa-undo',
145             'core:e/right_to_left' => 'fa-chevron-left',
146             'core:e/row_props' => 'fa-info',
147             'core:e/save' => 'fa-floppy-o',
148             'core:e/screenreader_helper' => 'fa-braille',
149             'core:e/search' => 'fa-search',
150             'core:e/select_all' => 'fa-arrows-h',
151             'core:e/show_invisible_characters' => 'fa-eye-slash',
152             'core:e/source_code' => 'fa-code',
153             'core:e/special_character' => 'fa-pencil-square-o',
154             'core:e/spellcheck' => 'fa-check',
155             'core:e/split_cells' => 'fa-columns',
156             'core:e/strikethrough' => 'fa-strikethrough',
157             'core:e/styleprops' => 'fa-info',
158             'core:e/subscript' => 'fa-subscript',
159             'core:e/superscript' => 'fa-superscript',
160             'core:e/table_props' => 'fa-table',
161             'core:e/table' => 'fa-table',
162             'core:e/template' => 'fa-sticky-note',
163             'core:e/text_color_picker' => 'fa-paint-brush',
164             'core:e/text_color' => 'fa-paint-brush',
165             'core:e/text_highlight_picker' => 'fa-lightbulb-o',
166             'core:e/text_highlight' => 'fa-lightbulb-o',
167             'core:e/tick' => 'fa-check',
168             'core:e/toggle_blockquote' => 'fa-quote-left',
169             'core:e/underline' => 'fa-underline',
170             'core:e/undo' => 'fa-undo',
171             'core:e/visual_aid' => 'fa-universal-access',
172             'core:e/visual_blocks' => 'fa-audio-description',
173             'theme:fp/add_file' => 'fa-file-o',
174             'theme:fp/alias' => 'fa-link',
175             'theme:fp/check' => 'fa-check',
176             'theme:fp/create_folder' => 'fa-folder-o',
177             'theme:fp/cross' => 'fa-remove',
178             'theme:fp/download_all' => 'fa-download',
179             'theme:fp/help' => 'fa-question-circle',
180             'theme:fp/link' => 'fa-link',
181             'theme:fp/link_sm' => 'fa-link',
182             'theme:fp/logout' => 'fa-sign-out',
183             'theme:fp/path_folder' => 'fa-folder',
184             'theme:fp/path_folder_rtl' => 'fa-folder',
185             'theme:fp/refresh' => 'fa-refresh',
186             'theme:fp/search' => 'fa-search',
187             'theme:fp/setting' => 'fa-cog',
188             'theme:fp/view_icon_active' => 'fa-th',
189             'theme:fp/view_list_active' => 'fa-list',
190             'theme:fp/view_tree_active' => 'fa-folder',
191             'core:i/assignroles' => 'fa-user-plus',
192             'core:i/backup' => 'fa-file-zip-o',
193             'core:i/badge' => 'fa-shield',
194             'core:i/calc' => 'fa-calculator',
195             'core:i/calendar' => 'fa-calendar',
196             'core:i/caution' => 'fa-exclamation text-warning',
197             'core:i/checked' => 'fa-check',
198             'core:i/checkpermissions' => 'fa-unlock-alt',
199             'core:i/cohort' => 'fa-users',
200             'core:i/competencies' => 'fa-check-square-o',
201             'core:i/completion_self' => 'fa-user-o',
202             'core:i/lock' => 'fa-lock',
203             'core:i/courseevent' => 'fa-calendar',
204             'core:i/db' => 'fa-database',
205             'core:i/delete' => 'fa-trash',
206             'core:i/down' => 'fa-arrow-down',
207             'core:i/dragdrop' => 'fa-arrows',
208             'core:i/duration' => 'fa-clock-o',
209             'core:i/edit' => 'fa-pencil',
210             'core:i/email' => 'fa-envelope',
211             'core:i/enrolmentsuspended' => 'fa-pause',
212             'core:i/enrolusers' => 'fa-user-plus',
213             'core:i/expired' => 'fa-exclamation text-warning',
214             'core:i/export' => 'fa-download',
215             'core:i/files' => 'fa-file',
216             'core:i/filter' => 'fa-filter',
217             'core:i/flagged' => 'fa-flag',
218             'core:i/folder' => 'fa-folder',
219             'core:i/grade_correct' => 'fa-check text-success',
220             'core:i/grade_incorrect' => 'fa-remove text-danger',
221             'core:i/grade_partiallycorrect' => 'fa-check-square',
222             'core:i/grades' => 'fa-graduation-cap',
223             'core:i/groupevent' => 'fa-group',
224             'core:i/groupn' => 'fa-user',
225             'core:i/group' => 'fa-users',
226             'core:i/groups' => 'fa-user-circle',
227             'core:i/groupv' => 'fa-user-circle-o',
228             'core:i/hide' => 'fa-eye',
229             'core:i/hierarchylock' => 'fa-lock',
230             'core:i/import' => 'fa-level-up',
231             'core:i/info' => 'fa-info',
232             'core:i/invalid' => 'fa-times text-danger',
233             'core:i/item' => 'fa-circle',
234             'core:i/loading' => 'fa-circle-o-notch fa-spin',
235             'core:i/loading_small' => 'fa-circle-o-notch fa-spin',
236             'core:i/lock' => 'fa-lock',
237             'core:i/log' => 'fa-list-alt',
238             'core:i/mahara_host' => 'fa-id-badge',
239             'core:i/manual_item' => 'fa-square-o',
240             'core:i/marked' => 'fa-circle',
241             'core:i/marker' => 'fa-circle-o',
242             'core:i/mean' => 'fa-calculator',
243             'core:i/menu' => 'fa-ellipsis-v',
244             'core:i/mnethost' => 'fa-external-link',
245             'core:i/moodle_host' => 'fa-graduation-cap',
246             'core:i/move_2d' => 'fa-arrows',
247             'core:i/navigationitem' => 'fa-angle-right',
248             'core:i/ne_red_mark' => 'fa-remove',
249             'core:i/new' => 'fa-plus',
250             'core:i/news' => 'fa-newspaper-o',
251             'core:i/nosubcat' => 'fa-plus-square-o',
252             'core:i/notifications' => 'fa-bell',
253             'core:i/open' => 'fa-folder-open',
254             'core:i/outcomes' => 'fa-tasks',
255             'core:i/payment' => 'fa-money',
256             'core:i/permissionlock' => 'fa-lock',
257             'core:i/permissions' => 'fa-pencil-square-o',
258             'core:i/persona_sign_in_black' => 'fa-male',
259             'core:i/portfolio' => 'fa-id-badge',
260             'core:i/preview' => 'fa-search-plus',
261             'core:i/progressbar' => 'fa-spinner fa-spin',
262             'core:i/publish' => 'fa-share',
263             'core:i/questions' => 'fa-question',
264             'core:i/reload' => 'fa-refresh',
265             'core:i/report' => 'fa-area-chart',
266             'core:i/repository' => 'fa-hdd-o',
267             'core:i/restore' => 'fa-level-up',
268             'core:i/return' => 'fa-arrow-left',
269             'core:i/risk_config' => 'fa-exclamation text-muted',
270             'core:i/risk_managetrust' => 'fa-exclamation-triangle text-warning',
271             'core:i/risk_personal' => 'fa-exclamation-circle text-info',
272             'core:i/risk_spam' => 'fa-exclamation text-primary',
273             'core:i/risk_xss' => 'fa-exclamation-triangle text-danger',
274             'core:i/role' => 'fa-user-md',
275             'core:i/rss' => 'fa-rss',
276             'core:i/rsssitelogo' => 'fa-graduation-cap',
277             'core:i/scales' => 'fa-balance-scale',
278             'core:i/scheduled' => 'fa-calendar-check-o',
279             'core:i/search' => 'fa-search',
280             'core:i/settings' => 'fa-cogs',
281             'core:i/show' => 'fa-eye-slash',
282             'core:i/siteevent' => 'fa-share-alt',
283             'core:i/star-rating' => 'fa-star',
284             'core:i/stats' => 'fa-line-chart',
285             'core:i/switch' => 'fa-exchange',
286             'core:i/switchrole' => 'fa-user-secret',
287             'core:i/twoway' => 'fa-arrows-h',
288             'core:i/unchecked' => 'fa-square-o',
289             'core:i/unflagged' => 'fa-flag-o',
290             'core:i/unlock' => 'fa-unlock',
291             'core:i/up' => 'fa-arrow-up',
292             'core:i/userevent' => 'fa-user',
293             'core:i/user' => 'fa-user',
294             'core:i/users' => 'fa-users',
295             'core:i/valid' => 'fa-check text-success',
296             'core:i/warning' => 'fa-exclamation text-warning',
297             'core:i/withsubcat' => 'fa-plus-square',
298             'core:m/USD' => 'fa-usd',
299             'core:t/addcontact' => 'fa-address-card',
300             'core:t/add' => 'fa-plus',
301             'core:t/approve' => 'fa-thumbs-up',
302             'core:t/assignroles' => 'fa-user-circle',
303             'core:t/award' => 'fa-trophy',
304             'core:t/backpack' => 'fa-shopping-bag',
305             'core:t/backup' => 'fa-arrow-circle-down',
306             'core:t/block' => 'fa-ban',
307             'core:t/block_to_dock_rtl' => 'fa-chevron-right',
308             'core:t/block_to_dock' => 'fa-chevron-left',
309             'core:t/calc_off' => 'fa-times fa-cross',
310             'core:t/calc' => 'fa-calculator',
311             'core:t/check' => 'fa-check',
312             'core:t/cohort' => 'fa-users',
313             'core:t/collapsed_empty_rtl' => 'fa-plus-square-o',
314             'core:t/collapsed_empty' => 'fa-plus-square-o',
315             'core:t/collapsed_rtl' => 'fa-plus-square',
316             'core:t/collapsed' => 'fa-plus-square',
317             'core:t/contextmenu' => 'fa-cog',
318             'core:t/copy' => 'fa-copy',
319             'core:t/delete' => 'fa-trash',
320             'core:t/dockclose' => 'fa-window-close',
321             'core:t/dock_to_block_rtl' => 'fa-chevron-right',
322             'core:t/dock_to_block' => 'fa-chevron-left',
323             'core:t/download' => 'fa-download',
324             'core:t/down' => 'fa-arrow-down',
325             'core:t/dropdown' => 'fa-cog',
326             'core:t/editinline' => 'fa-pencil',
327             'core:t/edit_menu' => 'fa-cog',
328             'core:t/editstring' => 'fa-pencil',
329             'core:t/edit' => 'fa-cog',
330             'core:t/emailno' => 'fa-ban',
331             'core:t/email' => 'fa-envelope-o',
332             'core:t/enrolusers' => 'fa-user-plus',
333             'core:t/expanded' => 'fa-caret-down',
334             'core:t/go' => 'fa-play',
335             'core:t/grades' => 'fa-graduation-cap',
336             'core:t/groupn' => 'fa-user',
337             'core:t/groups' => 'fa-user-circle',
338             'core:t/groupv' => 'fa-user-circle-o',
339             'core:t/hide' => 'fa-eye',
340             'core:t/left' => 'fa-arrow-left',
341             'core:t/less' => 'fa-caret-up',
342             'core:t/locked' => 'fa-lock',
343             'core:t/lock' => 'fa-unlock',
344             'core:t/locktime' => 'fa-lock',
345             'core:t/markasread' => 'fa-check',
346             'core:t/messages' => 'fa-comments',
347             'core:t/message' => 'fa-comment',
348             'core:t/more' => 'fa-caret-down',
349             'core:t/move' => 'fa-arrows',
350             'core:t/passwordunmask-edit' => 'fa-pencil',
351             'core:t/passwordunmask-reveal' => 'fa-eye',
352             'core:t/portfolioadd' => 'fa-plus',
353             'core:t/preferences' => 'fa-wrench',
354             'core:t/preview' => 'fa-search-plus',
355             'core:t/print' => 'fa-print',
356             'core:t/removecontact' => 'fa-user-times',
357             'core:t/reset' => 'fa-repeat',
358             'core:t/restore' => 'fa-arrow-circle-up',
359             'core:t/right' => 'fa-arrow-right',
360             'core:t/show' => 'fa-eye-slash',
361             'core:t/sort_asc' => 'fa-sort-asc',
362             'core:t/sort_desc' => 'fa-sort-desc',
363             'core:t/sort' => 'fa-sort',
364             'core:t/stop' => 'fa-stop',
365             'core:t/switch_minus' => 'fa-minus',
366             'core:t/switch_plus' => 'fa-plus',
367             'core:t/switch_whole' => 'fa-square-o',
368             'core:t/unblock' => 'fa-commenting',
369             'core:t/unlocked' => 'fa-unlock-alt',
370             'core:t/unlock' => 'fa-unlock',
371             'core:t/up' => 'fa-arrow-up',
372             'core:t/user' => 'fa-user',
373             'core:t/viewdetails' => 'fa-list',
374         ];
375     }
377     /**
378      * Overridable function to get a mapping of all icons.
379      * Default is to do no mapping.
380      */
381     public function get_icon_name_map() {
382         if ($this->map === []) {
383             $cache = \cache::make('core', 'fontawesomeiconmapping');
385             $this->map = $cache->get('mapping');
387             if (empty($this->map)) {
388                 $this->map = $this->get_core_icon_map();
389                 $callback = 'get_fontawesome_icon_map';
391                 if ($pluginsfunction = get_plugins_with_function($callback)) {
392                     foreach ($pluginsfunction as $plugintype => $plugins) {
393                         foreach ($plugins as $pluginfunction) {
394                             $pluginmap = $pluginfunction();
395                             $this->map += $pluginmap;
396                         }
397                     }
398                 }
399                 $cache->set('mapping', $this->map);
400             }
402         }
403         return $this->map;
404     }
407     public function get_amd_name() {
408         return 'core/icon_system_fontawesome';
409     }
411     public function render_pix_icon(renderer_base $output, pix_icon $icon) {
412         $subtype = 'pix_icon_fontawesome';
413         $subpix = new $subtype($icon);
415         $data = $subpix->export_for_template($output);
417         if (!$subpix->is_mapped()) {
418             $data['unmappedIcon'] = $icon->export_for_template($output);
419         }
420         return $output->render_from_template('core/pix_icon_fontawesome', $data);
421     }