yeriomin/console-app

一个带有日志记录、单实例运行和控制台输入参数辅助工具的PHP控制台应用程序框架。

维护者

详细信息

github.com/yeriomin/console-app

源代码

问题

安装: 20

依赖者: 0

建议者: 0

安全性: 0

星标: 1

关注者: 3

分支: 3

开放问题: 0

v1.1 2015-01-15 23:50 UTC

Requires

MIT 484819ba422253df9e357e63813b33da50434318

  • Sergey Yeriomin <yeriomin.woop@gmail.com>

This package is not auto-updated.

Last update: 2024-09-24 03:08:09 UTC

README

Latest Version Build Status Scrutinizer Code Quality

一个PHP控制台应用程序框架。

使用方法

将console-app作为依赖项安装

$ composer require yeriomin/console-app

扩展\Yeriomin\ConsoleApp\ConsoelApp类并实现run()方法。

<?php
class MyConsoleApp extends \Yeriomin\ConsoleApp\ConsoelApp {
    public function run()
    {
        $this->logger->info('Hi');
    }
}

特性

  1. 处理配置文件。默认尝试读取./config.ini。
  2. 处理控制台参数。扩展getGetopt()方法以添加您的选项。
  3. 检查是否有相同的脚本的其他实例正在运行。可以在配置中禁用。
  4. 检查脚本是否在控制台中运行。否则失败。可以在配置中禁用。
  5. 初始化monolog记录器。
  6. 使用错误和信号处理器让您看到日志中的最后一条重要消息。

配置

默认支持以下配置选项

  • consoleOnly 让脚本仅在控制台中运行，不在浏览器中运行。默认为True。
  • oneInstanceOnly 任何时间只允许脚本的一个实例运行。默认为True。
  • logDir 存放日志文件的目录。默认为系统临时目录。
  • logFile 日志文件的具体路径。如果没有提供，则使用/tmp/<script-class-name>.log。
  • lockDir 存放锁定文件目录。默认为系统临时目录。
  • lockFile 锁定文件的具体路径。如果没有提供，则使用/tmp/<script-class-name>.lock。

控制台参数

默认支持以下两个控制台选项

  • -h|--help 显示使用信息。它将包括您添加的选项。
  • -c|--config 配置文件的路径。默认为./config.ini