iis服务器助手广告广告
返回顶部
首页 > 资讯 > 后端开发 > PHP编程 >PHP的命令行扩展Readline相关函数的使用
  • 207
分享到

PHP的命令行扩展Readline相关函数的使用

2024-04-02 19:04:59 207人浏览 泡泡鱼
摘要

目录Readline 扩展的安装基本函数操作读取一行命令历史列表相关操作查看 Readline 状态命令提示效果字符回调操作相关示例总结readline 扩展函数实现了访问 GNU

readline 扩展函数实现了访问 GNU Readline 库的接口。这些函数提供了可编辑的命令行。一个例子是在 Bash 中允许你使用箭头按键来插入字符或者翻看历史命令。因为这个库的交互特性,这个功能在你写的 WEB 程序中没多大用处,但是当你写的脚本被用在命令行中时非常有用。

Readline 扩展的安装

Readline 扩展已经加入了 PHP 的官方安装包中,如果是新的 php 环境,那么在编译的时候加上 --with-readline 即可。另外,我们还需要安装操作系统的 Readline 库。当然,如果已经是正常运行的 PHP ,也可以重新编译一下。


# yum install -y readline-devel
# ./congiure xxxx --with-readline

默认情况下,如果没有在编译时增加 --whit-readline ,Readline 的一些函数也是可以使用的,不过它们调用的是系统的 libedit 库。有一些函数,比如 readline_list_history() 这种函数是无法使用的。要想完整的使用 Readline 扩展的能力,那么还是需要安装操作系统的 libreadline 库(上面 yum 安装的那个 readline-devel )并在 PHP 中进行相应参数的编译安装。

基本函数操作

Readline 扩展提供的函数不多,也非常的简单易用。

读取一行


$line = readline("请输入命令:"); // 读取命令行交互信息
echo $line, PHP_EOL; // aaa

运行 PHP 代码后,我们就进入了命令提示符等待状态,并且会提示“请输入命令:”,当我们输入了 aaa 并回车之后,输入的内容就保存到了 $line 变量中。

命令历史列表相关操作

Readline 很强大的一个功能就是它自带一套命令历史记录的功能。不过这个需要我们自己手动地将命令加入到命令历史中。


$line = readline("请输入命令:"); // 读取命令行交互信息
if (!empty($line)) {
    readline_add_history($line); // 需要手动加入到命令历史记录中
}
echo $line, PHP_EOL; // aaa

$line = readline("请输入命令:");
if (!empty($line)) {
    readline_add_history($line);
}

// 命令历史记录列表
print_r(readline_list_history());
// Array
// (
//     [0] => aaa
//     [1] => bbb
// )

使用 readline_add_history() 函数,就可以将一条命令加入到命令历史记录中,然后使用 readline_list_history() 就能够打印出我们之前在交互式环境中发送过的命令记录。当然,如果只是这样简单的保存再打印那就没意思了,它还能将这些历史信息保存到外部文件进行存储。


// 将命令历史记录写入到一个文件中
readline_write_history('./readline_history');
// ./readline_history中
// _HiStOrY_V2_
// aaa
// bbb

// 清理命令历史记录
readline_clear_history();
print_r(readline_list_history());
// Array
// (
// )

// 从文件中读取命令历史记录
readline_read_history('./readline_history');
print_r(readline_list_history());
// Array
// (
//     [0] => bbb
//     [1] => bbb
// )

我们使用 readline_write_history() 函数将当前的命令历史记录保存到一个文件中,然后使用 readline_clear_history() 清理掉目前命令历史记录列表中的内容,这个时候打印 readline_list_history() 的话里面已经没有任何东西了。接着,我们再使用 readline_read_history() 将命令的历史记录从文件中加载回来进行还原。这一套功能是不是就非常有意思了,我们可以记录客户的所有命令操作,不管是安全审查还是事件回放,都非常有用。

查看 Readline 状态


// 当前命令行内部的变量信息
print_r(readline_info());
// Array
// (
//     [line_buffer] => bbb
//     [point] => 3
//     [end] => 3
//     [mark] => 0
//     [done] => 1
//     [pending_input] => 0
//     [prompt] => 请输入命令:
//     [terminal_name] => xterm-256color
//     [completion_append_character] =>
//     [completion_suppress_append] =>
//     [library_version] => 7.0
//     [readline_name] => other
//     [attempted_completion_over] => 0
// )

