ozziest/patika

Simple PHP routing library.

1.1.1 2015-12-31 15:45 UTC

This package is not auto-updated.

Last update: 2024-07-06 17:43:55 UTC


README

Patika

Build Status Total Downloads Latest Stable Version Latest Unstable Version License

Patika is a simple routing package that you can use easily your projects. This is small and useful package because you dont have to define all routes. You should code your controller instead of routing defination.

Installation

To install through composer, simply put the following in your composer.json file:

{
    "require": {
        "ozziest/patika": "dev-master"
    }
}
$ composer update

Usage

First of all, you should define .htaccess file so that handle all request and send it to index.php file.

.htaccess

RewriteEngine on
RewriteCond $1 !^(index\.php|images|robots\.txt)
RewriteRule ^(.*)$ /index.php/$1 [L]

index.php file must be defined like this;

// Including composer autoload file
include 'vendor/autoload.php';

// First of all, you should use try-catch block for handling routing errors
try {
    // You must create a new instance of Manager Class with the app argument.
    $patika = new Ozziest\Patika\Manager(['app' => 'App\Controllers']);
    // And calling the route!
    $patika->call();
} catch (Ozziest\Patika\Exceptions\PatikaException $e) {
    // If the controller or method aren't found, you can handle the error.
    echo $e->getMessage();
}

That's all! Patika Router is active now. Now, you can define your controller which what you want.

Users.php

namespace App\Controllers;

class Users {

    /**
     * All
     *
     * @return null
     */
    public function all()
    {
        echo 'App\Controllers\Users@all()';
    }
    
}

Checking

$ php -S localhost:8000 index.php
$ curl -X GET localhost:8000/users/all 

Full Documentation

You can read the Full Documentation!