Phingistrano 技术文档

本文档旨在帮助用户安装、使用和理解 Phingistrano 项目，以下为项目的安装指南、使用说明以及 API 使用文档。

1. 安装指南

Git 安装

安装 Git 作为版本控制系统：

sudo apt-get install git

Phing 安装

安装 Phing 作为构建工具：

sudo pear channel-discover pear.phing.info
sudo pear install phing/phing

PHP Codesniffer 安装

安装 PHP Codesniffer 用于代码规范检查：

sudo pear install PHP_CodeSniffer-1.3.0a1

PHPUnit 安装

安装 PHPUnit 用于单元测试：

pear channel-discover pear.phpunit.de
pear channel-discover components.ez.no
pear channel-discover pear.symfony-project.com
pear install phpunit/PHPUnit

PHP Documentor 安装

安装 PHP Documentor 用于生成文档：

sudo pear install --alldeps PhpDocumentor

VersionControl_Git-alpha 安装

安装 VersionControl_Git-alpha 用于 Git 支持：

sudo pear install VersionControl_Git-alpha

Pear mail extension 安装

安装 Pear mail extension 用于邮件发送：

sudo pear install pear/Mail
sudo pear install pear/Mail_Mime

SSH2 PHP Extension 或 phpseclib 安装

安装 SSH2 PHP Extension 或 phpseclib 用于 SSH 支持：

# phpseclib 安装
sudo pear channel-discover phpseclib.sourceforge.net
sudo pear install phpseclib/Net_SSH2
sudo pear install phpseclib/Net_SFTP
sudo pear install phpseclib/Math_BigInteger
sudo pear install phpseclib/Crypt_Random
sudo pear install phpseclib/Crypt_Hash
sudo pear install phpseclib/Crypt_TripleDES
sudo pear install phpseclib/Crypt_RC4
sudo pear install phpseclib/Crypt_AES
sudo pear install phpseclib/Crypt_RSA

# SSH2 PHP Extension 安装
# 根据操作系统选择以下命令
# Ubuntu 10.10+
sudo apt-get install libssh2-1-dev
sudo apt-get install libssh2-php
# Fedora 13+ & RHEL 6+
sudo yum install libssh2-devel
sudo pecl install channel://pecl.php.net/ssh2-0.11.2

2. 项目的使用说明

将 Phingistrano 作为 git submodule 添加到项目中：

git submodule add [e-mail]:CodeMeme/Phingistrano.git vendor/Phingistrano
git submodule init

在项目根目录下创建 build.xml 文件，内容如下：

<?xml version="1.0" encoding="UTF-8"?>
<project name="myproject" default="help">
    <!-- Required properties -->
    <property name="phingistrano.dir"  value="${project.basedir}/vendor/Phingistrano" />
    <property name="build.target"      value=".build" />
</project>

根据需要添加其他必要的属性。

3. 项目 API 使用文档

Phingistrano 的 API 使用主要通过 Phing 任务来实现。具体使用方法请参考 Phing 官方文档和 Phingistrano 项目的模块说明。

4. 项目安装方式

项目安装方式通过 Git submodule 进行，具体命令如下：

git submodule add [e-mail]:CodeMeme/Phingistrano.git vendor/Phingistrano
git submodule init
git submodule update

以上为 Phingistrano 项目的安装指南和使用说明。