Download the PHP package dotclear/clearbricks without Composer
On this page you can find all versions of the php package dotclear/clearbricks. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download dotclear/clearbricks
More information about dotclear/clearbricks
Files in dotclear/clearbricks
Package clearbricks
Short Description Clearbricks is not yet another framework.
License GPL-2.0-only
Informations about the package clearbricks
Clearbricks
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.
Requirements
In order to use Clearbricks you need:
- PHP 7.4 with the following modules:
- mbstring
- iconv
- simplexml
- json
API documentation
A doxygen configuration file is provided to generate the Clearbricks API documentation which will be readable in doxygen folder:
Tests
Clearbricks classes are tested using atoum (see doc). To run tests,
Clone this repository:
Download the composer.phar
executable or use the installer.
You may also install composer with:
Update dependencies via composer:
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:
For PHP static analysis, run:
License
Copyright Olivier Meunier & Association Dotclear
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.