Pionia Core

Pionia

Table of Contents

Classes

AuthBackend

Code generator for creating Authentication Backends

CodeGenerator

Base for all code generators in Pionia

Middleware

Code generator for creating middleware files in pionia

Service

Code generator for creating new services in Pionia

BaseCommand

This is the base command class, it extends the Symfony console command class and provides some helper methods that can be used in all commands. All commands should extend this class.

CommandInterface

This is the command interface, it is the entry point for all commands in the framework

CreateAuthenticationBackend

For Creating a new service

CreateMiddleware

For Creating a new service

CreateService

For Creating a new service

StartServer

For starting the command line server. This should be good choice only in development

ConsoleApplication

This is the main console application class, it extends the Symfony console application class

BaseApiController

This is the base controller class for the framework and most probably the only controller class that should be extended.

BaseApiServiceSwitch

This is the base class for the API service switch. It is used to switch between different services based on the request data.

CoreKernel

This is the core kernel that handles all the request processing and middleware execution

Sessions

This class is responsible for handling all session related operations

ContextUserObject

This is the context object holding the current session

SupportedHttpMethods

This class holds the supported http methods in the framework.

Utilities

These are just helpers to quickly get staff done

BaseAuthenticationBackend

This is the base class for all authentication backends.

BaseMiddleware

Middleware can run on every request and every response.

Pionia

This is the base class for the framework

BaseRoute

This is the base route class, it extends the Symfony route class and is used to define routes in the framework

BaseRoutes

This is the base routes class, it extends the Symfony route collection class and is used to define routes in the framework

PioniaRouter

This is the basis for defining routes in the application.

Connection

BaseException

This is the base exception class that all other exceptions must extend.

CommandException

This exception is thrown when a cli command fails.

ControllerException

This exception is thrown controller parsing fails in anyway

DatabaseException

This exception is thrown when an error occurs during database connection establishment.

FailedRequiredException

This exception is thrown when a required field is not provided in the request

InvalidDataException

This exception is thrown when a regular expression fails and we are in the exceptions mode.

LimitPaginationException

This exception is thrown when a limit is provided in a paginated query using the Pagination class

OffsetPaginationException

This exception is thrown when an offset is passed in a paginated query using the Pagination class

ResourceNotFoundException

This exception is thrown when a service requested is not found.

RestParseException

This exception is thrown when an error occurs during REST parsing.

RestPHPException

This exception is thrown when an error occurs during REST parsing.

UserUnauthenticatedException

This exception is thrown when one tries to access a protected resource without being authenticated

UserUnauthorizedException

This exception is thrown when a user is not authorized to access a resource

GenericService

This is the main class all other services must extend.

RetrieveCreateUpdateService

Adds retrieve, create and update actions to the service.

RetrieveListCreateService

Adds the retrieve and create actions to the service.

RetrieveListCreateUpdateDeleteService

Adds the retrieve, create and update actions to the service.

RetrieveListDeleteService

Adds the delete and retrieve actions to the service.

RetrieveListRandomService

Adds the retrieve and create actions to the service.

RetrieveListUpdateDeleteService

Adds the retrieve, update and delete actions to the service.

RetrieveListUpdateService

Adds the retrieve and update actions to the service.

UniversalGenericService

Adds the retrieve/details, create, list, update, random and delete actions to the service.

PioniaLogger

BaseRestService

This is the main class all other services must extend.

PaginationCore

Request

This method extends the Symfony request class to add more functionality to the request object.

BaseResponse

This provides a uniform response format for our entire application.

Response

This is the internal response. It should not be used anywhere in the project but in the core framework

ContextAwareTestCase

Provides a context aware test suite.

ContextFreeTestCase

This is for testing small chunk of your codebase.

Validator

This is the base class for the framework

ValidatorTest

This is for testing small chunk of your codebase.

Traits

CrudContract

EventsContract

CreateMixin

This mixin adds the create functionality to the service.

DeleteMixin

This mixin adds the delete functionality to the service.

ListMixin

This mixin adds the list functionality to the service.

RandomMixin

This mixin adds the random functionality to the service.

RetrieveMixin

This mixin adds the retrieve method to the class that uses it.

UpdateMixin

This mixin adds the update functionality to the service.

AuthTrait

This trait provides common authentication methods for the services

RequestActionTrait

Provides helper methods for request actions

ValidationTrait

Constants

BASEPATH  = __DIR__

BASEPATH  = __DIR__ . '/../../'

BASEPATH  = __DIR__ . '/../../'

logger  = \Pionia\Logging\PioniaLogger::init()

logger  = \Pionia\Logging\PioniaLogger::init()

logger  = PioniaLogger::init()

logger  = \Pionia\Logging\PioniaLogger::init()

SETTINGS  = __DIR__ . '/settings.ini'

SETTINGS  = BASEPATH . 'settings.ini'

SETTINGS  = BASEPATH . 'settings.ini'

Functions

exception_handler()  : void