CarteBlanche - Documentation
The PHP MVC framework of Les Ateliers, simple, light-weight and easy to use for PHP developments.
CarteBlanche is a PHP framework constructed as an MVC application ready to work. It uses a core library of classes that are enough to make it work and allows to develop some extra features quickly in this environement.
bundles, some packages to execute a feature, that could be exported after development
as a standalone PHP package (if so) ; it also proposes a set of
tools, pretty simple
PHP classes, one per feature, to help building views.
The rendering is integrated in a ready-to-use (but very simple) global template coded in HTML5.
Installation & Usage
The package to install is carte-blanche/carte-blanche.
Once you have downloaded or cloned the package sources, the installation is quite simple. It requires Composer to install its dependencies. Please see the "Dependencies" section below for more informations about Composer, what it is and what it does.
put the whole CarteBlanche directory in your web-server files system ; you can download an archive at https://github.com/php-carteblanche/carteblanche/archive/master.tar.gz or clone GIT sources running in a command line terminal:
~$ git clone --recursive https://github.com/php-carteblanche/carteblanche path/to/CarteBlanche // or, if you have an old version of GIT without the 'recursive' option: ~$ git clone https://github.com/php-carteblanche/carteblanche path/to/CarteBlanche ~$ cd path/to/CarteBlanche ~$ git submodule update --init
go to the CarteBlanche root directory:
~$ cd path/to/CarteBlanche
install dependencies running the
~$ ./bin/build.sh install // or, if you need to configure Composer or PHP binaries to use: ~$ ./bin/build.sh -h
CarteBlanche is ready !
As in many other frameworks, the PHP and binary sources are separated from the assets, web
are stored in the
www/ sub-directory. All other files may NOT be web-accessible. The PHP
sources are mostly stored in the
To access the framework's controller from a web-browser, just load the
file from the
www/ directory of CarteBlanche. A development version of this controller is
predefined and accessible loading the
dev.php file instead of
A terminal controller is also defined, for command line usage only, you can access running:
~$ php bin/console
doc/ directory contents for documentations about configuration, structure and
Rules & Dependencies
To build a comprehensive and maintainable code, we try to follow the coding standards and naming rules most commonly in use:
Knowing that, all classes of the framework are named and organized in an architecture to follow the usage of the standard SplClassLoader.
As explained in the "Installation" section above, this package uses some other third-party packages to be compliant with the common standards of actual PHP development. In addition to Composer, required for its classic installation, CarteBlanche proposes a set of other external PHP packages used for development and a set of external assets packages used for the HTML5 rendering.
To install all PHP packages for development, just run:
~$ ./bin/build.sh --set=dev install // or, using Composer itself ~$ composer install --dev
A PHP documentation tool is available generating it with Sami. To build or re-build it, you will need to run Composer in development environment (just as shown above) and then run:
~$ ./bin/build.sh render-doc // or, using Sami itself ~$ php src/vendor/sami/sami/sami.php render config/vendor/sami.config.php
Author & License
CarteBlanche - PHP framework package
Copyleft 2013, Pierre Cassat and contributors
Licensed under the Apache 2.0 license.
Les Ateliers Pierrot - Paris, France
<www.ateliers-pierrot.fr> - firstname.lastname@example.org