CRON for PHP 使用教程

CRON for PHP 使用教程

cron-expression CRON for PHP: Calculate the next or previous run date and determine if a CRON expression is due 项目地址: https://gitcode.com/gh_mirrors/cro/cron-expression

1. 项目目录结构及介绍

CRON for PHP 是一个用于解析 CRON 表达式的 PHP 库。以下是项目的目录结构及各部分的简要介绍：

cron-expression/
├── .github/                # GitHub 相关配置文件
├── .gitattributes          # Git 属性配置文件
├── .gitignore              # Git 忽略文件
├── .editorconfig           # 编辑器配置文件
├── .php_cs                 # PHP 代码风格配置文件
├── .styleci.yml            # StyleCI 配置文件
├── CHANGELOG.md            # 项目更新日志
├── LICENSE                 # 项目许可证文件
├── README.md               # 项目说明文件
├── composer.json           # Composer 配置文件
├── phpstan.neon            # PHPStan 配置文件
├── phpunit.xml.dist        # PHPUnit 配置文件
├── src/                    # 源代码目录
│   └── Cron/
│       ├── CronExpression.php
│       └── ...
├── tests/                  # 测试代码目录
│   └── Cron/
│       ├── CronExpressionTest.php
│       └── ...
└── ...

• src/: 包含项目的主要 PHP 类文件。
• tests/: 包含项目的单元测试代码。

2. 项目的启动文件介绍

项目的启动并不需要特定的文件，因为这是一个 PHP 库。要使用这个库，你需要通过 Composer 将其安装到你的项目中，并在你的代码中引入相应的类文件。

安装步骤如下：

composer require dragonmantank/cron-expression

在你的 PHP 代码中，你可以这样使用它：

<?php
require_once 'vendor/autoload.php';

use Cron\CronExpression;

// 创建 CRON 表达式对象
$cron = new CronExpression('@daily');

// 检查当前时间是否应该运行任务
if ($cron->isDue()) {
    echo "任务应该运行！";
}

// 获取下一次运行的时间
echo $cron->getNextRunDate()->format('Y-m-d H:i:s');

3. 项目的配置文件介绍

这个项目的主要配置文件是 composer.json，它用于管理项目的依赖。

{
    "name": "dragonmantank/cron-expression",
    "description": "PHP CRON expression parser",
    "type": "library",
    "require": {
        "php": "^7.2|^8.0",
        "phpunit/phpunit": "^9.0"
    },
    "autoload": {
        "psr-4": {"Cron\\": "src/"}
    },
    "config": {
        "preferred-install": "dist",
        "sort-packages": true
    }
}

这个文件定义了项目依赖 PHP 7.2 或 8.0，以及 PHPUnit 用于测试。autoload 部分告诉 Composer 如何自动加载库中的类。

其他配置文件，如 .gitattributes、.editorconfig、.php_cs 和 .styleci.yml，都是用于设置项目的代码风格和开发环境的，不需要用户直接修改。

cron-expression CRON for PHP: Calculate the next or previous run date and determine if a CRON expression is due 项目地址: https://gitcode.com/gh_mirrors/cro/cron-expression