whagency/php-cli-framework

PHP CLI framework

1.0.2 2018-06-26 12:05 UTC

This package is auto-updated.

Last update: 2024-03-19 14:18:24 UTC


README

PHP CLI framework - good console solution for developing and performing modules for regular tasks with CRON and casual one time tasks like operating with data of the remote databases, export and import popular datatypes, load and optimize images etc.

Directory structure

files/		contains files of all modules
tmp/		contains tempory files and logs
vendor/		contains dependent 3rd-party packages
webheads/	contains core classes of the framework and custom classes and libs

Included libs

  • PhpSpreadsheet - PHP library for reading and writing spreadsheet files
  • ActiveRecord - access data in a database
  • ImageWorkshop - library that helps you to manage images
  • TinyPNG - optimization images
  • CLImate - library for output colored text, special formats, and other in terminal
  • mPDF - generate PDF files from HTML with Unicode/UTF-8 and CJK support
  • cli-progress-bar - progress bar for cli apps

Installation

The preferred way to install this extension is through composer.

  1. Install framework to you directory, for example php-cli-framework
php composer.phar create-project --prefer-dist whagency/php-cli-framework php-cli-framework
  1. Go to the installation directory
cd php-cli-framework
  1. Run framework via console
php core
// base starting

php core info
// display all modules and action list

php core add
// add new module and/or action

php core module/action
// run my custom module/action
  1. Also, you can run framework in WEB mode with your web server
http://localhost/php-cli-framework/module/action