Documentation

Config

Here you can find an array for Parameters to Replace & an array for Replaceable Parameters !

Parameters to Replace

DB_HOST

localhost

DB_NAME

database_name

DB_USER

database_username

DB_PASS

database_user_password

MAIL_HOST

mail.host.com

MAIL_PORT

000

MAIL_FROM

mail@host.com

MAIL_PASSWORD

mail-user-password

MAIL_TO

mail@host.com

MAIL_USERNAME

mail-username

RECAPTCHA_TOKEN

website-token

VIEW_CACHE

false

Replaceable Parameters

ACCESS_KEY

access

ACCESS_DELIMITER

CTRL_PATH

App\Controller\\

CTRL_DEFAULT

Home

CTRL_NAME

Controller

CTRL_METHOD_DEFAULT

default

CTRL_METHOD_NAME

Method

DB_OPTIONS

array( PDO::ATTR_DEFAULT_FETCH_MODE => PDO::FETCH_ASSOC, PDO::ATTR_ERRMODE => PDO::ERRMODE_EXCEPTION )

MODEL_PATH

App\Model\\

MODEL_NAME

Model

VIEW_PATH

../src/View

1 - class PdoFactory

The PdoFactory class defines access to the database for SQL with PDO using the factory design pattern which creates objects without having to specify the exact class of the object which will be created

Namespace Pam\Model
Code Source

private static $pdo (@var PDO|null)

Usage

Use Pam\Model\PdoFactory

Available Methods

- public static function getPDO ( )
- The PdoFactory class defines access to the database for SQL with PDO using the factory design pattern which creates objects without having to specify the exact class of the object which will be created
- Return value = PDO

2 - class PdoDb

The PdoDb class defines the public methods for handling database query procedures ; if you want to customize a request : call the PdoDb method you need by providing the request, and arguments if necessary

Namespace Pam\Model
Constructor Parameters : PDO $pdo
Code Source

private $pdo (@var PDO)

Usage

Use Pam\Model\PdoDb

Available Methods

- public function getData ( PDO $pdo )
- The PdoDb class defines the public methods for handling database query procedures ; if you want to customize a request : call the PdoDb method you need by providing the request, and arguments if necessary
- Return value = mixed
- public function getAllData ( PDO $pdo )
- The PdoDb class defines the public methods for handling database query procedures ; if you want to customize a request : call the PdoDb method you need by providing the request, and arguments if necessary
- Return value = array|mixed
- public function setData ( PDO $pdo )
- The PdoDb class defines the public methods for handling database query procedures ; if you want to customize a request : call the PdoDb method you need by providing the request, and arguments if necessary
- Return value = bool|mixed

3 - class ModelFactory

The ModelFactory class defines access to the current model & his own database access by calling PdoFactory & using the factory design pattern which creates objects without having to specify the exact class of the object which will be created

Namespace Pam\Model
Code Source

private static $models (@var array)

Usage

Use Pam\Model\ModelFactory

Available Methods

- public static function getModel ( )
- The ModelFactory class defines access to the current model & his own database access by calling PdoFactory & using the factory design pattern which creates objects without having to specify the exact class of the object which will be created
- Return value = array

4 - abstract class MainModel

The MainModel abstract class defines the common public methods for querying the database, therefore the listing of a table & its CRUD (Create - Read - Update - Delete) ; this class must be inherited by each model of the projects

Namespace Pam\Model
Constructor Parameters : PdoDb $database
Code Source

protected $database (@var PdoDb)

protected $table (@var string)

Usage

Use Pam\Model\MainModel

You can access the value of type PdoDb from the protected property $database !

You can access the value of type string from the protected property $table !

Available Methods

- public function listData ( PdoDb $database )
- The MainModel abstract class defines the common public methods for querying the database, therefore the listing of a table & its CRUD (Create - Read - Update - Delete) ; this class must be inherited by each model of the projects
- Return value = array|mixed
- public function createData ( PdoDb $database )
- The MainModel abstract class defines the common public methods for querying the database, therefore the listing of a table & its CRUD (Create - Read - Update - Delete) ; this class must be inherited by each model of the projects
- public function readData ( PdoDb $database )
- The MainModel abstract class defines the common public methods for querying the database, therefore the listing of a table & its CRUD (Create - Read - Update - Delete) ; this class must be inherited by each model of the projects
- Return value = array|mixed
- public function updateData ( PdoDb $database )
- The MainModel abstract class defines the common public methods for querying the database, therefore the listing of a table & its CRUD (Create - Read - Update - Delete) ; this class must be inherited by each model of the projects
- public function deleteData ( PdoDb $database )
- The MainModel abstract class defines the common public methods for querying the database, therefore the listing of a table & its CRUD (Create - Read - Update - Delete) ; this class must be inherited by each model of the projects

View

5 - class TwigExtension

