ICanBoogie is a high-performance micro-framework. It is written with speed, flexibility and
lightness in mind. ICanBoogie doesn't try to be an all-in-one do-it-all solution but provides the
essential features to quickly and easily build web applications. It is easily extensible, and a
variety of packages are available to complement its features with rendering, views, routing,
operations, internationalization, translation, ActiveRecord, facets, mailer…
Together with Brickrouge and Patron,
ICanBoogie is one of the components that make the CMS Icybee. You might want
to check these projects too.
What does micro mean?
"Micro" means that the core features of ICanBoogie are kept to the essential, the core is simple
but greatly extensible. For instance, ICanBoogie won't force an ORM on you, although its
ActiveRecord implementation is pretty nice. In the
same fashion, its routing mechanisms are quite agnostic and let you use your very own
dispatcher if you want to.
Configuration and conventions
ICanBoogie and its components are usually very configurable and come with sensible defaults and a
few conventions. Configurations are usually located in "config" folders, while locale messages are
usually located in "locale" folders. Components configure themselves thanks to ICanBoogie's
Autoconfig feature, and won't require much of you other than a line in your
composer.json file.
Acknowledgement
MooTools, Ruby on Rails,
Yii, and of course Bacara.
Summary
- Working with ICanBoogie
- The life and death of your application
- Multi-site support
- Autoconfig
- Configuring the application
- Events
- Bindings
Routes
The package provides a controller for the /api/ping route, which may be used to renew a session,
if one existed in the first place. When the timer query parameter is present, the controller
gives timing information as well.
<?php
use ICanBoogie\HTTP\Request;
$request = Request::from('/api/ping?timer');
echo $request()->body;
// pong, in 4.875 ms (ready in 3.172 ms)
Helpers
The following helper functions are defined:
app(): Returns the Application instance, or throws ApplicationNotInstantiated if it has
not been instantiated yet.boot(): Instantiates a Application instance with the autoconfig and boots it.log(): Logs a debug message.log_success(): Logs a success message.log_error(): Logs an error message.log_info(): Logs an info message.log_time(): Logs a debug message associated with a timing information.
Requirements
The minimum requirement is PHP 5.6.
Installation
The recommended way to install this package is through Composer:
$ composer require icanboogie/icanboogie
Don't forget to modify the script section of your "composer.json" file if you want to benefit
from the autoconfig feature:
{
"scripts": {
"post-autoload-dump": "ICanBoogie\\Autoconfig\\Hooks::on_autoload_dump"
}
}
The following packages are required, you might want to check them out:
- icanboogie/common
- icanboogie/inflector
- icanboogie/datetime
- icanboogie/prototype
- icanboogie/event
- icanboogie/http
- icanboogie/routing
The following packages can also be installed for additional features:
- icanboogie/render: A rendering API.
- icanboogie/view: Adds views to controllers.
- icanboogie/activerecord: ActiveRecord Object-relational mapping.
- icanboogie/cldr: Provides internationalization for
your application. - icanboogie/i18n: Provides localization for your application
and additional internationalization helpers. - icanboogie/image: Provides image resizing, filling,
and color resolving. - icanboogie/module: Provides framework extensibility using modules.
- icanboogie/operation: Operation oriented controllers API.
The following bindings are available to help in integrating components:
Cloning the repository
The package is available on GitHub, its repository can be
cloned with the following command line:
$ git clone https://github.com/ICanBoogie/ICanBoogie.git
Documentation
The documentation for the package and its dependencies can be generated with the make doc
command. The documentation is generated in the docs directory using ApiGen.
The package directory can later by cleaned with the make clean command.
The documentation for the complete framework is also available online: https://icanboogie.org/docs/
Testing
The test suite is ran with the make test command. Composer is
automatically installed as well as all dependencies required to run the suite. You can later
clean the directory with the make clean command.
The package is continuously tested by Travis CI.
License
ICanBoogie is licensed under the New BSD License - See the LICENSE file for details.