Командная строка cli

В модуле, опционально, может быть файл, который хранит класс для работы модуля через интерфейс cli. Это дает возможность создавать функционал который отвязан от действий пользователя и может запускаться автоматически или по определенному расписанию.

Файл ДОЛЖЕН называться начиная с Mod, название модуля и Cli.php, например ModOrdersCli.php. Внутри себя он ДОЛЖЕН хранить класс с таким же названием, например ModOrdersCli.

Для запуска в интерфейсе cli требуется выполнить команду $ php core2/cli.php --module orders --action exampleMethod --param 123 --param "foo bar". При этом в классе должен существовать публичный метод exampleMethod, у которого есть два входящих параметра. За дополнительным описанием по работе с командной строкой можно обратиться вызвав $ php core2/cli.php --help". Вызвав команду приведенную выше, будет запущен метод exampleMethod с переданными в команде параметрами вставленными по порядку их следования.

Подобные методы можно вызывать из модуля системы cron (имеется в виду не linux crontab) и там же можно настраивать периодичность их выполнения. Для выбора методов происходит рефакторинг кода из этого файла и вытаскивается описание методов, что дает возможность использовать комментарии к методу как название задачи. РЕКОМЕНДУЕТСЯ кратко описывать назначение таких методов.

require_once DOC_ROOT . 'core2/inc/classes/CommonCli.php';

/**
 * 
 */
class ModOrdersCli extends \Core2\CommonCli {


    /**
     * Тестовый cli метод 
     * @param int $id
     * @param string $text
     * @return void
     */
    public function exampleMethod(int $id, string $text): void {
       echo "123"
    }
}