README

Description

Help defining the API date format with time zone in your papi.

Also provide a DateService class to convert dates.

Prerequisites Modules

• Papimod/Dotenv

Configuration

DATE_FORMAT (.ENV)

DATE_TIME_FORMAT (.ENV)

DATE_TIMEZONE (.ENV)

Definitions

• (service) DateService

Usage

You can add the following options to your .env file:

DATE_FORMAT="Y-m-d"
DATE_TIME_FORMAT="H:i:s"
DATE_TIMEZONE="Europe/Paris"

Import the module when creating your application:

require __DIR__ . "/../vendor/autoload.php";

use Papi\PapiBuilder;
use Papimod\Dotenv\DotEnvModule;
use Papimod\Date\DateModule;
use function DI\create;

$builder = new PapiBuilder();

$builder->setModule(
        DotEnvModule::class,
        DateModule::class
    )
    ->build()
    ->run();

Use the dedicated service anywhere:

final class MyService
{
    public function __construct(public readonly DateService $date_service) 
    {
    }

    public getNow(): string
    {
        $now = new DateTime();
        return $this->date_service->format($now);
    }
}