PHP is not a script language that has attracted much attention, but this is a pity, because PHP has many ideals that make it the ideal choice to write a terminal application.

This series of articles will introduce how to use the Macrame library to write an interactive command line script. We will gradually complete a sample item. The script obtains the list of Mastodon user followers from beginning to end, and covers the following topics: obtain and verify user input, build interactive menu, handle command line parameters, security access files, set output text styles, and Run the function in the background when the animation loader is displayed to the user.

For more information about Macrame, visit the document site.

Example items

In the run script operation

For anyone who wants to skip this step, the complete source code of this project is provided in the form of GIST.

Overview

Install Macrame

Create a blank script
Read the command line parameters
Create a dynamic menu
Read a line of user input (optional verification)
Set output text style
• Install Macrame

Create a script framework

composer require gbhorwood/macrame

#!/usr/bin/env php
<?php require __DIR__ . '/vendor/autoload.php';

use Gbhorwood\Macrame\Macrame;

// 實(shí)例化 Macrame 對(duì)象。
// 參數(shù)是 ps(1) 所見的腳本名稱
$macrame = new Macrame("示例 Macrame 腳本");

// 強(qiáng)制僅在命令行上執(zhí)行腳本時(shí)才運(yùn)行腳本
if ($macrame->running()) {

    // 驗(yàn)證主機(jī)系統(tǒng)是否可以運(yùn)行 Macrame 腳本。失敗時(shí)退出
    $macrame->preflight();

    // 將文本輸出到 STDOUT
    $macrame->text("Hello World")->write();

    // 清潔退出
    $macrame->exit();
}

the first line of the file, even before & lt;? PHP.

#!/usr/bin/env php

Here, we create a Macrame object that we will use it in the rest of the script. Very standard content. The only interesting part is the parameter. This is the name of the operating system that will give us the script. For example, if we run PS to display the running process list, our script will display this name.
This statement ensures that all the code in the block is executed only when the script is run on the command line.

composer require gbhorwood/macrame

When we write PHP for the command line, our control of the environment is not as much as web servers we have and manage. The preflicht () calls the local PHP environment. If it does not meet the minimum requirements, it will terminate the script and display the error message. The minimum requirements are: <：>

PHP 7.4
POSIX extension
MBSTRING Extension

Although Macrame runs on PHP 7.4 and 8.0, because PHP has changed in 8.1, The symbol string may not be aligned correctly in the output.

#!/usr/bin/env php
<?php require __DIR__ . '/vendor/autoload.php';

use Gbhorwood\Macrame\Macrame;

// 實(shí)例化 Macrame 對(duì)象。
// 參數(shù)是 ps(1) 所見的腳本名稱
$macrame = new Macrame("示例 Macrame 腳本");

// 強(qiáng)制僅在命令行上執(zhí)行腳本時(shí)才運(yùn)行腳本
if ($macrame->running()) {

    // 驗(yàn)證主機(jī)系統(tǒng)是否可以運(yùn)行 Macrame 腳本。失敗時(shí)退出
    $macrame->preflight();

    // 將文本輸出到 STDOUT
    $macrame->text("Hello World")->write();

    // 清潔退出
    $macrame->exit();
}

Run hello world

After writing the basic "Hello World" script, we can set its permissions to allow execution and run it on the command line.

#!/usr/bin/env php

For this situation, we only need to check whether these parameters exist.

$macrame = new Macrame("示例 Macrame 腳本");

Exist () method return to Boolean.

if ($macrame->running())

? Macrame calls are designed to perform chain calls.

The command line parameters can also be used to assign a value for variables. For example, to set the user name value, we may hope that users can call the script like this:

To get the value of this parameter in our script, we can use the first () method provided by ARGS (), as shown below:

$macrame->preflight();

As the name suggests, the first () method returns the

$macrame->exit();

Then first () will return the "firstuser" value. If we want the last value, we can call Last (). If we want

chmod 755 ./examplescript.php
./examplescript.php

Putting all these together, our script looks like this now:

The full method list of handling command line parameters is introduced in the Macrame parameter document.

