README

Livia 命令行框架

描述

LivCommander 是一个用于创建终端应用程序和管理执行命令任务的框架。LivCommander 的主要功能是提供显示彩色消息、自定义任务、显示通知和显示可用命令列表的选项。

安装

LivCommander 可在 Packagist (chrisenytc/livcommander) 上找到，因此可以通过 Composer 进行安装。

php composer.phar require chrisenytc/livcommander '~1.0'

如果您不使用 Composer，可以从 GitHub 下载代码，并使用任何 PSR-0 兼容的自动加载器（例如，Symfony2 ClassLoader 组件）来加载 LivCommander 类。

入门

#!/usr/bin/env php
<?php

use Commander\LivCommander;


//Create new instance of LivCommander
$livia = new LivCommander();

//Create a command option
$livia->setOption('option_name', 'description', array(
	array('name' => 'commandname', 'command' => 'command"')
));

//Start LivCommander with stdinput
$livia->bootstrap($argv);

选项

使用 LivCommander 的所有方法列表

setAppName($name)

此方法将通知和其他系统部分使用的名称更改为参数 $name 中指定的名称。

$livia->setAppName('LivCommander');

setMessagePath($path)

此方法将用于显示 LivCommander 静态消息块的文件夹路径更改为默认路径之外的路径，并在参数 $path 中设置新路径。

$livia->setMessagePath(__DIR__.'/messages');

getAppName()

此方法返回 AppName

$livia->getAppName();

getMessagePath()

此方法返回 AppName

$livia->getMessagePath();

log($text, $status)

此方法返回一个使用状态参数 $status 传递的文本参数 $text 着色的日志消息。

可用状态：success、info、warning 和 danger。

$livia->log('Hello World', 'info');

ask($question)

此方法向用户显示参数 $question 的问题并返回其响应。

$response = $livia->ask('Whats your name?');

confirm($question, $default = 'yes')

此方法显示参数 $question 并询问用户，如果用户按下 enter 键，则使用标记为默认的选项，如果用户输入除 'yes' 或 'no' 以外的名称，则此方法将重复询问，直到他准确报告并返回其响应。

$response = $livia->confirm('Do you like The Vampire Diaries?');

setOption($name, $description, array $data)

此方法负责存储将在系统中使用的命令信息。它接收三个参数

option_name

当显示具有可用选项的帮助屏幕时，它是显示的名称，或者用户将输入以访问此任务的命令的名称。

描述

这是当显示具有可用选项的帮助屏幕时将出现的描述。

命令名称

这是在任务轮换时在通知和消息系统中出现的命令名称。

命令

这是当用户选择此命令所属的选项时将执行的命令。

$livia->setOption('option_name', 'description', array(
	array('name' => 'command_name', 'command' => 'command"')
));

getOptions()

此方法返回一个包含所有已配置选项名称的ArrayList。

$livia->getOptions();

bootstrap($input)

此方法负责启动应用程序并监视您输入的命令。此方法接收通过变量$argv传递的输入。

$livia->bootstrap($argv);

version()

此方法返回LivCommander的版本。

$livia->version();

许可协议

MIT许可协议（MIT）

在此特此免费许可任何获得此软件及其相关文档文件（“软件”）副本的人（“任何人”），在不受限制的情况下处理软件，包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或销售软件副本的权利，并允许向提供软件的人这样做，前提是遵守以下条件

chrisenytc / livcommander

维护者

详细信息