data accessor, readme

Author: drewjbartlett

README.md

@@ -15,17 +15,23 @@
 
 This is a [Laravel](https://laravel.com) build. If you're not familiar with it, give it a look! There's quite a few folders in this install but below are the only ones to be concerned with.
 
+`data/` - This contains the data for all the methods and configuration that are displayed on the docs page. This also contains the data that tells the docs what pages to render per section.
+
 `resources/` - The views and assets.
 
       |---`views/` - The view template files.
 
+            |---`documentation/` -This is where the main documentation files live. For each section of the docs, a folder with sub pages lives.
+
+                  |---`methods & configuration` - Each one if these has a `code` folder where, if a file is created, it will be displayed below its definition on the docs page.
+
       |---`assets/` - The js.
 
             |---`sass/` -The sass
 
             |---`js/` -The JS for minor things such as code formatting and the config builder. Not really necessary to edit.
 
 ### Linting Your Sass
-If you make any changes to the sass you must follow the guidelines in the scsslint.yml. If you're not familiar with this, have a look [here](https://github.com/brigade/scss-lint/blob/master/lib/scss_lint/linter/README.md). Running the `gulp lint-sass` command should have no errors before commiting.
+If you make any changes to the sass you must follow the guidelines in the scsslint.yml. If you're not familiar with this, have a look [here](https://github.com/brigade/scss-lint/blob/master/lib/scss_lint/linter/README.md). Please follow the BEM syntax as I am loosley following it. Running the `gulp lint-sass` command should have no errors before commiting.
 
     gulp lint-sass

app/Data/Accessor.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace App\Data;
+
+class Accessor {
+
+    public static function dir() {
+        return base_path('data');
+    }
+
+    public static function fileName ($name) {
+        return self::dir() . '/' . $name . '.php';
+    }
+
+    public static function get ($key) {
+
+        $data = [];
+
+        if (!$key) {
+            return null;
+        }
+
+        if (file_exists(self::fileName($key))) {
+            $data = require(self::fileName($key)); //collect(json_decode(file(self::fileName($key))))->toArray();
+        }
+
+        return $data;
+    }
+}

app/Helpers/JSONResponse.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace App\Providers;
+
+use Illuminate\Support\ServiceProvider;
+
+class DataServiceProvider extends ServiceProvider
+{
+    /**
+     * Bootstrap the application services.
+     *
+     * @return void
+     */
+    public function boot()
+    {
+        //
+    }
+
+    /**
+     * Register the application services.
+     *
+     * @return void
+     */
+    public function register()
+    {
+        $this->app->bind('data', 'App\Data\Accessor');
+    }
+}

app/Providers/DataServiceProvider.php

@@ -1,5 +1,9 @@
 <?php
 
+function data ($key) {
+    return app('data')::get($key);
+}
+
 /**
  * Make a route for the docs from a key and a value
  *

app/Helpers/Helpers.php renamed to app/helpers.php

@@ -21,9 +21,7 @@
         "psr-4": {
             "App\\": "app/"
         },
-        "files": [
-            "app/Helpers/Helpers.php"
-        ]
+        "files": ["app/helpers.php"]
     },
     "autoload-dev": {
         "psr-4": {

composer.json

@@ -180,6 +180,8 @@
         App\Providers\EventServiceProvider::class,
         App\Providers\RouteServiceProvider::class,
 
+        App\Providers\DataServiceProvider::class
+
     ],
 
     /*