./examplescript.php --version
# 或
./examplescript.php -v

key to select.

Let's write a function that displays the menu to the user and return the value of the selected value:

composer require gbhorwood/macrame

The core function here is to call the following:

#!/usr/bin/env php
<?php require __DIR__ . '/vendor/autoload.php';

use Gbhorwood\Macrame\Macrame;

// 實(shí)例化 Macrame 對(duì)象。
// 參數(shù)是 ps(1) 所見的腳本名稱
$macrame = new Macrame("示例 Macrame 腳本");

// 強(qiáng)制僅在命令行上執(zhí)行腳本時(shí)才運(yùn)行腳本
if ($macrame->running()) {

    // 驗(yàn)證主機(jī)系統(tǒng)是否可以運(yùn)行 Macrame 腳本。失敗時(shí)退出
    $macrame->preflight();

    // 將文本輸出到 STDOUT
    $macrame->text("Hello World")->write();

    // 清潔退出
    $macrame->exit();
}

We provide a string array as the menu option, and a optional menu title text for Menu ()-& GT; Internet (), and the menu will automatically display it to users. The user's choice will be returned as a string.

By adding to Erase () to our chain, you can also choose to erase the menu from the screen after the user makes a choice. This method is optional, but it can indeed be tidy.

After obtaining the menu function, we can modify the way to get the Mastodon instance. We will try to read it from the command line parameters. If no value is passed, the menuinstance () function is called.

#!/usr/bin/env php

Supplementary description of the menu style

By default, Macrame uses the default style and color of the terminal to display the menu, and the project that highlights the displayed display is set to reverse display. If necessary, we can change this setting by adding some additional functions to our chain. For example, if we want to highlight the displayed items displayed as a thick red text, we can write this:

$macrame = new Macrame("示例 Macrame 腳本");

The menu document pages a complete overview of all methods that can be used to customize the color, style and alignment method of custom menu.

Read a line of users to enter

Next, we will modify the way to obtain the username so that it will also accept interactive input. In this case, we will use input ()-& gt; readline () to read the user input text string. The following is the function: <>

if ($macrame->running())

$macrame->preflight();

$macrame->exit();

Set text style

In the example of how to read a line of user text, we have seen a large number of codes used to set a prompt text style. Let's study it in detail.

Macrame allows the use of ANSI code to set the terminal text output style, which allows us to apply the style and color of the thick body and oblique body to our text.

We can perform this operation in our script through two ways. There are some ways, such as style () and colour () (or color ()), or we can use the basic text mark system.

Let's first look at the method.

composer require gbhorwood/macrame

Here, we use Macrame's Text () method to create a "text" object, then apply style and color, and finally use get () to return it as a string.

Please note that style and color methods are applied to all texts in the string. If we want to mix style and color text with pure text, we will have to create many sub -string and connect them together. This may be very troublesome, especially when dealing with a large number of texts.

or, we can use Macrame's markup system to simplify the text style settings. This is an example: <>

#!/usr/bin/env php
<?php require __DIR__ . '/vendor/autoload.php';

use Gbhorwood\Macrame\Macrame;

// 實(shí)例化 Macrame 對(duì)象。
// 參數(shù)是 ps(1) 所見的腳本名稱
$macrame = new Macrame("示例 Macrame 腳本");

// 強(qiáng)制僅在命令行上執(zhí)行腳本時(shí)才運(yùn)行腳本
if ($macrame->running()) {

    // 驗(yàn)證主機(jī)系統(tǒng)是否可以運(yùn)行 Macrame 腳本。失敗時(shí)退出
    $macrame->preflight();

    // 將文本輸出到 STDOUT
    $macrame->text("Hello World")->write();

    // 清潔退出
    $macrame->exit();
}

marks will be thickened (of course). The document lists the complete list of all the marks. One thing to note is that the mark will turn off all previous marks. This is due to the behavior of the ANSI transfer code.

This means that nested marks will not work as we expect. For example, in this example, the first mark will be closed

mark:

#!/usr/bin/env php

$macrame = new Macrame("示例 Macrame 腳本");