ZXC_PHP

# Routing

ZXC_PHP uses it is own simple routing class. HTTP requests can be routed only to class methods. All routes are described in an array in the json file. In routes.json you can describe some routes, lets watch to the properties for route item.

# Request Response

foo

# middlewares

  • Type: string[]
  • Default: []
  • Required true
  • Description: Property for route middlewares

# method

  • Type: string
  • Default: none
  • Required true
  • Description: HTTP method

# route

  • Type: string
  • Default: none
  • Required true
  • Description: URI path

# handler

  • Type: string
  • Default: none
  • Required true
  • Description: URI handler
[
    {
        "middlewares": [
            "myMiddlewareAlias"
        ],
        "method": "GET",
        "route": "/",
        "handler": "App\\Modules\\MyModule\\Handlers\\MyHandler"
    }
]

# Route handler

If you want define route handler in config you should use next format.

Route handler in config

Namespace\\ClassName:method
App\\Application:helloWorld

All handler methods should take three arguments ServerRequest $request, ResponseInterface $response, RouteParams $routeParams and return ResponseInterface .
For example:

<?php


namespace App;


use ZXC\Native\RouteParams;
use ZXC\Native\PSR\ServerRequest;
use ZXC\Interfaces\Psr\Http\Message\ResponseInterface;


class Application
{
    public function helloWorld(ServerRequest $request, ResponseInterface $response, RouteParams $routeParams)
    {
        $response->write('Hello world');
        return $response;
    }
}

# Route dynamic parameters

You can define a single route to handle different dynamic parameters.
Here (config file below) we have defined route with two dynamic parameters user and id.
You can use method $routeParams->getParams() to get dynamic parameters.

{
    "router": {
        "routes": [
            {
                "method": "GET",
                "route": "/:user/post/:id",
                "handler": "App\\Application:getPostById"
            }
        ]
    }
}

<?php


namespace App;


use ZXC\Native\RouteParams;
use ZXC\Native\PSR\Response;
use ZXC\Native\PSR\ServerRequest;


class Application
{
    public function getPostById(ServerRequest $request, Response $response, RouteParams $routeParams)
    {
        $params = $routeParams->getParams();
        $response->write('Post from user ' . $params['user'] . ' id => ' . $params['id']);
        return $response;
    }
}

← Middleware →