bavix / router

src/Resolver.php

<?php

namespace Bavix\Router;

class Resolver implements GroupResolution
{

    /**
     * @var callable
     */
    protected $collections;

    /**
     * @var callable
     */
    protected $patterns;

    /**
     * Resolver constructor.
     *
     * @param callable $patterns
     * @param callable $collections
     */
    public function __construct(callable $patterns, callable $collections)
    {
        $this->collections = $collections;
        $this->patterns = $patterns;
    }

    /**
     * @param array $methods
     * @param string $path
     * @param null|string $name
     *
     * @return Pattern
     */
    public function methods(array $methods, string $path, ?string $name): Pattern
    {
        return $this->pushPattern($this->pattern($path, $name))->methods($methods);
    }

    /**
     * @param Pattern $pattern
     *
     * @return Pattern
     */
    protected function pushPattern(Pattern $pattern): Pattern
    {
        return \call_user_func($this->patterns, $pattern);
    }

    /**
     * @param string $path
     * @param null|string $name
     * @return Pattern
     */
    protected function pattern(string $path, ?string $name): Pattern
    {
        return new Pattern($path, $name);
    }

    /**
     * GET|POST|PUT|PATCH|HEAD|OPTIONS|DELETE
     *
     * @param string $path
     * @param null|string $name
     *
     * @return Pattern
     */
    public function any(string $path, ?string $name = null): Pattern
    {
        return $this->pushPattern($this->pattern($path, $name))->any();
    }

    /**
     * @param string $path
     * @param null|string $name
     *
     * @return Pattern
     */
    public function get(string $path, ?string $name = null): Pattern
    {
        return $this->pushPattern($this->pattern($path, $name))->get();
    }

    /**
     * @param string $path
     * @param null|string $name
     *
     * @return Pattern
     */
    public function post(string $path, ?string $name = null): Pattern
    {
        return $this->pushPattern($this->pattern($path, $name))->post();
    }

    /**
     * @param string $path
     * @param null|string $name
     *
     * @return Pattern
     */
    public function put(string $path, ?string $name = null): Pattern
    {
        return $this->pushPattern($this->pattern($path, $name))->put();
    }

    /**
     * @param string $path
     * @param null|string $name
     *
     * @return Pattern
     */
    public function patch(string $path, ?string $name = null): Pattern
    {
        return $this->pushPattern($this->pattern($path, $name))->patch();
    }

    /**
     * @param string $path
     * @param null|string $name
     *
     * @return Pattern
     */
    public function delete(string $path, ?string $name = null): Pattern
    {
        return $this->pushPattern($this->pattern($path, $name))->delete();
    }

    /**
     * @param string $entityName
     * @param null|string $name
     * @return Pattern
     */
    public function index(string $entityName, ?string $name = null): Pattern
    {
        return $this->pushPattern($this->_index($entityName, $name));
    }

    /**
     * entityName -> /users
     *
     *  GET         users.index     /users
     *
     * @param string $entityName
     * @param null|string $name
     * @return Pattern
     */
    protected function _index(string $entityName, ?string $name = null): Pattern
    {
        return $this->pattern(
            $entityName,
            $this->name($name, 'index')

It seems like $name can also be of type null; however, parameter $name of Bavix\Router\Resolver::name() does only seem to accept string, maybe add an additional type check?

        )->get();
    }

    /**
     * @param string $name
     * @param string $index
     * @return string
     */
    protected function name(string $name, string $index): string
    {
        return $name . '.' . $index;
    }

    /**
     * @param string $entityName
     * @param null|string $name
     * @return Pattern
     */
    public function create(string $entityName, ?string $name = null): Pattern
    {
        return $this->pushPattern($this->_create($entityName, $name));
    }

    /**
     * entityName -> /users
     *
     *  GET         users.create    /users/create
     *
     * @param string $entityName
     * @param null|string $name
     * @return Pattern
     */
    protected function _create(string $entityName, ?string $name = null): Pattern
    {
        return $this->pattern(
            $this->action($entityName, 'create'),
            $this->name($name, 'create')

It seems like $name can also be of type null; however, parameter $name of Bavix\Router\Resolver::name() does only seem to accept string, maybe add an additional type check?

        )->get();
    }

    /**
     * @param string $entityName
     * @param string $action
     * @return string
     */
    protected function action(string $entityName, string $action): string
    {
        return $entityName . '/' . $action;
    }

    /**
     * @param string $entityName
     * @param null|string $name
     * @return Pattern
     */
    public function store(string $entityName, ?string $name = null): Pattern
    {
        return $this->pushPattern($this->_store($entityName, $name));
    }

    /**
     * entityName -> /users
     *
     *  POST        users.store     /users
     *
     * @param string $entityName
     * @param null|string $name
     * @return Pattern
     */
    protected function _store(string $entityName, ?string $name = null): Pattern
    {
        return $this->pattern(
            $entityName,
            $this->name($name, 'store')

It seems like $name can also be of type null; however, parameter $name of Bavix\Router\Resolver::name() does only seem to accept string, maybe add an additional type check?

        )->post();
    }

    /**
     * @param string $entityName
     * @param null|string $name
     * @param null|string $id
     * @return Pattern
     */
    public function show(string $entityName, ?string $name = null, ?string $id = null): Pattern
    {
        return $this->pushPattern($this->_show($entityName, $name, $id));
    }

