thallesdella/factory-router

Model of component for composer

1.0.0 2020-02-04 12:24 UTC

Requires

• php: ^7.3
• coffeecode/router: 1.0.7

Requires (Dev)

• phpunit/phpunit: 8.5.2
• squizlabs/php_codesniffer: 3.*

MIT

• Thalles D. Koester

• composer
• router
• addon
• component
• Coffeecode
• factory router
• thallesdella

README

Factory Router é um componente simples, que te ajuda na criação das rotas do seu sistema. Utilizando o motor de rotas Router, ele roteia o gerenciamento das rotas para alguma classe a sua escolha.

Destaques

• Instalação simples
• Facil utilização
• Pronto para o composer e compatível com PSR-2

Instalação

Factory Router esta disponível atraves do composer:

"thallesdella/factory-router": "^1.0.*"

Ou execute

composer require thallesdella/factory-router

Documentação

FactoryRouter

Construindo objeto

• FactoryRouter::class(string $projectUrl, string $projectRoot, string $namespace)

  • $projectUrl: Url base do projeto
  • $projectRoot: Caminho para a raiz do projeto
  • $namespace: Namespace padrão dos controllers

OBS: O namespace pode ser alterado durante a execução.

Adicionando arquivo ou pasta

• FactoryRouter::addFile(string $file): FactoryRouter

  • $file: Caminho do arquivo referente a raiz do projeto

• FactoryRouter::addDir(string $dir): FactoryRouter

  • $dir: Caminho do diretório referente a raiz do projeto

Obtendo objeto Router

• FactoryRouter::build(): Router

Routes

• Routes::class(Router $router, string $controllerName)

  • $router: objeto Router
  • $controllerName: Nome do controller

• Routes::namespace(?string $ns): Routes

  • $ns: Novo namespace

• Routes::group(?string $group): Router

  • $group: Nome do grupo

• Routes::get(string $route, string $name): void

  • $route: Caminho da rota
  • $name: Apelido para a rota

• Routes::post(string $route, string $name): void

  • $route: Caminho da rota
  • $name: Apelido para a rota

• Routes::put(string $route, string $name): void

  • $route: Caminho da rota
  • $name: Apelido para a rota

• Routes::delete(string $route, string $name): void

  • $route: Caminho da rota
  • $name: Apelido para a rota

Criando uma classe gerente do Router

Crie uma classe e extenda ela a classe Routes.

use CoffeeCode\Router\Router;
use ThallesDella\FactoryRouter\Routes;

class Foo extends Routes
{
    public function __contruct(Router $router){
        parent::__construct($router, 'Bar');
    }
}

Um método, com nome de updateRouter, deverá ser criado com a seguinte assinatura:

public function updateRouter(): Router;

Para mais detalhes sobre como usar, veja na pasta de exemplos no diretório do componente.

Contribuindo

Por favor veja CONTRIBUINDO para detalhes.

Suporte

Se você descobrir algum problema relacionado à segurança, envie um e-mail para [e-mail] em vez de usar o rastreador de problemas.

Obrigado

Créditos

• Thalles D. Koester (Desenvolvedor)
• Todos os Contribuidores (Pessoas Incríveis)

Licensa

Licensa MIT (MIT). Por favor veja Arquivo de Licensa para mais informações.