lessphp 技术文档

1. 安装指南

1.1 环境要求

• PHP 5.3 或更高版本

1.2 安装步骤

1. 下载 lessphp 项目文件。
2. 将 lessc.inc.php 文件复制到你的项目目录中。

2. 项目的使用说明

2.1 在 PHP 项目中使用

2.1.1 基本用法

首先，在你的 PHP 文件中引入 lessc.inc.php 文件：

require "lessc.inc.php";

然后，创建 lessc 实例并编译 LESS 代码：

$less = new lessc;
echo $less->compile(".block { padding: 3 + 4px }");

2.1.2 编译文件

你可以使用 compileFile 方法来编译一个 LESS 文件：

echo $less->compileFile("input.less");

2.1.3 检查并编译

使用 checkedCompile 方法可以检查输出文件是否存在或是否过期，只有在需要时才进行编译：

$less->checkedCompile("input.less", "output.css");

2.1.4 错误处理

如果编译过程中出现错误，会抛出异常：

try {
  $less->compile("invalid LESS } {");
} catch (exception $e) {
  echo "fatal error: " . $e->getMessage();
}

2.2 命令行使用

2.2.1 基本用法

你可以通过命令行工具 plessc 来编译 LESS 文件：

$ plessc input.less > output.css

2.2.2 直接编译 LESS 代码

使用 -r 标志可以直接编译 LESS 代码：

$ plessc -r "my less code here"

2.2.3 监视文件变化

使用 -w 标志可以监视文件变化并自动编译：

$ plessc -w input-file output-file

2.2.4 设置输出格式

使用 -f 标志可以设置输出格式，例如压缩输出：

$ plessc -f=compressed myfile.less

3. 项目API使用文档

3.1 lessc 类

3.1.1 compile($input)

• 描述: 编译输入的 LESS 代码字符串。
• 参数:
  • $input (string): 要编译的 LESS 代码。
• 返回值: 编译后的 CSS 代码。

3.1.2 compileFile($inputFile, $outputFile = null)

• 描述: 编译指定的 LESS 文件。
• 参数:
  • $inputFile (string): 输入的 LESS 文件路径。
  • $outputFile (string, 可选): 输出的 CSS 文件路径。
• 返回值: 编译后的 CSS 代码。

3.1.3 checkedCompile($inputFile, $outputFile)

• 描述: 检查输出文件是否存在或是否过期，只有在需要时才进行编译。
• 参数:
  • $inputFile (string): 输入的 LESS 文件路径。
  • $outputFile (string): 输出的 CSS 文件路径。
• 返回值: 无。

3.2 配置选项

• 输出格式: 可以通过 setFormatter 方法设置输出格式。
• 变量设置: 可以通过 setVariables 方法从 PHP 中设置 LESS 变量。
• 注释保留: 可以通过 setPreserveComments 方法控制注释的保留。
• 自定义函数: 可以通过 registerFunction 方法注册自定义函数。

4. 项目安装方式

4.1 手动安装

1. 下载 lessphp 项目文件。
2. 将 lessc.inc.php 文件复制到你的项目目录中。

4.2 使用 Composer 安装

1. 在 composer.json 文件中添加 lessphp 依赖：

{
  "require": {
    "leafo/lessphp": "v0.5.0"
  }
}

2. 运行 composer install 命令安装依赖。

通过以上步骤，你就可以在你的项目中使用 lessphp 来编译 LESS 代码了。