README

This router is used in the partez framework (see on Packagist). It provides a set of functions to help you create a smart router for you web app or API.

Getting started

Installation

You can install the router in your project using composer:

composer require abollinger/router

Usage

Here a the functions provided:

Functions in the Classes tree

Abollinger/
- Router::
  - getRoutesFromYaml($dir)
  - getRoutesFromDirectory($dir)

getRoutesFromYaml

Retrieves routes from YAML files present in the specified directory.

@param string $dir: The directory containing YAML route files
@return array: An array of parsed routes from YAML files

getRoutesFromDirectory

Retrieves routes from PHP controller files within the specified directory.

@param string $directory: The directory path containing PHP controller files.
@return array: An array containing extracted routes with their path, name, and controller information.

Classes tree

Abollinger/
└── Router::
    ├── getRoutesFromYaml($dir)
    └── getRoutesFromDirectory($dir)

Licence

This library is licensed under the MIT License. For full license details, see the LICENCE file distributed with this source code.

Author

Antoine Bollinger Email: abollinger@partez.net

For contributions, issues, or feedback, feel free to contact the author or open a GitHub issue.

abollinger / router

Maintainers

Details