paneric/csr-console

v2.0.12 2020-11-01 01:28 UTC

Requires

• paneric/di-container: ^1.0
• psr/container: ^1.0
• symfony/console: ^5.0

Requires (Dev)

• phpspec/phpspec: ^6.2

MIT

• Tomasz Januszewicz

README

Controller, Service, Repository, Query, Aggregated Data Access Object, Data Access Object etc. classes generator.

Installation

(1) Install with composer:

$ composer install paneric/csr-console

(2) Copy app file from:

$ my-project/vendor/paneric/csr-console/bin/

(3) Paste to:

$ my-project/bin/

(4) Set scope value in app file as 'app':

#!/usr/bin/env php
<?php

$scope = 'app';
...

(5) Start creating your classes.

Data Access Layer

All DAL package classes

$ bin/app dal --mode=dal

Class name: Article
Module name: Article
psr-4: App
DB table field prefix: art
DAO attributes names: id,ref
DAO attributes types: int,string

Remarks:

• Class: class name. Must be entered with no suffix.

ADAO - Aggregated data access object

$ php bin/app dal --mode=adao

Class name: Article
Module name: Article
psr-4: App
Namespaces of aggregated DAOs: App\DAL\User\,App\DAL\Credential\
Types aggregated DAOs: UserDAO,CredentialDAO
Names of aggregated DAOs: userDAO,credentialDAO

Remarks:

• Class: class name. Must be entered without ADAO suffix.

DAO - Data access object

$ php bin/app dal --mode=dao

Class name: Article
Module name: Article
psr-4: App
DB table field prefix: art
DAO attributes names: id,ref
DAO attributes types: int,string

Remarks:

• Class: class name. Must be entered without DAO suffix.
• DB table field prefix: must be entered without _ suffix.

Repository

$  php bin/app dal --mode=rep

Class name: Article
Module name: Article
psr-4: App

Remarks:

• Class: class name. Must be entered without Repository suffix.

Query

$  php bin/app dal --mode=qry

Class name: Article
Module name: Article
psr-4: App

Remarks:

• Class: class name. Must be entered without Query suffix.

Gateway Layer

All Gateway Layer package classes

$ bin/app gtw --mode=gtw

Class name: Article
Module name: Article
psr-4: App

Remarks:

• Class: class name. Must be entered with no suffix.

Event

$ php bin/app gtw --mode=evt

Class name: Article
Module name: Article
psr-4: App

Remarks:

• Class: class name. Must be entered without Event suffix.

Listener Service

$ php bin/app gtw --mode=lst

Class name: Article
Module name: Article
psr-4: App

Remarks:

• Class: class name. Must be entered without ListenerService suffix.

Interfaces

All interfaces

$ bin/app ifc --mode=ifc

Class name: Article
Module name: Article
psr-4: App

Remarks:

• Class: class name. Must be entered with no suffix.

Repository Interface

$ bin/app ifc --mode=ifcr

Class name: Article
Module name: Article
psr-4: App

Remarks:

• Class: class name. Must be entered with no RepositoryInterface suffix.

Query Interface

$ bin/app ifc --mode=ifcq

Class name: Article
Module name: Article
psr-4: App

Remarks:

• Class: class name. Must be entered with no QueryInterface suffix.

Business Logic Layer

All BLL package classes

$ php bin/app bll --mode=bll

Class name: Article
Module name: Article
psr-4: App

Remarks:

• Class: class name. Must be entered with no suffix.

Controller

$ php bin/app bll --mode=ctrl

Class name: Article
Module name: Article
psr-4: App

Remarks:

• Class: class name. Must be entered without Controller suffix.

Service

$ php bin/app bll --mode=srv

Class name: Article
Module name: Article
psr-4: App

Remarks:

• Class: class name. Must be entered without Service suffix.

ShowOneByIdAction

$ php bin/app bll --mode=acro

Class name: Article
Module name: Article
psr-4: App

Remarks:

• Class: class name. Must be entered without GetOneByIdAction suffix.

ShowAllPaginatedAction

$ php bin/app bll --mode=acrap

Class name: Article
Module name: Article
psr-4: App

Remarks:

• Class: class name. Must be entered without GetAllPaginatedAction suffix.

AddAction

$ php bin/app bll --mode=acc

Class name: Article
Module name: Article
psr-4: App

Remarks:

• Class: class name. Must be entered without CreateAction suffix.

EditAction

$ php bin/app bll --mode=acu

Class name: Article
Module name: Article
psr-4: App

Remarks:

• Class: class name. Must be entered without UpdateAction suffix.

RemoveAction

$ php bin/app bll --mode=acd

Class name: Article
Module name: Article
psr-4: App

Remarks:

• Class: class name. Must be entered without DeleteAction suffix.

DTO

$ php bin/app bll --mode=dto

Class name: Article
Module name: Article
psr-4: App

Remarks:

• Class: class name. Must be entered without DTO suffix.

Handler

$ php bin/app bll --mode=hnd

Class name: Article
Module name: Article
psr-4: App

Remarks:

• Class: class name. Must be entered without Handler suffix.