readline_info() 函数就比较简单了,我们可以看到最后一条交互式命令的信息,里面包括了命令输入的内容 line_buffer ,内容长度 point ,提示信息 prompt 等内容。

命令提示效果

linux 等操作系统上,我们想不起一个命令的全拼没关系,只需要记住它的前几个字符然后按两个 Tab 键就可以得到相关的命令提示了。Readline 扩展库当然也为我们准备了这样的功能。


// 类似于命令行中按 Tab 键的提示效果
readline_completion_function(function ($input, $index) {
    $commands = ['next', 'exit', 'quit'];
    $matches = [];
    if ($input) {
        // 如果关键字包含在命令中,提示命令信息
        foreach ($commands as $c) {
            if (strpos($c, $input) !== false) {
                $matches[] = $c;
            }
        }
    }else{
        $matches = $commands;
    }
    return $matches;
});

// 使用 Tab 键测试一下吧
$line = trim(readline("请输入命令:"));
if (!empty($line)) {
    readline_add_history($line);
}
echo $line, PHP_EOL; // 当前输入的命令信息
// 如果命令是 exit 或者 quit ,就退出程序执行
if($line == 'exit' || $line == 'quit'){
    exit;
}

readline_completion_function() 函数会接收一个回调函数,当在交互式命令行模式下,也就是 readline 函数调用时,按下 Tab 键的时候,就会进入到这个函数的回调函数中。\$input 是当前已经输入内容的值,$index 是第几个字符。我们在这个回调函数中定义了几个默认的命令,当你键入一个 n 时直接按 Tab 键,程序就是提示出完整的 next 命令出来。当然,多个相同的字母开头的都是可以通过这个 $matches 数组返回呈现的。

此外,在这段代码中,如果我们输入了 exit 或者 quit 。将退出程序的运行。

字符回调操作相关示例

最后几个函数我们将通过一个复杂的小测试来学习


// 输出的内容进入这个回调函数中
function rl_callback($ret)
{
    global $c, $prompting;

    echo "您输入的内容是: $ret\n";
    $c++;

    readline_add_history($ret);

    // 限制了就调用10次,也可以通过命令行输入的内容来判断,比如上面的 exit 那种进行退出
    if ($c > 10) {
        $prompting = false;
        // 移除上一个安装的回调函数句柄并且恢复终端设置
        readline_callback_handler_remove();
    } else {
        // 继续进行递归回调
        readline_callback_handler_install("[$c] 输入点什么内容: ", 'rl_callback');

    }
}

$c = 1;
$prompting = true;

// 初始化一个 readline 回调接口,然后终端输出提示信息并立即返回,需要等待 readline_callback_read_char() 函数调用后才会进入到回调函数中
readline_callback_handler_install("[$c] 输入点什么内容: ", 'rl_callback');

// 当 $prompting 为 ture 时,一直等待输入信息
while ($prompting) {
    $w = null;
    $e = null;
    $r = array(STDIN);
    $n = stream_select($r, $w, $e, null);
    if ($n && in_array(STDIN, $r)) {
        // 当一个行被接收时读取一个字符并且通知 readline 调用回调函数
        readline_callback_read_char();
    }
}

echo "结束,完成所有输入!\n";
// [1] 输入点什么内容: A
// 您输入的内容是: A
// [2] 输入点什么内容: B
// 您输入的内容是: B
// [3] 输入点什么内容: C
// 您输入的内容是: C
// [4] 输入点什么内容: D
// 您输入的内容是: D
// [5] 输入点什么内容: E
// 您输入的内容是: E
// [6] 输入点什么内容: F
// 您输入的内容是: F
// [7] 输入点什么内容: G
// 您输入的内容是: G
// [8] 输入点什么内容: H
// 您输入的内容是: H
// [9] 输入点什么内容: I
// 您输入的内容是: I
// [10] 输入点什么内容: J
// 您输入的内容是: J
// 结束,完成所有输入!

print_r(readline_list_history());
// Array
// (
//     [0] => A
//     [1] => B
//     [2] => C
//     [3] => D
//     [4] => E
//     [5] => F
//     [6] => G
//     [7] => H
//     [8] => I
//     [9] => J
// )

首先,我们先不管上面的这个自定义的函数,直接向下看到 readline_callback_read_char() 。它的作用是当一个行被接收时读取一个字符并且通知 readline 调用回调函数。也就是当一行输入完成后,键入了回车之后,这个函数将通知 Readline 组件去调用 readline_callback_handler_install() 注册的回调函数。

