softius/resources-resolver

Resolve file paths and methods

Resources Resolver

![Software License][ico-license] ![Coverage Status][ico-scrutinizer] ![Total Downloads][ico-downloads], _(*1)

Install

Via Composer, _(*2)

``` bash $ composer require softius/resources-resolver, <sub>(*3)</sub>

## Usage 

The following resolvers are made available by this library.

* `CallableResolver`
* `FilenameResolver`

## Usage: CallableResolver

It is possible to resolve the following inputs to the associated callable as it is demonstrated below. This works for static and non-static methods as well and it relies heavily for a Container to be provided.

* `App\GreetingController::helloAction` to `[instance of App\GreetingController, 'helloAction']`
* `::helloAction` to `[instance of calling class, 'helloAction']`
* `parent::helloAction` to `[parent instance of calling class, 'helloAction']`
* `App\SomeClass::someStaticMethod` to `['App\SomeClass', 'someStaticMethod']`

### Resolve a non - static method

``` PHP
use League\Container\Container;
use Softius\ResourcesResolver\CallableResolver;

$container = new Container();
$container->add('App\SomeClass');

$resolver = new CallableResolver($container);

$callable = $resolver->resolve('App\SomeClass::someMethod');;

Resolve a method using alias for class

``` PHP use League\Container\Container; use Softius\ResourcesResolver\CallableResolver;, <sub>(*4)</sub>

$container = new Container(); $container->add('FooClass', 'App\SomeClass');, <sub>(*5)</sub>

$resolver = new CallableResolver($container);, <sub>(*6)</sub>

$callable = $resolver->resolve('FooClass::someMethod');;, <sub>(*7)</sub>

### Resolve a static method

``` PHP
use Softius\ResourcesResolver\CallableResolver;

$resolver = new CallableResolver();

$callable = $resolver->resolve('App\SomeClass::someStaticMethod');

Resolve using parent or self

``` PHP use Softius\ResourcesResolver\CallableResolver;, <sub>(*8)</sub>

class A { public function hi() { echo 'A: Hi!'; } }, <sub>(*9)</sub>

class B extends A { public function hi() { echo 'B: Hi!'; }, <sub>(*10)</sub>

public function test()
{
    $resolver = new CallableResolver();
    $callable = $resolver->resolve('::hi');         // returns [B, hi]
    $callable = $resolver->resolve('self::hi');     // returns [B, hi]
    $callable = $resolver->resolve('parent::hi');   // returns [A, hi]
}   

}, <sub>(*11)</sub>

## Usage: FilenameResolver

### Resolve a filename from templates directory

``` PHP
define('TEMPLATES_DIR', '...');

use Softius\ResourcesResolver\FilenameResolver; 

$resolver = new FilenameResolver(TEMPLATES_DIR); 
$filename = $resolver->resolve('path/to/template.php');

It is also possible to omit the extension and specify a global extension for all files to be resolved, like below., <sub>(*12)</sub>

``` PHP define('TEMPLATES_DIR', '...');, <sub>(*13)</sub>

use Softius\ResourcesResolver\FilenameResolver;, <sub>(*14)</sub>

$resolver = new FilenameResolver(TEMPLATES_DIR); $resolver->setExtension('php'); $filename = $resolver->resolve('path/to/template');, <sub>(*15)</sub>

Many frameworks don't use the directory separator to provide a consistent look across multiple OS. The following example uses '.' as the directory separator without file extensions

``` PHP
define('TEMPLATES_DIR', '...');

use Softius\ResourcesResolver\FilenameResolver; 

$resolver = new FilenameResolver(TEMPLATES_DIR, '.');
$resolver->setExtension('php');
$filename = $resolver->resolve('path.to.template');

Resolve a filename from include path

``` PHP define('TEMPLATES_DIR', '...');, <sub>(*16)</sub>

use Softius\ResourcesResolver\FilenameResolver;, <sub>(*17)</sub>

$resolver = new FilenameResolver(TEMPLATES_DIR); $resolver->useIncludePath(true); $filename = $resolver->resolve('path/to/file.php');, <sub>(*18)</sub>

## Testing

``` bash
$ composer test

License

The MIT License (MIT). Please see License File for more information., <sub>(*19)</sub>