Fork me on GitHub

BONZAI

Documentation

Disclaimer

Trademarks

All terms mentioned in this documentation that are known to be trademarks or service marks have been appropriately capitalized. The Bonzai Team cannot attest to the accuracy of this information. Use of a term in this documentation should not be regarded as affecting the validity of any trademark or service mark.

Notes and Disclaimer

Every effort has been made to make this documentation as complete and as accurate as possible, but no warranty or fitness is implied. The information provided is on an "as is" basis. The author and the publisher shall have neither liability nor responsibility to any person or entity with respect to any loss or damages arising from the information contained in this documentation.

Support

For all support questions please use drop us a mail to info@bonzai-project.org. For bug reports and issues is available the issue tracker. Changes between versions are described in the ChangeLog.

We are doing everything possible to make this documentation detailed and we are increasing the project's quality level. Your help is invaluable!

If you want to do more and to participate actively in the project you'll be welcome.

Requirements & Dependencies

System requirements:

The only one dependency is the PHP compiler bcompiler used to generate the bytecode.

Install

No install process is needed. You can simply download the source code and run as-is.

To install the application as system-binary simply launch the commad sudo make install.

Uninstall

To uninstall the application launch the command sudo make uninstall.

Configuration

No configuration is needed.

Usage

                --------------------------------------------------------------------------------
                BONZAI                                                         (was phpGuardian)
                --------------------------------------------------------------------------------
                Version: 0.2
                Copyright (C) 2006 - 2012 Bonzai (Fabio Cicerchia). All rights reserved.
                License MIT or GNU GPL 2
                --------------------------------------------------------------------------------

                Usage:
                ./bonzai-cli [OPTIONS]... [FILES|DIRECTORIES]...

                Options:
                -b, --backup         Backup the original file, generate a .bak file
                -d, --dry            Perform a trial run with no changes made
                -r, --report         Generate a full report
                    --colors         Use colors in output
                    --log=<value>    Log execution messages in textual format
                    --stderr         Write to STDERR instead of STDOUT
                -q, --quiet          Quiet mode. Don't output anything
                -h, --help           Show the help
                -v, --version        Show the version

                Report bugs to info@bonzai-project.org

Source-code

To obtain the most recent source-code you can visit our GitHub repository.
Or simply do git clone git://github.com/BonzaiProject/Bonzai.git.

Collaborate to Development

Coding Standard

We have adopted mostly the PEAR Coding Standard with a part of the Squiz Coding Standard.

All standards used are enclosed in a dedicated validation set PHP_CodeSniffer.

Configure the Development Environment

To be ready and fully operative on this project some software is required:

- Download Documentation
PHP 5.x Download Documentation
PHPUnit Download Documentation
Docblox Download Documentation
phploc Download Documentation
PHP Depend Download Documentation
PHP Mess Detector Download Documentation
PHP_CodeSniffer Download Documentation
PHP_CodeBrowser Download Documentation

Launch the commad sudo make install-environment to install the whole development-environment.

Translations

To translate the documentation you need create a new file from the docs/index.en.html and translating it in the file docs/index.[CODE].html where [CODE] is the two-letter language code.

To translate the script you need copy the file messages.pot in the file locales/[CODE]/LC_MESSAGES/messages.po (obviously the directory must be created before) where [CODE] is the extended code of the language (eg: en_US). Then you can use a tool to edit the file (eg: poEdit) or you can manually edit. Then generate the file messages.mo.

Authors