jacksonsr45/radiante-php

This is a simple micro-framework in PHP

1.0.2 2023-08-15 13:38 UTC

Requires

• php: >=7.0

Requires (Dev)

• phpunit/phpunit: ^10.2

MIT

• jacksonsr45

README

RadiantPHP is a lightweight microframework for building PHP web applications. It provides a simple and elegant structure to develop web projects with ease. With RadiantPHP, you can quickly build RESTful APIs, web services, or small to medium-sized websites.

The RadiantPHP ServerRequestFactory provides a simple and convenient way to handle HTTP requests and responses in your PHP application. This documentation will guide you on how to integrate the ServerRequestFactory into your index.php file to handle incoming requests and send appropriate responses.

Installation

In you project php, opem your terminal and enter with this commands!

composer require jacksonsr45/radiante-php

Usage

Follow the steps below to integrate the RadiantPHP ServerRequestFactory into your index.php file:

1. Import the required class:

<?php

use Jacksonsr45\RadiantPHP\ServerRequestFactory;

1. Include the Composer autoloader and set the path to your routes.php file:

require_once __DIR__ . '/../vendor/autoload.php';

$pathToRoute = __DIR__ . '/routes.php';

1. Create the ServerRequest and handle the request:

$request = ServerRequestFactory::createServerRequest($pathToRoute);
$response = ServerRequestFactory::handleRequest($request);

1. Send the HTTP response:

ServerRequestFactory::sendHttpResponse($response);

Example:

Here's a complete example of how your index.php file should look after integrating the RadiantPHP ServerRequestFactory:

<?php

use Jacksonsr45\RadiantPHP\ServerRequestFactory;

require_once __DIR__ . '/../vendor/autoload.php';

// Creating a new container
$container = ContainerFactory::build();

$pathToRoute = __DIR__ . '/routes.php';
$request = ServerRequestFactory::createServerRequest($pathToRoute, $container);
$response = ServerRequestFactory::handleRequest($request);
ServerRequestFactory::sendHttpResponse($response);

Make sure to replace '../vendor/autoload.php' with the correct path to your Composer autoloader if it differs.

Routes:

Create routes easiling with methods [GET, PUT, DELETE, PUT], first stape is using instance with class Route another using method, in method is required string to route path and a array with Controller::class and class method.

Create a route GET:

<?php

use Jacksonsr45\RadiantPHP\Http\Route;

Route::get('/user', [UserController::class, 'list']);

<?php

use Jacksonsr45\RadiantPHP\Http\Route;

Route::get('/user/<int:id>', [UserController::class, 'show']);

Create a route POST:

<?php

use Jacksonsr45\RadiantPHP\Http\Route;

Route::post('/user', [UserController::class, 'create']);

Create a route DELETE

<?php

use Jacksonsr45\RadiantPHP\Http\Route;

Route::delete('/user/<int:id>', [UserController::class, 'delete']);

Create a route PUT

<?php

use Jacksonsr45\RadiantPHP\Http\Route;

Route::put('/user', [UserController::class, 'update']);

Creating Controller:

By creating a new controller is simple, build a new class and in this class if is required using a DI create a __contruct(), and in inject a interface.

By functionalit is required in index.php include is partial code:

$container->set(ResponseInterface::class, create(Response::class));

And in controller is required:

use Jacksonsr45\RadiantPHP\Http\Message\Interfaces\ResponseInterface;

class UserController
{
    public function __construct(
        private readonly ResponseInterface $response
    ) {}

    public function index(): ResponseInterface
    {
        return $response->withStatus(200)->write('Hello World!');
    }
}

With these simple steps, you have successfully integrated the RadiantPHP ServerRequestFactory into your index.php file, allowing you to handle incoming HTTP requests and send appropriate responses in your PHP application.