basekit/site-construction-kit

此包已被废弃,不再维护。未建议替代包。
关于此包最新版本(1.0.3)没有可用的许可证信息。

BaseKit 网站构建套件。

1.0.3 2016-02-10 15:35 UTC

This package is not auto-updated.

Last update: 2023-05-04 07:35:25 UTC


README

BaseKit 网站构建套件(SiCK)是一套PHP类,让您构建BaseKit网站。

SiCK的目的是处理构建网站、页面和组件的实现细节,给您留下简单的语法。

安装

将此包包含到您的项目中的推荐方式是使用Composer。将其添加到项目composer.json文件的require部分。

"basekit/site-construction-kit": "dev-master"

使用

以下是一个快速构建网站、页面并添加一些组件的示例。

use BaseKit\Builder\SiteBuilder;

$site = new SiteBuilder;
$site->setBrandRef(123);
$site->setAccountHolderRef(456);
$site->mapDomain('example.com');

$page = $site->createPage('home', 'Home Page');

$page->addText('<h1>Hello World</h1>');
$page->addImage('http://placehold.it/200x200');

然后您可以实例化一个Writer类,该类负责实际构建您已构建的网站。

您通常会使用ApiWriter类。您提供BaseKit API客户端对象,它将使用此对象来构建网站。

use BaseKit\Api\Client;
use BaseKit\Builder\Writer\ApiWriter;

$apiClient = Client::factory(array(
    'base_url' => 'http://rest.basekit.com',
    'consumer_key' => 'YOUR OAUTH CONSUMER KEY',
    'consumer_secret' => 'YOUR OAUTH CONSUMER SECRET',
    'token' => 'YOUR OAUTH ACCESS TOKEN',
    'token_secret' => 'YOUR OAUTH ACCESS SECRET'
));

$writer = new ApiWriter;
$writer->setApiClient($apiClient);

$writer->writeSite($site);

贡献

此项目遵循PSR-2编码风格指南。检查您的贡献的正确性很容易。

$ make lint

有一个非常小的单元测试套件,使用PHPUnit。确保您没有破坏任何测试也很容易。

$ make test

许可证

本软件在MIT许可证下发布。