CodeIgniter包管理器Sparks
CodeIgniter开发者非常期待能够拥有像gems或npm这样的包管理器帮助他们开发和共享一些类库，Sparks就是为了实现这个需求而诞生的，我们既可以从Sparks上寻找需要的类库，也可以把自己的代码打包后上传和他人分享。
设想你现在需要为你的应用添加一个用户验证Auth功能，你肯定想到社区中的某个成员已经为CI开发了这个功能，你在Sparks网站上搜素Auth，网站将列出许多关于用户验证的Spark，我们在其中选择Auth，在命令行中输入php tools\spark install -v2.0.5 Auth一切都是这么简单。
#1 设置
现在你已经迫不及待的使用Sparks了，在这之前我们需要为应用安装spark包管理器，也许将来的某一天，Sparks将继承到CI内核中，我们可以通过两种方式安装Sparks：
方式1. 通过Spark管理器(PHP-CLI命令行)
方式2. 不通过Spark管理器
方式1(推荐)：通过Spark管理器
这种方式需要你安装了PHP命令行工具(PHP-CLI)，如果没有你需要安装，Windows用户需要将php.exe所在路径添加到PATH环境变量中，如果你不想使用命令行，可以尝试方式2。
OSX和Linux用户快速指南
如果你使用OSX或Linux系统，可以通过以下方式快速安装：
1. 打开Shell，切换到应用程序所在目录；
2. 在命令行中输入以下内容 php -r "$(curl -fsSL http://getsparks.org/go-sparks)"
3. 按回车键，如果一切顺利，请继续浏览获取Sparks，否则请尝试一下典型安装指南。
典型安装
这种方式适合所有的操作系统：
1. 下载sparks包管理器：spark-manager.zip
2. 把下载的压缩包解压至应用程序根目录下的tools文件夹；
3. 确认在应用程序根目录有一个tools文件夹，tools文件夹内有一个sprk文件；
4. 下载Loader类扩展：http://getsparks.org/static/install/MY_Loader.php.txt
5. 把下载的Loader类文件放在application/core/MY_Loader.php
6. 如果一切顺利，请继续浏览获取Sparks
方式2：不通过Spark管理器
这种方式将允许你不通过PHP命令行使用CodeIgniter Sparks，这通常不太适合开发者使用。
1. 在文件管理器中打开应用程序根目录(默认是application和system文件夹所在目录)；
2. 新建一个文件夹命名为'sparks';
3. 创建新文件：application/core/MY_Loader.php
4. 复制http://getsparks.org/static/install/MY_Loader.php.txt的内容到上一步文件；
5. 确认在application/config/config.php中'subclass_prefix'设置为'MY_'；
6. 如果一切顺利，请继续浏览获取Sparks
#2 获取Sparks
以下将说明怎样通过Spark管理器或手动安装Spark。
通过Spark管理器安装
在这个例子中，我们将通过命令行安装'example-spark'这个包。
打开终端切换至应用程序根目录，OSX或Linux系统请输入：
php tools/spark install -v1.0.0 example-spark
windows系统请输入：
php tools\spark install -v1.0.0 example-spark
将会看到一下内容：
[ SPARK ] Retrieving spark detail from getsparks.org [ SPARK ] From Downtown! Retrieving spark from Mercurial repository at https://github.com/katzgrau/example-spark [ SPARK ] Installing spark [ SPARK ] Spark installed to ./sparks/example-spark/1.0.0 - You're on fire!
指定Spark的版本不是必须的，可以去掉-v1.0.0选项获取最新的版本。
这个Spark已经安装好了，可以在程序的控制器中测试：
$this->load->spark('example-spark/1.0.0'); # We always specify the full path from the spark folder $this->example_spark->printHello(); # echo's "Hello from the example spark!"
如果一切顺利，将在屏幕上显示一串字符：'Hello from the example spark!'
现在可以安装所有需要的Spark了，我们还可以在config/autoload.php指定需要自动加载的Spark:
$autoload['sparks'] = array('example-spark/1.0.0');
手动安装Spark
通过以下步骤可以不通过脚本就能安装Spark，这更适合开发者在共享主机上使用，因为没有办法使用PHP脚本。
1. 在Sparks网站上打开所需安装Spark的页面，作为例子，我们将使用example-spark http://getsparks.org/packages/example-spark/show
2. 找到需要安装的版本，大多数情况都将是列在最上的版本，也就是最新的版本；
3. 点击链接"Get example-spark-1.0.0.zip"下载该文件；
4. 把下载的zip文件解压至应用程序根目录的sparks文件夹下，并建立一个包含版本的目录；
5. 确认应该是这样的文件结构：
/application /system /sparks ..../example-spark ......../1.0.0
这样该Spark就已经被安装了，在程序中测试：
$this->load->spark('example-spark/1.0.0'); # Don't forget to add the version! $this->example_spark->printHello(); # echo's "Hello from the example spark!"
如果一切顺利，将在屏幕上显示一串字符：'Hello from the example spark!'
现在可以安装所有需要的Spark了，我们还可以在config/autoload.php指定需要自动加载的Spark:
$autoload['sparks'] = array('example-spark/1.0.0');
#3 制作Sparks
怎样贡献代码
GetSparks.org支持外部的代码托管，这意味着GetSparks不托管项目，项目的源码可以放在Github或者BitBucket，或者个人的git或者mercurial服务器，在GetSparks上注册一个Spark只需指定项目所在的源地址。
在这之后，通过指定代码库的某个tag在GetSparks上注册一个新的版本，比如在代码库中创建了'1.0.0'的tag，那么就在GetSparks添加'1.0.0'版本。
Spark的目录结构
每一个Spark都是spark目录下的一个包，所以安装之后，Spark的结构如下：
/sparks ..../example-spark ......../1.0.0
另一个Spark也许有更高级的功能，包含configs, helpers, libraries, models，假设名为'other-spark'，结构可能像这样：
/sparks ..../example-spark ......../1.0.0 ............/config ............/libraries ..../other-spark ......../2.1.0 ............/config ............/libraries ............/helpers ............/models
当在github或bitbucket上建立一个Spark项目的时候，首先需要做的是在项目根目录建立这样的结构：
......../config ......../libraries ......../helpers ......../models
为Spark项目起一个合适的名字，我们也许会在github上建立项目之前先在GetSpark注册一个Spark因为GetSparks项目的名字必须是唯一的。
写一个测试Spark
这一节中将创建一个简单的Spark从Twitter网站中为用户获取twitters。
1. 在sparks目录下建立'birdseed'文件夹，在该文件夹中建立'0.0.1'文件夹，也就是当前Spark的版本；
2. 在'0.0.1'文件夹建立'config'和'helper'文件夹；
3. 在'config'文件夹建立'birdseed.php'和'autoload.php'文件，需要注意的是配置文件的名字应该和Spark名保持一致；
4. 在0.0.1/config/birdseed.php文件中添加以下内容：
<?php # The base URL for API calls to twitter $config['twitter_api_base_url'] = 'http://api.twitter.com/1/';
5. 在'0.0.1/config/autoload.php'文件中添加以下内容：
<?php # Load the birdseed config when the spark is loaded $autoload['config'] = array('birdseed'); # Load the birdseed helper when the spark is loaded $autoload['helper'] = array('birdseed');
6. 在0.0.1/helpers/birdseed_helper.php'文件中添加以下内容：
<?php /** * This function grabs a user's tweets from twitter. It's not a * bad idea to cache the output of this call! * @param string $username The Twitter username to grab * @param int $n The number of tweets to pull down * @return array An array of tweets */ function birdseed_fetch($username, $n = 10) { $base_url = config_item('twitter_api_base_url'); $call_url = $base_url . 'statuses/user_timeline.json?screen_name=' . $username . '&count=' . $n; $tweets = json_decode(file_get_contents($call_url)); if($tweets === FALSE) { # We didn't get a valid response back. Maybe the innerwebs are down. return array(); } return $tweets; }
7. 新建0.0.1/spark.info文件，添加以下内容：
# This is the spark-sdk specification. It's in a magical format called YAML. # Use this format while developing your own sparks! # This is the spark name. This should be the registered name of the spark. # It is here for informational purposes only. name: birdseed # This is the current version of this spark. All sparks should be in # x.x.x format. Validation will fail otherwise. version: 0.0.1 # This is the version of CodeIgniter this spark is compatible up to. It should # be in x.x.x format compatibility: 2.0.2 # There are no dependencies now, but when there are, uncomment below. #dependencies: # some-spark-1: 1.0.0 # some-other-spark-2: 1.0.0
每个Spark都应包含'spark.info'文件，包含该Spark的一些信息譬如版本信息，版本号必须是以x.x.x的形式。
8. 现在测试这个Spark的功能，在CodeIgniter程序中添加以下代码：
$this->load->spark('birdseed/0.0.1'); # Grab _kennyk_'s tweets $tweets = birdseed_fetch('_kennyk_', 5); print_r($tweets);
贡献代码
现在我们已经写好了Spark，可以和其他人共享这些代码了，假设我们已经满足以下条件：
1. 在Github或BitBucket有一个帐号，或者有自己的可公共访问的git或mercurial服务器，如果没有请选择其中一个并注册帐号；
2. 知道怎样在托管网站上建立项目；
3. 知道什么是'Clone URL'并且怎样从项目中获取公开的Clone URL；
现在我们需要做的是：
1. 复制该Spark的文件(birdseed/0.0.1目录下的所有内容)到项目目录；
2. Spark SDK http://getsparks.org/packages/spark-sdk/versions/HEAD/show 不是必需的，但可以帮助我们在提交Spark之前验证；
3. 可以在Spark根目录下添加readme文件，预期是以markdown http://daringfireball.net/projects/markdown/syntax的格式。
4. 通过以下指令通过mercurial上传代码至代码库：
$ hg add . $ hg commit -m "My sweet new spark - first commit" $ hg push
或者通过git
$ git add . $ git commit -m "My sweet new spark - first commit" $ git push
5. 通过以下指令创建一个tag：
$ hg tag '0.0.1' $ hg commit -m "My neato releaso ;)" $ hg push
或者
$ git tag '0.0.1'
$ git push --tags
6. 如果在GetSparks.org网站还没有帐号，请注册并登陆；
7. 访问Spark贡献页面，添写该Spark的信息，在'Clone URL'一栏中填写代码库公共访问的URL，在Github中为'Read Only'Clone URL；
8. 在项目主页上有一个'Add a New Version'的表单，请填入在第5步中创建的版本号'0.0.1'并点击'Create from Tag'，这样Spark就已经注册完成了，但标记为'unverified'，几分钟之后，GetSparks将检查并验证上传的Spark;
9. 如果Spark没有问题，将会标记为'verified'，如果有一些错误(比如不合法的Clone URL)，版本号将被删除并将收到解释的邮件，这时需要修正这些错误并且在GetSparks上重新注册tag；
10. 一旦Spark被验证通过，版本信息和可下载的zip文件将显示在项目页面上，如果在应用程序中已经安装了Spark管理器，就可以通过以下指令安装了：
php tools\spark install [your-spark-name]
最佳实践：
1. 命名：需要为Spark起一个唯一的名字，这在缺少命名空间的PHP早期版本中很重要，如果在Spark使用了一个model处理用户，你可能倾向于使用'User'作为类名，但最好以Spark的名字最为前缀，比如'Birdseed_user'；另一点，GetSparks目前只支持字母、数字和下划线作为Spark的名字；
2. 文档：在Spark的根目录添加一个Readme文件，GetSparks将以markdown的格式解析，这和Github和BitBucket的Readme文件格式是兼容的；
3. 依赖文件：如果在Spark中使用了第三方类库，把它们放在Spark目录下的vendor文件夹，通过require_once包含这些文件；
4. 自动加载：Spark允许在config/autoload.php文件中加载任何需要的文件，但不要忘记CodeIgniter的设计哲学：只加载你需要的。