The MainExtension class defines the common functions accessible with Twig, like url() or redirect()

Namespace Pam\View
Extends AbstractExtension
Code Source

private $alert (@var array)

private $get (@var array)

private $session (@var array)

private $user (@var array)

Usage

Use Pam\View\TwigExtension

Available Methods

- public function setSession ( )
- The MainExtension class defines the common functions accessible with Twig, like url() or redirect()
- public function redirect ( )
- The MainExtension class defines the common functions accessible with Twig, like url() or redirect()
- public function url ( )
- The MainExtension class defines the common functions accessible with Twig, like url() or redirect()
- Return value = string
- public function checkAdmin ( )
- The MainExtension class defines the common functions accessible with Twig, like url() or redirect()
- Return value = bool
- public function checkArray ( )
- The MainExtension class defines the common functions accessible with Twig, like url() or redirect()
- Return value = bool
- public function checkUser ( )
- The MainExtension class defines the common functions accessible with Twig, like url() or redirect()
- Return value = bool
- public function getAlert ( )
- The MainExtension class defines the common functions accessible with Twig, like url() or redirect()
- public function getGet ( )
- The MainExtension class defines the common functions accessible with Twig, like url() or redirect()
- public function getSession ( )
- The MainExtension class defines the common functions accessible with Twig, like url() or redirect()
- Return value = mixed
- public function getString ( )
- The MainExtension class defines the common functions accessible with Twig, like url() or redirect()
- Return value = string

Controller

6 - FrontController
7 - GlobalsController
8 - ServiceController
9 - MainController

6 - class FrontController

The FrontController class defines the private methods to handle all requests for the projects

Namespace Pam\Controller
Code Source

private $controller (@var string)

private $method (@var string)

Usage

Use Pam\Controller\FrontController

Available Methods

- private function parseUrl ( )
- The FrontController class defines the private methods to handle all requests for the projects
- private function setController ( )
- The FrontController class defines the private methods to handle all requests for the projects
- private function setMethod ( )
- The FrontController class defines the private methods to handle all requests for the projects
- public function run ( )
- The FrontController class defines the private methods to handle all requests for the projects

7 - abstract class GlobalsController

The GlobalsController class defines the getters to access PHP SuperGlobals : $ _COOKIE, $ _ENV, $ _FILES, $ _GET, $ _POST, $ _REQUEST, $ _SERVER & $ _SESSION

Namespace Pam\Controller
Code Source

private $cookie (@var array)

private $env (@var array)

private $files (@var array)

private $file (@var array)

private $get (@var array)

private $post (@var array)

private $request (@var array)

private $server (@var array)

private $session (@var array)

private $alert (@var array)

private $user (@var array)

Usage

Use Pam\Controller\GlobalsController

Available Methods

- protected function setCookie ( )
- The GlobalsController class defines the getters to access PHP SuperGlobals : $ _COOKIE, $ _ENV, $ _FILES, $ _GET, $ _POST, $ _REQUEST, $ _SERVER & $ _SESSION
- Return value = mixed|void
- protected function setSession ( )
- The GlobalsController class defines the getters to access PHP SuperGlobals : $ _COOKIE, $ _ENV, $ _FILES, $ _GET, $ _POST, $ _REQUEST, $ _SERVER & $ _SESSION
- protected function checkUser ( )
- The GlobalsController class defines the getters to access PHP SuperGlobals : $ _COOKIE, $ _ENV, $ _FILES, $ _GET, $ _POST, $ _REQUEST, $ _SERVER & $ _SESSION
- Return value = bool
- protected function getAlert ( )
- The GlobalsController class defines the getters to access PHP SuperGlobals : $ _COOKIE, $ _ENV, $ _FILES, $ _GET, $ _POST, $ _REQUEST, $ _SERVER & $ _SESSION
- protected function getCookie ( )
- The GlobalsController class defines the getters to access PHP SuperGlobals : $ _COOKIE, $ _ENV, $ _FILES, $ _GET, $ _POST, $ _REQUEST, $ _SERVER & $ _SESSION
- Return value = mixed
- protected function getEnv ( )
- The GlobalsController class defines the getters to access PHP SuperGlobals : $ _COOKIE, $ _ENV, $ _FILES, $ _GET, $ _POST, $ _REQUEST, $ _SERVER & $ _SESSION
- Return value = mixed
- protected function getFiles ( )
- The GlobalsController class defines the getters to access PHP SuperGlobals : $ _COOKIE, $ _ENV, $ _FILES, $ _GET, $ _POST, $ _REQUEST, $ _SERVER & $ _SESSION
- Return value = mixed
- protected function getGet ( )
- The GlobalsController class defines the getters to access PHP SuperGlobals : $ _COOKIE, $ _ENV, $ _FILES, $ _GET, $ _POST, $ _REQUEST, $ _SERVER & $ _SESSION
- Return value = mixed
- protected function getPost ( )
- The GlobalsController class defines the getters to access PHP SuperGlobals : $ _COOKIE, $ _ENV, $ _FILES, $ _GET, $ _POST, $ _REQUEST, $ _SERVER & $ _SESSION
- Return value = mixed
- protected function getRequest ( )
- The GlobalsController class defines the getters to access PHP SuperGlobals : $ _COOKIE, $ _ENV, $ _FILES, $ _GET, $ _POST, $ _REQUEST, $ _SERVER & $ _SESSION
- Return value = mixed
- protected function getServer ( )
- The GlobalsController class defines the getters to access PHP SuperGlobals : $ _COOKIE, $ _ENV, $ _FILES, $ _GET, $ _POST, $ _REQUEST, $ _SERVER & $ _SESSION
- Return value = mixed
- protected function getSession ( )
- The GlobalsController class defines the getters to access PHP SuperGlobals : $ _COOKIE, $ _ENV, $ _FILES, $ _GET, $ _POST, $ _REQUEST, $ _SERVER & $ _SESSION
- Return value = array
- protected function destroyGlobal ( )
- The GlobalsController class defines the getters to access PHP SuperGlobals : $ _COOKIE, $ _ENV, $ _FILES, $ _GET, $ _POST, $ _REQUEST, $ _SERVER & $ _SESSION

