floknapp/faulancer

A collection of helpers to kickstart your project

, _(*1)

PHPDox Documentation

https://floknapp.github.io/faulancer/, _(*2)

Introduction

This repository provides default configuration files and a very basic directory structure to kickstart your project with the Faulancer Framework. This framework is maintained in my spare time with the goal to simplify every process and to provide you the possibility to understand the process behind every core functionality., _(*3)

This means that there are some techniques which are meanwhile considered 'deprecated' or not suitable for tests (wrong), but provides robust and reliable functionality. For example, the ServiceLocator- and Factory-Pattern. In my opinion there are many positive aspects: - really simple, understandable and fast - well proven technique over the past decade - it forces 'separation of concerns' automatically, _(*4)

Get started

Navigate to your preferred directory where the application should be installed and enter the following command into console:, _(*5)

user@machine> composer create-project floknapp/faulancer-kickstart path-to-your-directory/

If you already created the target directory, navigate to it and type:, _(*6)

user@machine> composer create-project floknapp/faulancer-kickstart .

Overview

Controllers

You can define controllers wherever you want. But i strongly suggest to stick with the current directory structure, which provides a simple yet clear overall view about the responsibilities., _(*7)

Services

Everything is a service. For better separation all services are located in the 'Service'-Folder. The services file- and classname should be suffixed with the term 'Service'., _(*8)

Note: Use services to get data from an API endpoint which logic should not be live within a controller., _(*9)

Naming example: RegistrationService, _(*10)

Factories

The managing ServiceLocator automatically searches for a 'Factory'-Folder within the 'Service'-Folder which is the home for Factories. These factories create the service and inject dependencies into the constructor., _(*11)

Note: Factories must have the same name as the service itself, but suffixed with the term 'Factory'., _(*12)

Naming example: RegistrationServiceFactory, _(*13)

Views

Views are highly flexible due to template inheritance. You can easily swap the parent layout within the content view. Just take a look at the files '/templates/layout.phtml' and '/templates/pages/index.phtml'. You may immediately understand what's going on., _(*14)

Note: In 'app.conf.php' there is the template root path defined without a trailing slash. So whenever you reference a template you write it as it would be an absolute path beginning from that directory. IMHO it prevents confusion if you got a few more templates there., _(*15)

Call example (within a controller): $this->render('/path/to/template.phtml), _(*16)

Routes

The route structure is pretty straightforward. You define an array with the name of the route as the key. The value holds (next to the basic options like 'path' and 'action') multiple route specific options like i18n-Keys for automatic language specific link generation or role names to permit only logged in users access to that site. Just take a look at the file 'routes.conf.php'., _(*17)

ORM and Entities

The Faulancer Framework is based on a third party library from Thomas Flori for simple and fast yet powerful database operations. For further informations and documentation please navigate to tflori/orm., _(*18)