readline_callback_handler_install() 函数的功能是初始化一个 readline 回调接口,然后终端输出提示信息并立即返回,如果在回调函数中不进行什么操作的话,这个函数就只是输出一个提示就结束了。在我们例子中的这个回调函数 rl_callback() 中,我们根据当前接收命令的次数,判断如果接收的命令在十次内,则继续接收命令直到十次命令为止就调用 readline_callback_handler_remove() 移除上一个 readline_callback_handler_install() 安装的回调并恢复终端的默认设置。

最后执行的结果就是注释中的内容,大家也可以自己复制下代码后运行调试,只有自己进行过的调试才能理解的更加深入。

总结

Readline 很强大,而且也是 PHP 默认安装包中自带的扩展。一般被加入默认的扩展都是经过时间检验而且非常有用的扩展,大家可以根据这些内容再进行更加深入的学习并运用到实战中。

测试代码:

https://GitHub.com/zhangyue0503/dev-blog/

以上就是PHP的命令行扩展Readline相关函数的使用的详细内容,更多关于PHP 命令行扩展Readline的使用的资料请关注编程网其它相关文章!

--结束END--

本文标题: PHP的命令行扩展Readline相关函数的使用

本文链接: https://www.lsjlt.com/news/126193.html(转载时请注明来源链接)

有问题或投稿请发送至: 邮箱/279061341@qq.com    QQ/279061341

本篇文章演示代码以及资料文档资料下载

下载Word文档到电脑,方便收藏和打印~

