Download the PHP package carlosartur/slim-auto-routing-controller without Composer

SlimAutoRoutingController

This library adds a abstract controller to auto generate routes for a slim framework project.

How to use

Install

Supported HTTP Methods

• GET
• POST
• PUT
• DELETE
• OPTIONS
• PATCH

Usage example

How it works

• To generate path
  • If the controller has "ROUTE_FIXED" constant defined:
    • Use value of "ROUTE_FIXED" constant as path.
  • Else:
    • Get the controller's name.
    • Remove "Controller" word of it.
    • Slugify the remaining string.
    • Prefix it with value of "ROUTE_PREFIX" constant (optional).
• To generate a route:
  • Searches on controller the public methods which have the word "Action" on it's name, in any part of name.
    • To change the "Action" word to anything else, add a "METHOD_ROUTE_SUFFIX" constant on controller, with another word.
  • To generate a "GET" action, the method must have the "GET" word inside it's name.
  • To generate a "POST" action, the method must have the "POST" word inside it's name.
  • To generate a "PUT" action, the method must have the "PUT" word inside it's name.
  • To generate a "DELETE" action, the method must have the "DELETE" word inside it's name.
  • To generate a "OPTIONS" action, the method must have the "OPTIONS" word inside it's name.
  • To generate a "PATCH" action, the method must have the "PATCH" word inside it's name.
  • If method's name is more than \<verb>\<suffix>:
    • Remove http verb and suffix from name;
    • Slugify the remaining string
    • Add result of slug to path
• Parameters and Validation parameter's regex:
  • To add parameter, just add it on method, after "Request" and "Response" parameters.
  • To validate it, 2 ways are possible
    • By type:
      • Add a "TYPES_REGEX" constant on your controller, or use the library default, wich validates float and int only.
    • By name:
      • Add a "PARAMETER_VALIDATION_REGEX" constant on your controller, or use the library default, wich validates a parameter named "id" as a integer value.

        Controller

On your routing file

Instead of doing this

It's necessary only run this

Configuration

To configure each controller individually, some constants can be used: