Merge pull request #25 from dutchenkoOleg/master

Readme && Laravel troubleshooting

Author: OlehDutchenko

README.md

@@ -9,4 +9,187 @@
 
 <img src="https://raw.githubusercontent.com/dutchenkoOleg/storage/master/img/r2d2/r2d2.gif" alt>
 
-----
+---
+
+### *Table of contents*
+
+- [Install](#install)
+- [Setup](#setup)
+- [API](#api)
+	- [eject](#eject)
+	- [instance::set](#instanceset)
+	- [instance::fileUrl](#instancefileurl)
+	- [instance::fileContent](#instancefilecontent)
+
+---
+
+
+
+# Install
+
+```bash
+composer require wezom-agency/browserizr
+```
+
+---
+
+# Setup
+
+in your core app file:
+
+```php
+use WezomAgency\R2D2;
+
+R2D2::eject()->set('KEY', VALUE);
+
+```
+
+List of settings:
+
+- `debug: bool = false`
+- `host: string = ''`
+- `protocol: string = 'http://'`
+- `rootPath: string = ''`
+- `resourceRelativePath: string = ''` - _"shortcut"_ to your resources/assets directory
+- `svgSpritemapPath: string = ''` - default path to svg sprite map file
+
+
+Example of settings
+
+```php
+use WezomAgency\R2D2;
+
+R2D2::eject()
+    ->set(debug, true)
+    ->set('host', $_SERVER['HTTP_HOST'])
+    ->set('protocol', 'https://')
+    ->set('rootPath', './')
+    ->set('resourceRelativePath', '/my/path/to/resources/')
+    ->set(
+        'svgSpritemapPath',
+        R2D2::eject()->resourceUrl('assets/svg/common.svg', true)
+    );
+```
+
+---
+
+# API
+
+## eject
+
+```php
+R2D2::eject() instance
+```
+
+Ejecting R2D2 instance.
+Below a list of instance methods
+
+
+---
+
+### instance::set
+
+```php
+R2D2::eject()->set($key, $value) instance
+```
+
+_Parameters:_
+
+| Name       | Data type | Default value | Description    |
+| :--------- | :-------- | :------------ | :------------- |
+| **$name**  | _string_  |               | settings name  |
+| **$value** | _any_     |               | settings value |
+
+List of available settings and their values, see above ([#setup section](#setup))
+
+
+
+---
+
+### instance::fileUrl
+
+Generate file url.
+
+```php
+R2D2::eject()->fileUrl($url, $timestamp = false, $absolute = false) string
+```
+
+
+_Parameters:_
+
+| Name           | Data type | Default value | Description    |
+| :------------- | :-------- | :------------ | :------------- |
+| **$url**       | _string_  |               | file relative url, from site root, e.q `/assets/css/my.css`  |
+| **$timestamp** | _booleab_ | `false`       | set file versioning with query pair `?time=xxx`, if file doesn't exist - query will be empty string |
+| **$absolute**  | _booleab_ | `false`       | generate absolute url, with `protocol` and `host` setting (see [#setup section](#setup)) |
+
+_Returns:_ URL 
+
+
+#### Usage example
+
+```php
+<?php
+ 
+use WezomAgency\R2D2;
+
+// in core app file:
+// R2D2::eject()
+//       ->set('host', 'my-site.com')
+//       ->set('protocol', 'https://')
+
+?>
+<link rel="stylesheet" href="<?= R2D2::eject()->fileUrl('/assets/css/style1.css'); ?>">
+<link rel="stylesheet" href="<?= R2D2::eject()->fileUrl('/assets/css/style2.css', true); ?>">
+<link rel="stylesheet" href="<?= R2D2::eject()->fileUrl('/assets/css/style3.css', true, true); ?>">
+```
+#### Result
+
+```html
+<link rel="stylesheet" href="/assets/css/style1.css">
+<link rel="stylesheet" href="/assets/css/style2.css?time=1545054627">
+<link rel="stylesheet" href="https://my-site.com/assets/css/style3.css?time=1545054627">
+```
+
+
+---
+
+### instance::fileContent
+
+Get file content.
+
+```php
+R2D2::eject()->fileContent($path) string
+```
+
+_Parameters:_
+
+| Name           | Data type | Default value | Description    |
+| :------------- | :-------- | :------------ | :------------- |
+| **$path**      | _string_  |               | file relative url, from the `rootPath` (see [#setup section](#setup))  |
+
+_Returns:_ file content
+
+
+#### Usage example
+
+```php
+<?php
+ 
+use WezomAgency\R2D2;
+
+// in core app file:
+// R2D2::eject()
+//       ->set('rootPath', './')
+
+?>
+<style><?= R2D2::eject()->fileContent('/assets/css/critical.css'); ?></style>
+```
+#### Result
+
+```html
+<style>html{font:14px/1.3em Arial;color:#222}h1{color:red;font-size:2em}.wysiswyg{font-size:16px;line-height:normal}</style>
+```
+
+
+

src/WezomAgency/R2D2.php

@@ -40,27 +40,28 @@ public static function eject()
 
 
     /**
-     * @param string $key
+     * Setup instance settings
+     * @param string $name
      * @param string $value
      * @return R2D2 $this
      * @throws \Exception
      */
-    public function set($key, $value)
+    public function set($name, $value)
     {
-        if (property_exists($this, $key) === false) {
+        if (property_exists($this, $name) === false) {
             if ($this->debug) {
-                throw new \Exception("Property $key does not exist in class " . __CLASS__);
+                throw new \Exception("Property $name does not exist in class " . __CLASS__);
             } else {
                 return $this;
             }
         }
-        switch ($key) {
+        switch ($name) {
             case 'rootPath':
             case 'resourceRelativePath':
-                $this->$key = rtrim($value, '/') . '/';
+                $this->$name = rtrim($value, '/') . '/';
                 break;
             default:
-                $this->$key = $value;
+                $this->$name = $value;
         }
 
         return $this;
@@ -76,13 +77,14 @@ public function set($key, $value)
     public function fileUrl($url, $timestamp = false, $absolute = false)
     {
 
-        $root = $absolutePath ? ($this->protocol . $this->host) : '/';
+        $root = $absolute ? ($this->protocol . $this->host) : '/';
         $file = trim($url, '/');
         if ($timestamp) {
-            if ($this->fileUrlTimestampsCache[$file] === null && is_file($this->rootPath . $file)) {
+            if (!isset($this->fileUrlTimestampsCache[$file]) && is_file($this->rootPath . $file)) {
                 $this->fileUrlTimestampsCache[$file] = '?time=' . fileatime($this->rootPath . $file);
             }
-            return $root . $file . $this->fileUrlTimestampsCache[$file];
+            $query = isset($this->fileUrlTimestampsCache[$file]) ? $this->fileUrlTimestampsCache[$file] : '';
+            return $root . $file . $query;
         }
         return $root . $file;
     }
@@ -93,8 +95,8 @@ public function fileUrl($url, $timestamp = false, $absolute = false)
      */
     public function fileContent($path)
     {
-        $path = $this->fileUrl($path, false, false);
-        return file_get_contents($this->rootPath . $path);
+        $file = trim($path, '/');
+        return file_get_contents($this->rootPath . $file);
     }
 
 
@@ -252,11 +254,11 @@ public function svgSymbol($id, $attrs = [], $spritemap = null)
      */
     protected function getNonRepeatingId ($id, $number = null) {
         $key = $id . ($number ? '-' . $number : '');
-        if ($this->idCache[$key] === null) {
-            $this->idCache[$key] = 1;
-            return $key;
+        if (isset($this->idCache[$key])) {
+            return $this->getNonRepeatingId($id, ($number ? ++$number : 1));
         }
-        return $this->getNonRepeatingId($id, ($number ? ++$number : 1));
+        $this->idCache[$key] = 1;
+        return $key;
     }
 
     /**