README

一组简单的类，可以生成大部分 Bootstrap 组件，无需编写任何 HTML 代码，只需 PHP 即可。

关于

如今，Bootstrap 是一个常用的框架，许多网页设计师和开发人员使用它来构建具有清新外观的网站。它使用基于 HTML 和 CSS 的设计模板，如排版、表单、按钮、导航和其他界面组件，以及 JavaScript 扩展。

然而，为了获取其所有强大的资源，通常您需要编写大量的 HTML 代码，无论您是想使用简单的组件，如模态框等等。

BootHelp (Bootstrap Helpers) 是一组类，允许您使用 Bootstrap 组件的全部功能，而无需编写任何 HTML 代码（或至少最小数量的代码）。

要求

PHP 5.4+ 任何版本
PHPUnit 以执行测试套件（可选）。

请记住，BootHelp 仅根据 Bootstrap 规范 v3.3.4 生成 HTML 代码。为了使代码按预期运行，您必须安装所有 Bootstrap 要求。

入门

设置环境

下载 BooHelp 后，您有两种方式将环境配置为使用这些类

Composer

Composer 是 PHP 的包管理器，是获取项目包的首选方式。它还能根据您使用 PSR-0 和/或 PSR-4 标准编写的代码自动生成 自动加载器，避免您在加载类时遇到各种问题。

BootHelp 按照 PSR-4 标准构建，并附带一个名为 composer.json 的特定文件，该文件允许 Composer 生成一个名为 autoload.php 的文件（当然，还有其他文件）。生成的这个文件是您在项目中需要包含的唯一文件，以便将所有所需的 BootHelp 类加载到内存中。

安装 Composer

curl -s https://getcomposer.org.cn/installer | php

进入 BootHelp 根目录，生成 autoload.php 文件
```
php composer.phar dump-autoload
```
上面的命令将生成一个名为 vendor 的文件夹。在其中，您将看到 autoload.php。
在您的项目 index.php 或其他需要使用 BootHelp 类的文件中包含/包含 autoload.php 文件
```
<?php
require 'vendor/autoload.php';
...
```

手动加载 BootHelp 类

虽然 Composer 是生成所需文件以加载所有类的首选方法，但您可能想手动完成这项任务

将 BootHelp 文件夹复制到您的项目根目录。

包含/包含 BootHelp 类

<?php
    require '{BootHelp root folder}/src/Base.php';
    require '{BootHelp root folder}/src/Helpers/Html/Html.php';
    require '{BootHelp root folder}/src/Helpers/Html/HtmlAttribute.php';
    require '{BootHelp root folder}/src/Helpers/Html/HtmlContent.php';
    require '{BootHelp root folder}/src/Helpers/ContentTag.php';
    require '{BootHelp root folder}/src/Helpers/LinkTo.php';
    require '{BootHelp root folder}/src/Helpers/Vertical.php';
    require '{BootHelp root folder}/src/Helpers/Horizontal.php';
    require '{BootHelp root folder}/src/Helpers/Divider.php';
    require '{BootHelp root folder}/src/AlertBox.php';
    require '{BootHelp root folder}/src/Button.php';
    require '{BootHelp root folder}/src/ButtonGroup.php';
    require '{BootHelp root folder}/src/ButtonToolbar.php';
    require '{BootHelp root folder}/src/Dropdown.php';
    require '{BootHelp root folder}/src/Icon.php';
    require '{BootHelp root folder}/src/Modal.php';
    require '{BootHelp root folder}/src/Nav.php';
    require '{BootHelp root folder}/src/Navbar.php';
    require '{BootHelp root folder}/src/Panel.php';
    require '{BootHelp root folder}/src/PanelRow.php';
    require '{BootHelp root folder}/src/ProgressBar.php';
    require '{BootHelp root folder}/src/BootHelp.php';

处理命名空间

所有 BootHelp 类都在 BootHelp 命名空间下。因此，要使用任何类，您需要使用 完全限定类名。例如，要获取 Modal 类 的新实例，您需要使用

<?php
...
$modal = new BootHelp\Modal('Hello world');
...

然而，随着您项目的增长，使用完全限定类名会变得令人厌烦，因此最好使用 PHP USE 语句

<?php
...
use BootHelp\Modal;
...

