Wallogit.com
2017 © Pedro Peláez
A laravel package that will determine if a feature is supported.
This package is abandonded and no longer supported, (*1)
A package that provides a facade to easily access logic to determine if a feature is usable., (*2)
Via Composer, (*3)
``` bash $ composer require taylornetwork/feature, (*4)
## Setup ### Register Service Provider Add the service provider to the providers array in `config/app.php` ``` php 'providers' => [ TaylorNetwork\Feature\FeatureServiceProvider::class, ],
Add the facade to the aliases array in config/app.php, (*5)
``` php 'aliases' => [, (*6)
'Feature' => TaylorNetwork\Feature\Facades\Feature::class,
],, (*7)
### Publish Config Publish `feature.php` to your `config` directory ``` bash $ php artisan vendor:publish
This package comes with a make:feature artisan command to generate feature classes in the namespace set in config/feature.php, App\Features by default., (*8)
For example, we want to use SweetAlert2, but the features don't work on some devices, we would want to create a SweetAlert feature class., (*9)
``` bash $ php artisan make:feature SweetAlert, (*10)
Would generate `app/Features/SweetAlert.php` ``` php namespace App\Features; use TaylorNetwork\Feature\BaseFeature; class SweetAlert extends BaseFeature { }
You can add all logic regarding SweetAlert in this class., (*11)
Optionally the make:feature command accepts an --alias option which will add an alias to call the class with., (*12)
For example to add an alias swal, for the SweetAlert class., (*13)
``` bash $ php artisan make:feature SweetAlert --alias=swal, (*14)
The same file is generated as above, but it now includes a static property `$alias` ```php namespace App\Features; use TaylorNetwork\Feature\BaseFeature; class SweetAlert extends BaseFeature { public static $alias = 'swal'; }
All feature classes should extend the TaylorNetwork\Feature\BaseFeature class, which gives easy access to other feature classes., (*15)
The BaseFeature class has a getFeatureInstance() method that returns the original instance of the Feature class that called this feature class., (*16)
This can be useful to access any instantiated packages (see Packages for more details), or other feature classes., (*17)
For example in our SweetAlert class we want to access another feature class, Toastr, if SweetAlert doesn't work on this device and display a message., (*18)
``` php namespace App\Features;, (*19)
use TaylorNetwork\Feature\BaseFeature;, (*20)
class SweetAlert extends BaseFeature { public function displayError() { $msg = 'SweetAlert not supported.'; $this->getFeatureInstance()->Toastr()->errorMessage($msg); } }, (*21)
### Feature Facade #### Accessing Feature Classes All feature classes are accesible via the `Feature` facade. To access any feature class, call the facade and the class name or alias as a function. ``` php Feature::ClassName() // OR Feature::ClassAlias()
For example to access our newly created SweetAlert class. We could call, (*22)
``` php Feature::SweetAlert(), (*23)
// OR, (*24)
Feature::swal(), (*25)
#### Available Methods The `Feature` class methods are accessible using the facade statically. ``` php Feature::method()
Returns an array of the packages and their instances registered with TaylorNetwork\Feature, (*26)
See Packages for more details on packages., (*27)
Returns an instance of a package. Same as calling Feature::getPackages()[$name]., (*28)
See Packages for more details on packages., (*29)
Returns an array of all accessible feature classes., (*30)
Using our SweetAlert example with the swal alias., (*31)
Feature::getClasses(), (*32)
Returns, (*33)
``` php [ 'SweetAlert' => App\Features\SweetAlert {#xxx}, 'swal' => App\Features\SweetAlert {#xxx}, ], (*34)
##### getClass (string $name) Returns an instance of a feature class. For example, instead of calling `Feature::SweetAlert()`, using this method you could call `Feature::getClass('SweetAlert')` ## Packages `TaylorNetwork\Feature` allows you to add packages that can be instantiated and accessed using the `getPackage($name)` or `getPackages()[$name]` methods (see [Available Methods](#available-methods)). Packages must be included in `config/feature.php` and are accessible by their array key name. For example, to include the [taylornetwork/name-formatter][link-tn-name-format], add to the `packages` array in `config/feature.php` ``` php 'packages' => [ 'nameFormatter' => \TaylorNetwork\Formatters\Name\Formatter::class, ],
Note: The entire fully qualified name needs to be the array value for the package to instantiated properly., (*35)
Once packages are registered they can be accessed by the Feature facade, or from inside a feature class using the getPackage method., (*36)
To access the nameFormatter from the feature facade, (*37)
``` php Feature::getPackage('nameFormatter'), (*38)
Returns an instance of `TaylorNetwork\Formatters\Name\Formatter` ### Feature Classes To access the `nameFormatter` from a feature class ``` php class ExampleFeatureClass extends BaseFeature { public function formatName($name) { return $this->getFeatureInstance()->getPackage('nameFormatter')->format($name); } }
The MIT License (MIT). Please see License File for more information., (*39)
A laravel package that will determine if a feature is supported.
A laravel package that will determine if a feature is supported.
A laravel package that will determine if a feature is supported.