First commit

Author: husseinalhammad

FontAwesomeSVG.php

@@ -0,0 +1,137 @@
+<?php
+
+class FontAwesomeSVG {
+
+    public $svg_dir;
+
+    public function __construct($svg_dir) {
+        $this->svg_dir = $svg_dir;
+    }
+
+
+
+
+    /**
+     * 
+     */
+    public function get_svg($id, $opts=false) {
+        try {
+            $icon = $this->get_icon_details($id);
+        } catch(Exception $e) {
+            return false;
+        }
+
+        $doc = new DOMDocument();
+        $doc->load($icon['filepath']);
+
+        $default_opts = [
+            'title' => false,
+            'class' => false,
+            'default_class' => true,
+            'role' => 'img',
+        ];
+
+        if (is_array($opts)) {
+            $opts = array_merge($default_opts, $opts);
+        } else {
+            $opts = $default_opts;
+        }
+
+
+
+        $classes = '';
+        if($opts['default_class']) {
+            $classes .= 'svg-inline--fa';
+        }
+        if($opts['class']) {
+            $classes .= ' ' . $opts['class'];
+        }
+
+
+        foreach ($doc->getElementsByTagName('svg') as $item) {
+            if($classes != '') $item->setAttribute('class', $classes);
+            if($opts['role']) $item->setAttribute('role', $opts['role']);
+            
+
+            if($opts['title']) {
+                $title = $doc->createElement("title");
+                $title->nodeValue = $opts['title'];
+
+                // TODO: add aria-labelledby
+                //$title->setAttribute('id', '');
+                //$item->setAttribute('aria-labelledby', '');
+
+                $item->appendChild($title);
+            } else {
+                $item->setAttribute('aria-hidden', 'true');
+            }
+        }
+        
+        return $doc->saveHTML();
+    }
+
+
+
+
+    /**
+     * 
+     */
+    public function get_icon_details($id) {
+        $icon = array();
+
+        $id = explode(' ', $id);
+        $dir = $this->get_icon_dir($id[0]);
+        $filename = $this->get_icon_filename($id[1]);
+
+        $icon['dir'] = $dir;
+        $icon['filename'] = $filename;
+        $icon['filepath'] = str_replace('/', DIRECTORY_SEPARATOR, "$this->svg_dir/$dir/$filename.svg");
+
+        if(!is_file($icon['filepath'])) {
+            throw new Exception('File ' . $icon['filepath'] . ' does not exist.');
+        }
+
+        return $icon;
+    }
+
+
+
+
+    /**
+     * 
+     */
+    public function get_icon_dir($iconID) {
+        switch($iconID) {
+            case 'fas':
+                $dir = 'solid';
+                break;
+
+            case 'far':
+                $dir = 'regular';
+                break;
+
+            case 'fal':
+                $dir = 'light';
+                break;
+
+            case 'fab':
+                $dir = 'brands';
+                break;
+
+            default:
+                $dir = 'solid';
+        }
+
+        return $dir;
+    }
+
+
+
+
+    /**
+     * 
+     */
+    public function get_icon_filename($icon_name) {
+        return str_replace('fa-', '', $icon_name);
+    }
+}

readme.md

@@ -0,0 +1,46 @@
+# Font Awesome SVG - PHP
+
+A PHP class that can be used to add [Font Awesome 5+](https://fontawesome.com/)'s SVG icons inline without Javascript.
+
+
+## Usage
+
+### Files
+
+* Download Font Awesome (Free or Pro)
+* Get the folder `advanced-options/raw-svg` and place it in your project
+* Add `svg-with-js/css/fa-svg-with-js` to your document (or write your own CSS)
+
+### Basic examples
+
+```
+// $dir = directory where SVG files are
+$FA = new FontAwesomeSVG($dir);
+
+echo $FA->get_svg('fas fa-file');
+```
+
+Add custom classes:
+
+```
+echo $FA->get_svg('fas fa-file', ['class' => 'my-custom-class another-class']);
+```
+
+Remove default class `.svg-inline--fa`:
+
+```
+echo $FA->get_svg('fas fa-file', ['default_class' => false]);
+```
+
+Add `<title></title>`:
+
+```
+echo $FA->get_svg('fas fa-file', ['title' => 'My accessible icon']);
+```
+
+
+
+## Accessibility
+
+* `role="img"` is added to the SVG tag by default
+* `aria-hidden="true"` is added to the SVG tag by default unless a `<title>` is set