atelierspierrot/library

The PHP library package of Les Ateliers Pierrot.

PHP Library

The PHP library package of Les Ateliers Pierrot, _(*1)

Presentation

This package is a set of PHP basic classes commonly used (in our work) to facilitate other developments. It contains some global classes to extend to start on a robuste base, some useful helpers for some methods often used etc. For a full review of what the library embeds, have a look at the src/Library/ directory contents., _(*2)

This package is based on our PHP Patterns package., _(*3)

Usage

First notes about standards

As for all our work, we try to follow the coding standards and naming rules most commonly in use:, _(*4)

• the PEAR coding standards
• the PHP Framework Interoperability Group standards.

Knowing that, all classes are named and organized in an architecture to allow the use of the standard SplClassLoader., _(*5)

The whole package is embedded in the Library namespace., _(*6)

In this README documentation, the key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119., _(*7)

Installation

You can use this package in your work in many ways. Note that it depends on the external package PHP Patterns., _(*8)

First, you can clone the GitHub repository and include it "as is" in your poject:, _(*9)

https://github.com/atelierspierrot/patterns
https://github.com/atelierspierrot/library

You can also download an archive from Github., _(*10)

Then, to use the package classes, you just need to register the Library AND the Patterns namespace directory using the SplClassLoader or any other custom autoloader (if required, a copy of the SplClassLoader is proposed in the package):, _(*11)

require_once '.../src/SplClassLoader.php';
$patternsLoader = new SplClassLoader('Patterns', '/path/to/patterns/package/src');
$patternsLoader->register();
$libraryLoader = new SplClassLoader('Library', '/path/to/package/src');
$libraryLoader->register();

If you are a Composer user, just add the package to your requirements in your composer.json:, _(*12)

"require": {
    ...
    "atelierspierrot/library": "dev-master"
}

The namespaces will be automatically added to the project Composer autoloader., _(*13)

Quick overview

HTTP Fundamental

The Library\HttpFundamental namespace defines a set of classes to handle a classic HTTP request/response protocol., _(*14)

Helpers

The Library\Helper namespace defines some classes commonly used following these rules:, _(*15)

• all methods are static,
• methods MUST NOT send error while calling them without the right arguments or with no argument at all.

Development

To install all PHP packages for development, just run:, _(*16)

~$ composer install --dev

A documentation can be generated with Sami running:, _(*17)

~$ php vendor/sami/sami/sami.php render sami.config.php

The latest version of this documentation is available online at http://docs.ateliers-pierrot.fr/library/., _(*18)

Author & License

PHP Library, _(*19)

http://github.com/atelierspierrot/library, _(*20)

Copyleft (ↄ) 2013-2016 Pierre Cassat and contributors, _(*21)

Licensed under the GPL Version 3 license., _(*22)

http://opensource.org/licenses/GPL-3.0, _(*23)

---

Les Ateliers Pierrot - Paris, France, _(*24)

www.ateliers-pierrot.fr - contact@ateliers-pierrot.fr, _(*25)