colorful-php's Introduction

Colorful-PHP

Preface

在写Nold文档示例生成小工具的时候，想要加入Console用于界面友好的命令行输出展示，其中需要Console需要对输出的文档进行适当美化。考虑到这个可集成到目前自己所写绝大部分的工具或者框架(譬如现在正在写的Nold文档生成小工具以及Zaor)，所以便单独抽出来,便于今后其他工具或者框架可以使用.虽然网上类似的小插件也不少，不过想到这个轮子还是比较小的，所以干脆自己花点业余时间写一个好了.

Application

Let console to be Colorful~😆

Install

composer require yinggaozhen/colorful-php dev-master

Usage

大体用法是通过Cololrful::apply传入要渲染的文本以及主题，其中主题包括内置基础主题和装饰主题(可通过参数进一步调节).当然也可以通过Cololrful::import导入主题.

// 基础主题
Colorful::apply('Hi~ Success', 'success');
Colorful::apply('PHP Warning: file_get_contents failed to open stream: no suitable wrapper could be found.', 'warn');
Colorful::apply('PHP Fatal error: Call to undefined function mb_detect_encoding() ', 'fatal');
Colorful::apply('https://github.com/yinggaozhen/colorful-php', 'hyperlink');

// 装饰主题
$longtext = "message\n\n    The exception message\ncode\n\n    The exception code\nfile\n\n    The filename where the exception was created\nline\n\n    The line where the exception was created";
$frame = new \colorful\decorator\Frame([
    'spec' => '',
    'decorate' => '='
]);
echo colorful\Colorful::apply($longtext, ['yellow', null, []], $frame) . PHP_EOL;