Download the PHP package gp/router without Composer

GP Router

The GP Router is a lightweight and flexible routing solution for PHP applications. It simplifies the process of mapping HTTP requests to specific controllers or callbacks, enabling developers to build clean, organized, and scalable web applications. With its modular design, the library supports dynamic route parameters, middleware (filters) for pre- and post-processing, and API-specific routes. It is suitable for a wide range of applications, from simple websites to complex RESTful APIs.

This library focuses on:

• Ease of use: Define routes with minimal setup.
• Flexibility: Handle dynamic URL parameters and custom middleware.
• Extensibility: Support for API-specific routes and customizable request/response handling.

Whether you are building a small project or a large-scale application, the GP Router library provides the tools you need to manage your application's routing efficiently.

Table of Contents

• Requirements
• Installation
• Getting Started
• Features
• Classes
  • Router
  • Route
  • APIRoute
  • Wrapper
  • Request
  • Response
  • Filter
• Usage
  • Basic Route Definition
  • Using Route Class
  • Dynamic Parameters in Routes
  • Using Filters (Middleware)
  • Auto Resolve params
  • Resolving the Request & Response class
  • Resolving the url params
  • Resolving the Modal class
  • Resolving the other service/model
• Example
  • Initializing the Router
  • Using Request object
  • Using Response object
• Contributing
• License
• Contact
• Author

Requirements

• PHP 7.4 or higher.
• Composer (optional but recommended for autoloading).

Installation

You can install gp_router using Composer. Run the following command in your terminal:

Getting Started

After installation, you can start using the package by including the autoloader:

Features

The GP Router library provides a comprehensive set of features to handle routing efficiently in PHP applications:

• Flexible Route Definitions:

  • Define static and dynamic routes with ease.
  • Support for URL parameters (e.g., /user/{(\d+):id}).

• HTTP Method Handling:

  • Supports all major HTTP methods: GET, POST, PUT, DELETE, PATCH, etc.
  • Route-specific method restrictions.

• Middleware Support (Filters):

  • Add pre- or post-processing logic to routes using filters.
  • Useful for authentication, logging, and request validation.

• API-Specific Routing:

  • Use the APIRoute class to define API endpoints.
  • Designed for building RESTful services.

• Supports Dependency Injection and Auto Param Resolve

  • Automatically resolve the controller class constructor and action method params with query params, request and response instance, service instances and also model class with post data

• Error Handling:

  • Customizable error handlers for unmatched routes or invalid requests.

• Request and Response Abstraction:

  • Simplifies access to HTTP request data (GET, POST, headers, etc.).
  • Facilitates response construction, including status codes and headers.

• Route Groups and Prefixes:

  • Group multiple routes with a shared prefix.
  • Useful for organizing application modules (e.g., /api/v1/).

• Named Routes:

  • Assign names to routes for easier URL generation.

• Dynamic URL Matching:

  • Match routes using regular expressions or placeholders.

• Extensibility:

  • Easily extend core classes to add custom functionality.
  • Seamlessly integrate with other libraries or frameworks.

• Lightweight and Fast:

  • Designed with performance in mind, making it ideal for high-traffic applications.
• Error-Free Execution:
  • Built-in validation and error handling ensure smooth routing logic.

These features make the GP Router library a powerful and versatile choice for managing routing in your PHP projects.

Classes

Router

Handles routing functionality.

Key Methods:

• add($route, $expression, $method, $filter, $name): Adds a route.
• run($caseSensitive, $url, $method): Executes the router.
• error($data, $code): Handles errors which call the configured controller for errors.

Route

Represents a single route.

Key Properties:

• $path/$rule : Route path (eg: user/{(\d+):id}).
• $expression: Controller and action method or callback
  • home/index - invokes HomeController::index()
  • home - invokes HomeController::invoke()
  • callback function - call the callback function
• $method: HTTP method.
• $filter: Array of callback or Filter instances to be executed as middleware.
• $name: Route name.

APIRoute

Handles API-specific routes.

Wrapper

Wraps multiple routes together.

Request

Handles HTTP request details.

Response

Handles HTTP response generation.

Filter

Represents middleware for routes.

Usage

Basic Route Definition

Using Route Class

Dynamic Parameters in Routes

In this example, {id} is a dynamic parameter. You can access it in your controller using the Request object.

Using Filters (Middleware)

Auto Resolve params

Resolving the Request & Response class

The request & response class object will be resolved and passed automatically to the controller consturctor or action method without any additional config, you can use them by adding them as param in the constructor or method, please ensure that you have added exact type for the params.

In constructor Param

In Method Param

Resolving the url params

You can also add the url param values as the part of the param in the constructor or in class method.

• config the url param name in the route as follow. note: path or rule should have the url name and its regex as {(regex):key}

• Add this url param name as parameter name as follows

Resolving the Modal class

You can configure the modal class to capture the request data and it's instance will be passed as the param

• Create a base modal class
• Create derived modal class from this base modal class which needs to be passed as parameter.
• set the base modal class to the Router using setUpModalClass
• Add a derived modal class as a parameter to the method.

Resolving the other service/model

In the same way we can resolve other service modal class instances.

Example

Initializing the Router

You can initialize the router and define routes in your application:

Using Request object

once the request object is passed as the param to the action method, we can use this method to get all the required details of the request using available methods in the request class.

Using Response object

once the response object is passed as the param to the action method, we can use this to handle the response.

The response content will be captured by

• The return values of the method (or)
• The content set in Response object

we can also change the response type by using the setType method in response class as follows

Available response types are as follows

• JSON
• HTML
• XML
• text
• csv
• yaml
• binary
• image
• audio
• video
• stream

Contributing

Contributions are welcome! If you would like to contribute to gp_validator, please follow these steps:

• Fork the repository.
• Create a new branch (git checkout -b feature/- YourFeature).
• Make your changes and commit them (git commit -m 'Add some feature').
• Push to the branch (git push origin feature/YourFeature).
• Open a pull request.
• Please ensure that your code adheres to the coding standards and includes appropriate tests.

License

This package is licensed under the MIT License. See the LICENSE file for more information.

Contact

For questions or issues, please reach out to the development team or open a ticket.

Author

• Periyandavar Github ([email protected])