qcubed/plugin_bootstrap

QCubed wrappers for Twitter Bootstrap.

v1.0.2 2016-05-24 16:55 UTC

Requires

• php: >=5.4

MIT

• bootstrap
• qcubed

README

QCubed plugin to simplify the integration of Twitter Bootstrap

Installation

1. Install both the plugin and twitter bootstrap using Composer. Execute the following on the command line from your main install directory:

	composer require qcubed/plugin_bootstrap
	composer require twbs/bootstrap

1. Next, you might want to set up some configuration settings in your configuration.inc.php file.

BOOTSTRAP_CSS

The default setting for this file is:

	define ('__BOOTSTRAP_CSS__', __VENDOR_ASSETS__. '/twbs/bootstrap/dist/css/bootstrap.min.css');

If you are compiling your own custom version of the bootstrap css file, simply set that define to point to your own version.

1. Point the base class to Bootstrap classes so that they add their functionality.

In your project/includes/controls/QControl.class.php file, have your QControl inherit from the base class. For example, you should change the first line to:

abstract class QControl extends QCubed\Plugin\Bootstrap\Control {

BOOTSTRAP_JS

The default mechanism included in this plugin only loads the bootstrap.js file on forms using the plugin widgets that need it. If you are hand-coding some bootstrap forms that also need bootstrap.js, you should do both of the following to avoid multiple bootstrap.js files being loaded:

1. Define BOOTSTRAP_JS in your configuration.inc.php file and point it to your desired bootstrap js file as so:

	define ('__BOOTSTRAP_JS__', __VENDOR_ASSETS__ . '/twbs/bootstrap/dist/js/bootstrap.js'); (or bootstrap.min.js if you prefer)

1. Either add this file to your footer.inc.php file like this:

	<script type="text/javascript" src="<?php echo(__BOOTSTRAP_JS__); ?>"></script>

or add it to the list of auto-loaded javascript forms in your QForm.class.php file like this:

	protected function GetFormJavaScripts() {
		$scripts = parent::GetFormJavaScripts();
		$scripts[] = __BOOTSTRAP_JS__;
		return $scripts;
	}

Usage

See the examples pages for details. The main functionality includes:

1. Using RenderFormGroup instead of RenderWithName to draw form objects in the Bootstrap way. The Bootstrap Control class exposes a number of utility classes to add Bootstrap class to the object, the label, the wrapper, and even some internal wrappers in special situations.

2. Specific Bootstrap type QControls to draw particular things on the screen. Examples include:

• Carousel
• Navbar
• Menu button
• Alert
• Accordion

1. Extensions of base QCubed controls with additional Bootstrap functionality. Includes:

• Checkbox to draw checkboxes the bootstrap way with the label wrapping the checkbox
• TextBox to add the ability to draw it as an inline-group with another object

1. Defines that give you easy access to all the various Bootstrap class names via PHP constants. Those are located in the Bootstrap.php file.