What is this?

No, Clearbricks is not yet another framework. Clearbricks is not cool at all and does not even have a nice website. It won't make you smart neither have great ideas for you.

Clearbricks is only about code and efficiency, consider it as a toolbox. And please, do me a favor, don't call it a framework :-)

How do I use it?

Clearbricks is about "using what we need when we need it". Pick the module(s) you need and add it to your code. The only thing you'll always need is the "common" directory.

Once you're ready, you have to create a _common.php file on top of your Clearbricks path (or wherever you want) and add $__autoload entries for your modules.

Take a look at the _common.php file.

Of course, you're encouraged to use the $__autoload magic for your own classes.

Use it with Mercurial

You may think that all this subdirectories is a mess. You're quite right. But one day, you'll find it cool to use Clearbricks modules in your mercurial repository as a subrepository. This day, you'll love me :-)

Here is an example of using Clearbricks and dbLayer in your own repository as an external property, using subrepositories documentation:

hg clone path/to/clearbricks
echo 'path/to/clearbricks' >> .hgsub

Save and push.

Then, you can create a _common.php file wich will contain:

require dirname(__FILE__).'/common/_main.php';
$__autoload['dbLayer'] = dirname(__FILE__).'/dblayer/dblayer.php';

You're done!

API documentation

A doxygen configuration file is provided to generate the Clearbricks API documentation which will be readable in doxygen folder:

$ doxygen .doxygen.conf


Clearbricks classes are tested using atoum. To run tests,

Clone this repository:

hg clone path/to/clearbricks

Download the composer.phar executable or use the installer.

curl -sS | php

Update dependencies via composer:

composer.phar install

And now can run tests:


Add -ebpc option to enable path and branch coverage (this option requires xDebug 2.3+)

You can also get code coverage report (in coverage/html) for tests by runing:

./bin/atoum -c .atoum.coverage.php