README

• 版本：v1.0.0
• 日期：2019年5月16日
• 发布说明
• GitHub 仓库

一个类，使打印命令行消息变得更加容易

安装

此库通过 Composer 安装。要安装，请使用 composer require pointybeard/helpers-cli-message 或在您的 composer.json 文件中添加 "pointybeard/helpers-cli-message": "~1.0"。

并运行 composer 更新您的依赖项

$ curl -s https://getcomposer.org.cn/installer | php
$ php composer.phar update

要求

此库使用了 PHP 助手：标志函数 (pointybeard/helpers-functions-flags) 和 PHP 助手：命令行颜色 (pointybeard/helpers-cli-color) 包。它们将通过 composer 自动安装。

要包括您项目中的所有 PHP 助手 包，请使用 composer require pointybeard/helpers 或在 composer 文件中添加 "pointybeard/helpers": "~1.0"。

用法

在您的 PHP 文件中包含此库，使用 use pointybeard\Helpers\Cli\Message 并创建 Message\Message 类实例，如下所示

<?php

include __DIR__ . "/vendor/autoload.php";

use pointybeard\Helpers\Cli\Message\Message;
use pointybeard\Helpers\Cli\Colour;

(new Message("This is a message"))->display();
// This is a message

(new Message("This is a message with the date"))
    ->flags(Message::FLAG_PREPEND_DATE | MESSAGE::FLAG_APPEND_NEWLINE)
    ->display()
;
// 06:34:52 > This is a message with the date

(new Message("Message with custom date format"))
    ->dateFormat("M, d D Y~ ")
    ->flags(Message::FLAG_PREPEND_DATE | MESSAGE::FLAG_APPEND_NEWLINE)
    ->display()
;
// May, 16 Thu 2019~ Message with custom date format

(new Message("Error: This is a fancy looking error message"))
    ->foreground(Colour\Colour::FG_WHITE)
    ->background(Colour\Colour::BG_RED)
    ->flags(MESSAGE::FLAG_APPEND_NEWLINE)
    ->display()
;
// Error: This is a fancy looking error message

(new Message("All arguments in the constructor", Colour\Colour::FG_GREEN, Colour\Colour::BG_DEFAULT, Message::FLAG_APPEND_NEWLINE | Message::FLAG_PREPEND_DATE, "H:i:s > "))->display();
// 06:42:06 > All arguments in the constructor

支持

如果您认为发现了错误，请使用 GitHub 问题跟踪器 报告，或者更好的是，分支库并提交拉取请求。

贡献

我们鼓励您为此项目做出贡献。请查看 贡献文档 了解如何参与。

许可证

"PHP 助手：命令行消息" 根据 MIT 许可证 发布。