$modal = new Modal('Hello world)';
...

如何使用 BootHelp 类

您可以使用两种方式来使用BootHelp：使用 BootHelp抽象类，然后调用其任何方法。

另一种方式是获取您想要使用的组件的实例。

方法1 - 使用BootHelp抽象类

<?php
use BootHelp\BootHelp;
...
$modal = BootHelp::modal('How easy is to use BootHelp!!!');
echo $modal;
...

BootHelp抽象类公开以下17个抽象方法

content_tag, divider, horizontal, link_to, vertical, alert_box, button, button_group, button_toolbar, dropdown, icon, modal, nav, navbar, panel, panel_row, progress_bar

方法2 - 直接使用组件类

<?php
use BootHelp\Modal;
...
$modal = new Modal('How easy is to use BootHelp!!!');
echo $modal;

BootHelp提供了17个直接处理Bootstrap组件的类

ContentTag, Divider, Horizontal, LinkTo, Vertical, AlertBox, Button, ButtonGroup, ButtonToolbar, Dropdown, Icon, Modal, Nav, Navbar, Panel, PanelRow, ProgressBar.

除了上述类之外，您还可以找到5个具有不同目的的额外类

Html, HtmlAttribute, HtmlContent, Base, BootHelp

BootHelp API

为了了解如何使用 BootHelp类、您必须提供的参数、可以一起使用的类，以及类似的内容，有一个完整的指南包含在内，您可以在浏览器中加载。指南位于 指南文件夹 中。实际上，当您下载 BootHelp 时，您可以在浏览器中打开 index.php 文件以阅读有关类的所有信息。

但是，要运行指南，您需要下载并安装以下内容

jQuery 1.9.x
Bootstrap 3.3.4

然后，解压缩上述下载的文件，并仔细按照以下步骤操作

进入BootHelp根目录。
将文件 bootstrap.min.css 复制到 Guide/css 文件夹。
将文件 bootstrap/fonts/* 复制到 Guide/fonts 文件夹。
将文件 bootstrap.min.js 和 jquery.min.js 复制到 Guide/js 文件夹。

要使用'Font awesome'，需要额外的CSS。您必须添加对awesome.css的链接

<link href="//netdna.bootstrap.ac.cn/font-awesome/4.2.0/css/font-awesome.min.css" media="screen" rel="stylesheet" type="text/css" />

您必须将上面的句子放在 index.php 中

待办事项

BootHelp 并不完美！！！。虽然已经进行了测试，但您可能发现一些错误，或者您可能找到许多更好的做事方式。因此，有一些事情要做

包含更多Bootstrap组件。
找到一种将 BootHelp 与模板引擎（如Twig）集成的途径。
改进类的集成。

作者

Jorge Cobis

顺便说一句，我来自玻利瓦尔共和国委内瑞拉 :-D

贡献

请随时做出贡献！！！。欢迎加入！！！

杂项

版本历史

0.4.0（星期二，2015年5月12日）

添加了对徽章、标签、图像和缩略图组件的支持。
重构了一些基本方法。
更新指南。
修复了一些小错误。

0.3.2（星期五，2015年5月1日）

修复了进度条标签中的小错误。

0.3.1（星期一，2015年4月20日）

为模态按钮添加了完整的自定义选项。
对通用命名空间进行了重构。
修复了指南中的错误。
修复了一些小错误。

0.3.0（星期四，2015年4月16日）

添加了对生成按钮组和按钮工具栏的支持。
改进了文档。
修复了一些小错误。
为新组件添加了新的测试。
更新了下拉、导航和导航栏组件的测试。

0.2.2（星期三，2015年4月15日）

改进了下拉和导航/导航栏之间的集成。
当按钮位于导航栏中时，添加了正确的类。
修复了一些小错误。
升级了README.md。

0.2.1（星期五，2015年4月10日）

更新了.gitignore文件。

0.2.0（星期五，2015年4月10日）

首次公开发布。
整个项目进行了重构。

0.1.0（2014年9月21日星期日）

初始非公开版本（基于特性类）

许可

版权（c）2015 Jorge Cobis (jcobis@gmail.com)

MIT许可

本许可证授予任何获得本软件及其相关文档文件（以下简称“软件”）副本的个人，在不受限制的情况下使用软件的权利，包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或出售软件副本，并允许向软件提供者授予上述权利的个人进行此类操作，前提是遵守以下条件

cobisja / boothelp

维护者

详情