    /**
     * entityName -> /users
     *
     *  GET         users.show      /users/{id}
     *
     * @param string $entityName
     * @param null|string $name
     * @param null|string $id
     * @return Pattern
     */
    protected function _show(string $entityName, ?string $name = null, ?string $id = null): Pattern
    {
        return $this->pattern(
            $this->id($entityName, $id),

It seems like $id can also be of type null; however, parameter $id of Bavix\Router\Resolver::id() does only seem to accept string, maybe add an additional type check?

            $this->name($name, 'show')

It seems like $name can also be of type null; however, parameter $name of Bavix\Router\Resolver::name() does only seem to accept string, maybe add an additional type check?

        )->get();
    }

    /**
     * @param string $entityName
     * @param string $id
     * @return string
     */
    protected function id(string $entityName, string $id): string
    {
        return $this->action($entityName, '<' . $id . '>');
    }

    /**
     * @param string $entityName
     * @param null|string $name
     * @param null|string $id
     * @return Pattern
     */
    public function edit(string $entityName, ?string $name = null, ?string $id = null): Pattern
    {
        return $this->pushPattern($this->_edit($entityName, $name, $id));
    }

    /**
     * entityName -> /users
     *
     *  GET         users.edit      /users/{id}/edit
     *
     * @param string $entityName
     * @param null|string $name
     * @param null|string $id
     * @return Pattern
     */
    protected function _edit(string $entityName, ?string $name = null, ?string $id = null): Pattern
    {
        return $this->pattern(
            $this->idAction($entityName, $id, 'edit'),

It seems like $id can also be of type null; however, parameter $id of Bavix\Router\Resolver::idAction() does only seem to accept string, maybe add an additional type check?

            $this->name($name, 'edit')

It seems like $name can also be of type null; however, parameter $name of Bavix\Router\Resolver::name() does only seem to accept string, maybe add an additional type check?

        )->get();
    }

    /**
     * @param string $entityName
     * @param string $id
     * @param string $action
     * @return string
     */
    protected function idAction(string $entityName, string $id, string $action): string
    {
        return $this->action($this->id($entityName, $id), $action);
    }

    /**
     * @param string $entityName
     * @param null|string $name
     * @param null|string $id
     * @return Pattern
     */
    public function update(string $entityName, ?string $name = null, ?string $id = null): Pattern
    {
        return $this->pushPattern($this->_update($entityName, $name, $id));
    }

    /**
     * entityName -> /users
     *
     *  PUT/PATCH   users.update    /users/{id}/edit
     *
     * @param string $entityName
     * @param null|string $name
     * @param null|string $id
     * @return Pattern
     */
    protected function _update(string $entityName, ?string $name = null, ?string $id = null): Pattern
    {
        return $this->pattern(
            $this->idAction($entityName, $id, 'edit'),

It seems like $id can also be of type null; however, parameter $id of Bavix\Router\Resolver::idAction() does only seem to accept string, maybe add an additional type check?

            $this->name($name, 'update')

It seems like $name can also be of type null; however, parameter $name of Bavix\Router\Resolver::name() does only seem to accept string, maybe add an additional type check?

        )->setMethods(['PUT', 'PATCH']);
    }

    /**
     * @param string $entityName
     * @param null|string $name
     * @param null|string $id
     * @return Pattern
     */
    public function destroy(string $entityName, ?string $name = null, ?string $id = null): Pattern
    {
        return $this->pushPattern($this->_destroy($entityName, $name, $id));
    }

    /**
     * entityName -> /users
     *
     *  DELETE      users.destroy   /users/{id}
     *
     * @param string $entityName
     * @param null|string $name
     * @param null|string $id
     * @return Pattern
     */
    protected function _destroy(string $entityName, ?string $name = null, ?string $id = null): Pattern
    {
        return $this->pattern(
            $this->id($entityName, $id),

It seems like $id can also be of type null; however, parameter $id of Bavix\Router\Resolver::id() does only seem to accept string, maybe add an additional type check?

            $this->name($name, 'destroy')

It seems like $name can also be of type null; however, parameter $name of Bavix\Router\Resolver::name() does only seem to accept string, maybe add an additional type check?

        )->delete();
    }

    /**
     * @param string $entityName
     * @param null|string $name
     * @param null|string $id
     *
     * @return ResourceCollection
     */
    public function apiResource(string $entityName, ?string $name = null, ?string $id = null): ResourceCollection
    {
        return $this->resource($entityName, $name, $id)->only([
            'index', 'store', 'show', 'update', 'destroy'
        ]);
    }

    /**
     * entityName -> /users
     *
     *  GET         users.index     /users
     *  GET         users.create    /users/create
     *  POST        users.store     /users
     *  GET         users.show      /users/{id}
     *  GET         users.edit      /users/{id}/edit
     *  PUT/PATCH   users.update    /users/{id}/edit
     *  DELETE      users.destroy   /users/{id}
     *
     * @param string $entityName
     * @param null|string $name
     * @param null|string $id
     *
     * @return ResourceCollection
     */
    public function resource(string $entityName, ?string $name = null, ?string $id = null): ResourceCollection
    {
        $entityName = \rtrim($entityName, '/');
        $name = $name ?: \ltrim($entityName, '/');
        $id = $id ?: $name;

        return $this->pushCollection(new ResourceCollection([
            'index' => $this->_index($entityName, $name),
            'create' => $this->_create($entityName, $name),
            'store' => $this->_store($entityName, $name),
            'show' => $this->_show($entityName, $name, $id),
            'edit' => $this->_edit($entityName, $name, $id),
            'update' => $this->_update($entityName, $name, $id),
            'destroy' => $this->_destroy($entityName, $name, $id)
        ]));
    }

    /**
     * @param ResourceCollection $collection
     *
     * @return ResourceCollection
     */
    protected function pushCollection(ResourceCollection $collection): ResourceCollection
    {
        return \call_user_func($this->collections, $collection);
    }

}