Ruler 项目技术文档

1. 安装指南

使用 Composer 安装

Ruler 可以通过 Composer 进行安装。首先，确保你已经安装了 Composer，然后在项目根目录下运行以下命令：

composer require ruler/ruler

手动安装

如果你不想使用 Composer，也可以手动下载 Ruler 的源码，并将其放置在你的项目目录中。然后，在你的 PHP 文件中引入 Ruler 的自动加载文件：

require 'path/to/ruler/autoload.php';

2. 项目的使用说明

基本使用

Ruler 是一个简单的无状态生产规则引擎，适用于 PHP 5.3 及以上版本。它提供了一个易于使用的 DSL（领域特定语言），帮助你快速创建和执行规则。

使用 RuleBuilder

$rb = new RuleBuilder;
$rule = $rb->create(
    $rb->logicalAnd(
        $rb['minNumPeople']->lessThanOrEqualTo($rb['actualNumPeople']),
        $rb['maxNumPeople']->greaterThanOrEqualTo($rb['actualNumPeople'])
    ),
    function() {
        echo 'YAY!';
    }
);

$context = new Context([
    'minNumPeople' => 5,
    'maxNumPeople' => 25,
    'actualNumPeople' => fn() => 6,
]);

$rule->execute($context); // "Yay!"

不使用 RuleBuilder

$actualNumPeople = new Variable('actualNumPeople');
$rule = new Rule(
    new Operator\LogicalAnd([
        new Operator\LessThanOrEqualTo(new Variable('minNumPeople'), $actualNumPeople),
        new Operator\GreaterThanOrEqualTo(new Variable('maxNumPeople'), $actualNumPeople)
    ]),
    function() {
        echo 'YAY!';
    }
);

$context = new Context([
    'minNumPeople' => 5,
    'maxNumPeople' => 25,
    'actualNumPeople' => fn() => 6,
]);

$rule->execute($context); // "Yay!"

3. 项目 API 使用文档

变量与命题

Ruler 提供了多种变量和命题，用于构建规则。以下是一些常用的变量和命题：

比较操作

$a = $rb['a'];
$b = $rb['b'];

$a->greaterThan($b);                      // true if $a > $b
$a->greaterThanOrEqualTo($b);             // true if $a >= $b
$a->lessThan($b);                         // true if $a < $b
$a->lessThanOrEqualTo($b);                // true if $a <= $b
$a->equalTo($b);                          // true if $a == $b
$a->notEqualTo($b);                       // true if $a != $b
$a->stringContains($b);                   // true if strpos($b, $a) !== false
$a->stringDoesNotContain($b);             // true if strpos($b, $a) === false
$a->stringContainsInsensitive($b);        // true if stripos($b, $a) !== false
$a->stringDoesNotContainInsensitive($b);  // true if stripos($b, $a) === false
$a->startsWith($b);                       // true if strpos($b, $a) === 0
$a->startsWithInsensitive($b);            // true if stripos($b, $a) === 0
$a->endsWith($b);                         // true if strpos($b, $a) === len($a) - len($b)
$a->endsWithInsensitive($b);              // true if stripos($b, $a) === len($a) - len($b)
$a->sameAs($b);                           // true if $a === $b
$a->notSameAs($b);                        // true if $a !== $b

数学操作

$c = $rb['c'];
$d = $rb['d'];

$c->add($d);          // $c + $d
$c->subtract($d);     // $c - $d
$c->multiply($d);     // $c * $d
$c->divide($d);       // $c / $d
$c->modulo($d);       // $c % $d
$c->exponentiate($d); // $c ** $d
$c->negate();         // -$c
$c->ceil();           // ceil($c)
$c->floor();          // floor($c)

规则组合

$aEqualsB = $rb->create($a->equalTo($b));
$aDoesNotEqualB = $rb->create($a->notEqualTo($b));

$eitherOne = $rb->create($rb->logicalOr($aEqualsB, $aDoesNotEqualB));

$context = new Context([
    'a' => rand(),
    'b' => rand(),
]);

$eitherOne->evaluate($context); // 总是为 true

规则执行

$context = new Context([
    'userName' => fn() => $_SESSION['userName'] ?? null,
]);

$userIsLoggedIn = $rb->create($rb['userName']->notEqualTo(null));

if ($userIsLoggedIn->evaluate($context)) {
    // 对已登录用户执行某些操作
}

4. 项目安装方式

Ruler 可以通过 Composer 或手动下载源码进行安装。推荐使用 Composer 进行安装，因为它可以自动管理依赖关系，并且方便进行版本控制。

使用 Composer 安装

composer require ruler/ruler

手动安装

1. 下载 Ruler 的源码。
2. 将源码放置在你的项目目录中。
3. 在 PHP 文件中引入 Ruler 的自动加载文件：

require 'path/to/ruler/autoload.php';

通过以上步骤，你就可以在你的项目中使用 Ruler 了。