krypt0nn/consoleargs

PHP library which add a few classes to realize your own command manager

2.1.2 2021-06-04 21:04 UTC

Requires

• php: >=7.4

GPL-3.0-or-later

• Nikita Podvirnyy

• cli
• console

README

ConsoleArgs - библиотека для реализации работы с аргументами командной строки для PHP 7.4

Установка

composer require krypt0nn/consoleargs

Примеры работы

<?php

namespace ConsoleArgs;

(new Manager ([
    new Command ('hello', function ()
    {
        echo 'Hello, World!';
    })
]))->execute (array_slice ($argv, 1));

// array_slice нужен чтобы отрезать аргумент вызова файла из консоли

php index.php hello

Вывод:

Hello, World!

Работа с аргументами

Для получения списка аргументов, переданных команде, вы можете добавить параметр анонимной функции команде:

<?php

namespace ConsoleArgs;

(new Manager ([
    new Command ('write', function ($args)
    {
        echo implode (' ', $args);
    })
]))->execute (array_slice ($argv, 1));

php index.php write kek lol arbidol

Вывод:

kek lol arbidol

Работа с параметрами

Функционал параметров предоставляет объект Param, флагов - объект Flag:

<?php

namespace ConsoleArgs;

(new Manager ([
    (new Command ('write', function ($args, $params)
    {
        // Если было указано несколько одинаковых параметров, то будет указан список всех введённых значений
        // Поэтому это так же нужно предусмотреть:
        if (is_array ($params['--glue']))
            $params['--glue'] = $params['--glue'][0];
        
        echo $params['--base64'] ?
            base64_encode (implode ($params['--glue'], $args)) :
            implode ($params['--glue'], $args);
    }))->addParams ([
        // Первый аргумент - название параметра
        // Второй аргумент (не обязательный) - значение по умолчанию
        // Третий аргумент (не обязательный) - обязательно ли нужно использовать данный параметр
        new Param ('--glue', ' '),

        // Аргумент - название флага
        // "-b64" - алиас флага (альтернативное название)
        (new Flag ('--base64'))->addAlias ('-b64')
    ])
], new DefaultCommand (function ($args)
{
    echo 'Command "'. $args[0] .'" not founded. You should write correct command name';
})))->execute (array_slice ($argv, 1));

php index.php write kek lol arbidol

Вывод:

(исключение, т.к. не был использован параметр --glue)

php index.php write kek lol arbidol --glue ", "

Вывод:

kek, lol, arbidol

php index.php write kek lol arbidol --glue ", " --base64

Вывод:

a2VrLCBsb2wsIGFyYmlkb2w=

Разветвление команд

В анонимной функции команды вы можете создать новый менеджер команд с новыми командами. Тем самым вы можете сделать команды для... команды... да...

<?php

namespace ConsoleArgs;

(new Manager ([
    (new Command ('test', function ($args)
    {
        (new Manager ([
            new Command ('1', function ()
            {
                echo 'Enfesto Studio'. PHP_EOL;
            }),

            new Command ('2', function ()
            {
                echo 'Every Software'. PHP_EOL;
            })
        ]))->execute ($args);
    }))->addAlias ('alias_test')
]))->execute (array_slice ($argv, 1));

php index.php test 1

Вывод:

Enfesto Studio

php index.php alias_test 2

Вывод:

Every Software

Команда помощи

<?php

namespace ConsoleArgs;

$manager = new Manager ([
    (new Command ('write', function ($args, $params)
    {
        if (is_array ($params['--glue']))
            $params['--glue'] = $params['--glue'][0];
        
        echo implode ($params['--glue'], $args);
    }))
        ->setDescription ('Output entered message')
        ->addParams ([
            (new Param ('--glue', ' '))->addAlias ('-g')
        ])
]);

$manager
    ->addCommand (new HelpCommand ($manager))
    ->execute (array_slice ($argv, 1));

php index.php help

Вывод:

write — Output entered message
       Not required:
         --glue " " (-g)

Локализации

За локализации отвечает объект Locale. Подробнее - см. содержимое класса

Автор: Подвирный Никита. Специально для Enfesto Studio Group