|Classes of Jorge Cobis||>||PHP Bootstrap Helpers||>||README.md||>||Download|
BootHelp - PHP Helpers for Bootstrap
A simple set of classes to generate most of the Bootstrap's components without writing any HTML code, just PHP.
However, to get all of its powerful resources, usually you have to write a lot of HTML code, no matters if you want to use a simple component, like [Modal] for instance.
BootHelp (Bootstrap Helpers) is a set of classes that allows you to get all the power of Bootstrap's components with no need to write any HTML code (or at least a minimun amount of it).
Remember that BootHelp just generates HTML code acording Bootstrap specifications v3.3.4. To get running the code as you expected, you have to install all [Bootstrap requirements].
Setting up the environment
After download BooHelp, you have 2 ways to get your environment configured to use the classes:
[Composer] is the PHP's package manager and is the recommended way to get packages for your projects. It's also able to build automatically *autoloaders* if you wrote down your code using PSR-0 and/or PSR-4 standards, avoiding you headaches about everything related to loading classes.
BootHelp is built follows PSR-4 standard and comes with a specific file named composer.json that allows Composer to generate a file named autoload.php (beside others files of course). This files generated is the only one you need to include in your project to get all classes required by BootHelp loaded in memory:
Loading BootHelp classes by hand
Even if Composer it's the preferred method to generate the files needed to get all classes loaded, maybe you want to do the task by hand:
All BootHelp classes are under the namespace BootHelp. So, to use any class you need to use the Fully qualified class name. For example, to get a new instance of Modal class you need to use:
However, as your project grows up using fully qualified class names becomes annoying, so it's better to use PHP USE sentence:
How to use BootHelp classes:
You have 2 ways to use BootHelp: Using BootHelp abstract class and then call any of its methods.
The other way is to get an instance of the component you want to use.
Method 1 - Using BootHelp abstract class:
BootHelp abstract class exposes the following 17 abstract methods:
Method 2 - Using directly the component class:
BootHelp offers 17 classes that deal directly with Bootstrap components:
Besides the classes showed above, you can find 5 additionals classes with differents purposes:
To get an idea about how to use BootHelp classes, what parameters you have to provide, what classes you can use together, and somethings like that, there is a complete guide included, that you can load in your browser. The guide is located in Guide folder. Actually, when you download BootHelp you can open the file index.php in your browser to read all the information about the classes.
However, to get running the Guide, you need to download and install the following:
Then, uncompress the files above downloaded and carefully follows the steps show below:
Aditional css is required to use 'Font awesome'. You have to add a link to awesome.css:
You have to put the sentence above in index.php
BootHelp is not perfect!!!. It's been tested but maybe you can find some bugs, or maybe you can find many better ways to do the things. For that reason, there are some things to do:
By the way, I'm from Bolivarian Republic of Venezuela :-D
Feel free to contribute!!!. Welcome aboard!!!
0.4.0 (Tuesday, 12th May 2015)
0.3.2 (Friday, 1st May 2015)
0.3.1 (Monday, 20th April 2015)
0.3.0 (Thursday, 16th April 2015)
0.2.2 (Wednesday, 15th April 2015)
0.2.1 (Friday, 10th April 2015)
0.2.0 (Friday, 10th April 2015)
0.1.0 (Sunday, 21st September 2014)
Copyright (c) 2015 Jorge Cobis (<firstname.lastname@example.org>)
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.