Crunz 开源项目使用教程

1. 项目的目录结构及介绍

Crunz 是一个基于 PHP 的任务调度器，其目录结构清晰，便于管理和扩展。以下是 Crunz 项目的主要目录结构及其介绍：

crunz/
├── bin/
│   └── crunz
├── src/
│   ├── Event.php
│   ├── Scheduler.php
│   └── ...
├── tests/
│   ├── EventTest.php
│   ├── SchedulerTest.php
│   └── ...
├── composer.json
├── README.md
└── ...

• bin/: 包含可执行文件，如 crunz 命令行工具。
• src/: 包含项目的核心源代码，如 Event.php 和 Scheduler.php。
• tests/: 包含项目的单元测试文件。
• composer.json: Composer 配置文件，定义了项目的依赖关系。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

Crunz 的启动文件位于 bin/ 目录下，名为 crunz。这个文件是一个可执行的 PHP 脚本，用于启动任务调度器。以下是 crunz 文件的部分内容：

#!/usr/bin/env php
<?php

require __DIR__.'/../vendor/autoload.php';

use Crunz\Application;

$application = new Application();
$application->run();

• #!/usr/bin/env php: 指定使用 PHP 解释器执行该脚本。
• require DIR.'/../vendor/autoload.php': 引入 Composer 自动加载文件。
• use Crunz\Application: 引入 Crunz 应用程序类。
• $application = new Application(): 创建应用程序实例。
• $application->run(): 运行应用程序。

3. 项目的配置文件介绍

Crunz 的配置文件通常位于项目根目录下，名为 crunz.yml。这个文件定义了任务调度器的各种配置选项。以下是 crunz.yml 文件的部分内容：

timezone: "Europe/Rome"
source: "path/to/tasks"
suffix: "Tasks.php"
log_output: true
output_log_file: "path/to/output.log"
errors_log_file: "path/to/errors.log"

• timezone: 设置时区，如 "Europe/Rome"。
• source: 指定任务文件的目录路径。
• suffix: 指定任务文件的后缀名，如 "Tasks.php"。
• log_output: 是否记录输出日志。
• output_log_file: 输出日志文件的路径。
• errors_log_file: 错误日志文件的路径。

以上是 Crunz 开源项目的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些内容能帮助你更好地理解和使用 Crunz 项目。