chubbyphp Goto Github PK

Name: chubbyphp

Type: Organization

Bio: Easy to use components for building API and/or web applications with chubbyphp-framework, mezzio (former expressive), slim and others.

petstore

Description

A simple skeleton to build api's based on the chubbyphp-framework.

Requirements

php: ^8.1
chubbyphp/chubbyphp-clean-directories: ^1.3.1
chubbyphp/chubbyphp-cors: ^1.5
chubbyphp/chubbyphp-decode-encode: ^1.1
chubbyphp/chubbyphp-framework: ^5.1.1
chubbyphp/chubbyphp-framework-router-fastroute: ^2.1
chubbyphp/chubbyphp-http-exception: ^1.1
chubbyphp/chubbyphp-laminas-config: ^1.4
chubbyphp/chubbyphp-laminas-config-doctrine: ^2.2
chubbyphp/chubbyphp-laminas-config-factory: ^1.3
chubbyphp/chubbyphp-negotiation: ^2.0
chubbyphp/chubbyphp-parsing: ^1.1.1
doctrine/orm: ^2.17.2
monolog/monolog: ^3.5
ramsey/uuid: ^4.7.5
slim/psr7: ^1.6.1
symfony/console: ^6.4.2

Environment

Add the following environment variable to your system, for example within ~/.bash_aliases:

export USER_ID=$(id -u)
export GROUP_ID=$(id -g)

Docker

docker-compose up -d
docker-compose exec php bash

Urls

GET https://localhost/ping
GET https://localhost/swagger (https://localhost/openapi)

Pet

DBs

jdbc:postgresql://localhost:5432/petstore?user=root&password=root

Installation

Through Composer as chubbyphp/petstore.

composer create-project chubbyphp/petstore myproject "dev-chubbyphp"

Setup

composer setup:dev

Structure

Collection

Collections are sortable, filterable paginated lists of models.

App\Collection

Dto

A DTO, or Data Transfer Object, is a simple object used to transport data between software application components.

App\Dto

Middleware

Middleware functions can execute code, make changes to the request and response objects. Middleware can generally be added globally or on a per-route basis.

App\Middleware

Model

Models, entities, documents what ever fits your purpose the best.

App\Model

ORM

ORM Mapping definitions.

App\ORM

Parsing

Parses and validates data against predefined schemas, ensuring that incoming data conforms to expected structures and criteria.

App\Parsing

Repository

Repositories get data from storages like databases, elasticsearch, redis or whereever your models are stored or cached.

App\Repository

RequestHandler

RequestHandler alias Controller, or Controller actions to be more precise. There is a directory with generic crud controllers. If you like the idea adapt them for your generic use case, if not drop them. I highly recommend to not extend them.

App\RequestHandler

ServiceFactory

Service factories are the glue code of the dependeny injection container.

App\ServiceFactory

Copyright

2024 Dominik Zogg

chubbyphp's Projects

chubbyphp-api-http

A simple http handler implementation for API.

chubbyphp-clean-directories

A command to clean directories based on directoryName => directoryPath mapping.

chubbyphp-container

A minimal Dependency Injection Container (DIC) which implements PSR-11.

chubbyphp-cors

A minimal CORS middleware for PSR 15.

chubbyphp-decode-encode

Chubbyphp decode/encode json/jsonx/url-encoded/xml/yaml

chubbyphp-deserialization

A simple deserialization.

chubbyphp-dev-helper

A dev helper which provides coding standards and quality settings.

chubbyphp-framework

A minimal, highly performant middleware PSR-15 microframework built with as little complexity as possible, aimed primarily at those developers who want to understand all the vendors they use.

chubbyphp-framework-router-fastroute

Fastroute Router implementation for chubbyphp-framework.

chubbyphp-framework-router-symfony

Symfony Router implementation for chubbyphp-framework.

chubbyphp-framework-skeleton

A minimal skeleton to start with a minimal php project.

chubbyphp-http-exception

Creates http exceptions which can be catched and converted to error responses.

chubbyphp-laminas-config

Chubbyphp container adapter using laminas service manager configuration.

chubbyphp-laminas-config-doctrine

Doctrine service factories for the laminas/laminas-servicemanager and any other dependency injection container who's been able to handle it's config, like chubbyphp/chubbyphp-container via chubbyphp/chubbyphp-laminas-config and many (Aura.Di, Pimple, Auryn, Symfony, PHP-DI) more.

chubbyphp-laminas-config-factory

An abstract service factory for the laminas/laminas-servicemanager and any other dependency injection container who's been able to handle it's config, like chubbyphp/chubbyphp-container via chubbyphp/chubbyphp-laminas-config and many (Aura.Di, Pimple, Auryn, Symfony, PHP-DI) more.