下载Word文档
猜你喜欢
  • PHP的命令行扩展Readline相关函数的使用
    目录Readline 扩展的安装基本函数操作读取一行命令历史列表相关操作查看 Readline 状态命令提示效果字符回调操作相关示例总结readline 扩展函数实现了访问 GNU ...
    99+
    2024-04-02
  • PHP中命令行扩展Readline相关函数的示例分析
    小编给大家分享一下PHP中命令行扩展Readline相关函数的示例分析,相信大部分人都还不怎么了解,因此分享这篇文章给大家参考一下,希望大家阅读完这篇文章后大有收获,下面让我们一起去了解一下吧!readline 扩展函数实现了访问 GNU ...
    99+
    2023-06-15
  • PHP 函数版本兼容性与扩展扩展是否相关?
    php 函数版本兼容性受 php 扩展影响。扩展是预编译的代码库,可添加或修改函数。扩展版本更新可能导致与旧版本不兼容,例如参数列表更改。解决兼容性问题的方法包括:检查已安装扩展版本、安...
    99+
    2024-04-25
    php 兼容性 mysql
  • Linux下ifconfig命令的扩展使用
    本篇内容主要讲解“Linux下ifconfig命令的扩展使用”,感兴趣的朋友不妨来看看。本文介绍的方法操作简单快捷,实用性强。下面就让小编来带大家学习“Linux下ifconfig命令的扩展使用”吧!Linux查看IP地址的命令--ifco...
    99+
    2023-06-13
  • 如何使用 PHP 函数扩展?
    通过编写 php 扩展模块,可以添加新函数或修改现有函数,实现自定义需求。具体步骤包括:创建 php 源代码文件;使用 phpize 初始化扩展;运行 configure 脚本生成 ma...
    99+
    2024-04-16
    函数 php扩展
  • 如何使用 PHP 扩展函数?
    php 扩展函数是核心组件之外的附加功能,可扩展 php 的功能。安装扩展函数后,在 php.ini 中启用它们,然后使用扩展函数,例如 imagick 扩展用于处理图像。您可以使用命令...
    99+
    2024-04-16
    php 扩展函数 composer
  • 如何使用 PHP 函数扩展?
    通过编写 php 扩展模块,可以添加新函数或修改现有函数,实现自定义需求。具体步骤包括:创建 php 源代码文件;使用 phpize 初始化扩展;运行 configure 脚本生成 ma...
    99+
    2024-04-16
    函数 php扩展
  • PHP命令执行的函数
    在做面试题的时候发现,自己对PHP命令执行的函数的了解并不是很全面,就想这去学习一下。我也在网上找到了许多的资料,在这里我就相当于一个总结吧。 system(); System()函数的主要功能是在系统权限允许的情况是执行系统命令,w...
    99+
    2023-09-15
    linux 运维 服务器
  • 如何进行扩展Python的相关说明
    如何进行扩展Python的相关说明,相信很多没有经验的人对此束手无策,为此本文总结了问题出现的原因和解决方法,通过这篇文章希望你能解决这个问题。下面全面进行讲述Python的相关问题,它是一种面向对象、直译式计算机程序设计语言,也是一种功能...
    99+
    2023-06-17
  • 如何使用 Mockery 扩展 PHP 函数?
    使用 mockery 来扩展 php 函数,通过以下步骤模拟函数的行为:安装 mockery 库。使用 mockery::mock('alias:函数名称') 创建模拟函数,其中 ali...
    99+
    2024-04-11
    php函数 mockery composer
  • 如何使用 Hamcrest 扩展 PHP 函数?
    是的,通过使用 hamcrest 可以扩展 php 函数以增强测试可读性:使用 extend() 方法扩展函数,将函数名和 hamcrest 匹配器作为参数。对于泛型函数,指定类型提示。...
    99+
    2024-04-11
    php hamcrest composer
  • 如何使用 Prophecy 扩展 PHP 函数?
    使用 prophecy 扩展 php 函数可通过以下步骤实现:使用 composer 安装 prophecy。使用 prophesize() 方法创建桩对象。使用 will() 方法配置...
    99+
    2024-04-11
    php prophecy composer
  • 如何使用 RespectPHP 扩展 PHP 函数?
    respectphp 扩展 php 的验证功能,让开发者轻松验证数据类型。它提供了广泛的验证规则,支持链接形成复杂、可读的验证链。常见的用途包括表单验证,其中 respectphp 与 ...
    99+
    2024-04-11
    php函数 composer
  • 如何使用 SinonPHP 扩展 PHP 函数?
    sinonphp 允许扩展或覆盖 php 函数和方法,用于单元测试或定制代码行为。它提供了以下主要功能:扩展函数:使用 sinonphp\stub 函数扩展已有的 php 函数。扩展方法...
    99+
    2024-04-11
    php sinonphp composer 作用域
  • PHP 函数的扩展函数有哪些?
    是的,php 函数扩展函数可以修改或增强现有函数的行为,包括:user_error():报告用户可读的错误消息trigger_error():报告 php 错误消息set_error_h...
    99+
    2024-04-10
    php 函数扩展
  • Golang函数生命周期的扩展
    go 函数的生命周期涵盖从声明到退出的过程,但可通过以下方式扩展:init() 函数:在任何其他函数调用前执行,用于初始化全局变量等操作。defer 语句:将函数调用推迟到函数退出时执行...
    99+
    2024-04-18
    golang 函数生命周期
  • PHP中如何使用 function函数扩展
    这篇文章将为大家详细讲解有关PHP中如何使用 function函数扩展,文章内容质量较高,因此小编分享给大家做个参考,希望大家阅读完这篇文章后对相关知识有一定的了解。PHP function函数扩展的代码示例:< php &...
    99+
    2023-06-17
  • 如何扩展 PHP 的函数库?
    php 函数库扩展方法:创建自定义函数;调用 spl_autoload_register() 注册函数库;使用自定义函数,就像内置函数一样。 如何扩展 PHP 的函数库 简介 PHP ...
    99+
    2024-04-21
    php 函数库
  • ECMAscrip函数的扩展怎么使用
    本篇内容主要讲解“ECMAscrip函数的扩展怎么使用”,感兴趣的朋友不妨来看看。本文介绍的方法操作简单快捷,实用性强。下面就让小编来带大家学习“ECMAscrip函数的扩展怎么使用”吧!1.函数参数的默认值1.1函数参数指定默认值在ECM...
    99+
    2023-06-21
  • 利用扩展模块优化 PHP 函数执行
    扩展模块可优化 php 函数执行,方法如下:创建 c++/c++ 函数实现耗时操作。使用 php 扩展框架创建扩展模块,将 c/c++ 函数封装成 php 函数。在 php 脚本中加载扩...
    99+
    2024-04-12
    php 函数优化 c++
软考高级职称资格查询
编程网,编程工程师的家园,是目前国内优秀的开源技术社区之一,形成了由开源软件库、代码分享、资讯、协作翻译、讨论区和博客等几大频道内容,为IT开发者提供了一个发现、使用、并交流开源技术的平台。
  • 官方手机版

  • 微信公众号

  • 商务合作