codedungeon/php-messenger

PHP 库,用于创建控制台消息

1.1.1 2021-07-28 16:53 UTC

README

描述

PHP Messenger 提供了一系列在基于 CLI 的应用程序中可用的常规功能,提供了一种简单一致的接口,为您处理所有颜色化。

Screenshot

与 Laravel 命令和 Laravel-Zero 一起使用

此外,PHP Messenger 还可以与使用 Laravel Commands 或 Laravel-Zero 创建的 CLI 应用程序一起使用,使用 Laravel Facades 接口。

安装

composer require codedungeon/php-messenger

Laravel 配置

Laravel 5.5 之前的版本注册

  • 注册服务提供者

    修改 config/app.php 并添加服务提供者

        'providers' => [
             ...
     		Codedungeon\PHPMessenger\MessengerServiceProvider::class,
     		...
  • 注册 Facades

    修改 config/app/php 并将 Facades 添加到 aliases 部分

         'aliases' => [
     	...
             'Messenger' => Codedungeon\PHPMessenger\MessengerServiceProvider::class,
     	...

Laravel 5.5 及以上版本

当将 PHP Messenger 安装到基于 Laravel 的项目中时,它将使用 Laravel 5.5 或更高版本中可用的自动发现系统。

Laravel Zero 配置

  • 注册服务提供者

    修改 config/app.php 中的 providers 部分

     	'providers' => [
     		...
     		Codedungeon\PHPMessenger\ServiceProvider::class,
     		...
     	],
  • 创建所需的命令,并按照以下方式使用

     	// add use statement
     	use Codedungeon\PHPMessenger\Facades\Messenger;
    
     	// handle method
     	public function handle()
     	{
     		echo PHP_EOL;
     		$msg = "PHP Messenger v" . Messenger::version();
     		Messenger::important($msg);
     		Messenger::info("-- Using Laravel Package (Facades)");
     	   ...
     	}

在非 Laravel 应用程序中使用

<?php

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

use Codedungeon\PHPMessenger\Messenger;

$messenger = new Messenger();

$messenger->success("Success Message w/ Label"," SUCCESS ");
$messenger->info("Information Message");
...

用法

消息传递签名

所有消息传递方法都使用以下相同的方法签名

消息传递方法

Messenger::log(msg:string, [label:string - optional])

Messenger::info(msg:string, [label:string - optional])

Messenger::debug(msg:string, [label:string - optional])

Messenger::critical(msg:string, [label:string - optional])

Messenger::error(msg:string, [label:string - optional])

Messenger::success(msg:string, [label:string - optional])

Messenger::warning(msg:string, [label:string - optional])

Messenger::warn(msg:string, [label:string - optional])

Messenger::important(msg:string, [label:string - optional])

Messenger::status(msg:string, [label:string - optional])

Messenger::notice(msg:string, [label:string - optional])

Messenger::note(msg:string, [label:string - optional])

Messenger::version() -> returns current package version

许可协议

版权 © 2019-2020 Mike Erickson,在 MIT 许可下发布

致谢

PHP Messenger 由 Mike Erickson 编写

电子邮件: codedungeon@gmail.com

推特: @codedungeon

网站: codedungeon.io