8 - abstract class ServiceController

The ServiceController class defines the getters to access services : Array, Curl, Image, Mail, Security & String

Namespace Pam\Controller
Extends GlobalsController
Code Source

Usage

Use Pam\Controller\ServiceController

Available Methods

- protected function getApiData ( )
- The ServiceController class defines the getters to access services : Array, Curl, Image, Mail, Security & String
- Return value = mixed
- protected function getFilename ( )
- The ServiceController class defines the getters to access services : Array, Curl, Image, Mail, Security & String
- Return value = string
- protected function getUploadedFile ( )
- The ServiceController class defines the getters to access services : Array, Curl, Image, Mail, Security & String
- Return value = mixed|string
- protected function getConvertedImage ( )
- The ServiceController class defines the getters to access services : Array, Curl, Image, Mail, Security & String
- Return value = bool|string
- protected function getExtension ( )
- The ServiceController class defines the getters to access services : Array, Curl, Image, Mail, Security & String
- Return value = string
- protected function getImageType ( )
- The ServiceController class defines the getters to access services : Array, Curl, Image, Mail, Security & String
- Return value = bool|false|int
- protected function getInputImage ( )
- The ServiceController class defines the getters to access services : Array, Curl, Image, Mail, Security & String
- Return value = false|resource|string
- protected function getOutputImage ( )
- The ServiceController class defines the getters to access services : Array, Curl, Image, Mail, Security & String
- Return value = bool
- protected function getThumbnail ( )
- The ServiceController class defines the getters to access services : Array, Curl, Image, Mail, Security & String
- Return value = bool|string
- protected function sendMail ( )
- The ServiceController class defines the getters to access services : Array, Curl, Image, Mail, Security & String
- Return value = int

9 - abstract class MainController

The MainController abstract class defines configuration of Twig template engine with its extensions & protected methods to manage redirection & rendering

Namespace Pam\Controller
Extends ServiceController
Code Source

protected $twig (@var Environment)

Usage

Use Pam\Controller\MainController

You can access the value of type Environment from the protected property $twig !

Available Methods

- protected function checkArray ( )
- The MainController abstract class defines configuration of Twig template engine with its extensions & protected methods to manage redirection & rendering
- Return value = bool
- protected function getArrayElements ( )
- The MainController abstract class defines configuration of Twig template engine with its extensions & protected methods to manage redirection & rendering
- Return value = array $elements
- protected function redirect ( )
- The MainController abstract class defines configuration of Twig template engine with its extensions & protected methods to manage redirection & rendering
- protected function url ( )
- The MainController abstract class defines configuration of Twig template engine with its extensions & protected methods to manage redirection & rendering
- Return value = string
- protected function render ( )
- The MainController abstract class defines configuration of Twig template engine with its extensions & protected methods to manage redirection & rendering
- Return value = string
- protected function checkAdmin ( )
- The MainController abstract class defines configuration of Twig template engine with its extensions & protected methods to manage redirection & rendering
- Return value = bool
- protected function checkRecaptcha ( )
- The MainController abstract class defines configuration of Twig template engine with its extensions & protected methods to manage redirection & rendering
- Return value = bool
- protected function getString ( )
- The MainController abstract class defines configuration of Twig template engine with its extensions & protected methods to manage redirection & rendering
- Return value = string
- private function getStringCase ( )
- The MainController abstract class defines configuration of Twig template engine with its extensions & protected methods to manage redirection & rendering