kenjis / codeigniter-cli
A command-line tool for CodeIgniter 3.0
Installs: 33 578
Dependents: 1
Suggesters: 2
Security: 0
Stars: 94
Watchers: 11
Forks: 21
Open Issues: 9
Requires
- php: >=5.4.0
- aura/cli-kernel: ~2.0
- monolog/monolog: ~1.0
Requires (Dev)
- satooshi/php-coveralls: 0.6.*
This package is auto-updated.
Last update: 2024-10-29 04:20:00 UTC
README
This package provides a Cli tool for CodeIgniter 3.0.
This includes a few commands and you can create your commands easily.
This is based on Aura.Cli_Project 2.0.
Included Commands
generate migration ... Generates migration file skeleton.
migrate ... Run migrations.
migrate status ... List all migration files and versions.
seed ... Seed the database.
run ... Run controller.
Folder Structure
codeigniter/
├── application/
├── ci_instance.php ... script to generate CodeIgniter instance
├── cli ... command file
├── config/ ... config folder
└── vendor/
Requirements
- PHP 5.4.0 or later
composer
command- Git
Installation
Install this project with Composer:
$ cd /path/to/codeigniter/
$ composer require kenjis/codeigniter-cli --dev
Install command file (cli
) and config files (config/
) to your CodeIgniter project:
$ php vendor/kenjis/codeigniter-cli/install.php
- Above command always overwrites exisiting files.
- You must run it at CodeIgniter project root folder.
Fix the paths in ci_instance.php
if you need.
$system_path = 'vendor/codeigniter/framework/system'; $application_folder = 'application'; $doc_root = 'public'; // where index.php is
If you install CodeIgniter using codeigniter-composer-installer, you don't have to change them.
Usage
Show command list.
$ cd /path/to/codeigniter/
$ php cli
Show help for a command.
$ php cli help seed
Create Database Seeds
Seeder class must be placed in application/database/seeds
folder.
application/database/seeds/ProductSeeder.php
<?php class ProductSeeder extends Seeder { public function run() { $this->db->truncate('product'); $data = [ 'category_id' => 1, 'name' => 'CodeIgniter Book', 'detail' => 'Very good CodeIgniter book.', 'price' => 3800, ]; $this->db->insert('product', $data); $data = [ 'category_id' => 2, 'name' => 'CodeIgniter CD', 'detail' => 'Great CodeIgniter CD.', 'price' => 4800, ]; $this->db->insert('product', $data); $data = [ 'category_id' => 3, 'name' => 'CodeIgniter DVD', 'detail' => 'Awesome CodeIgniter DVD.', 'price' => 5800, ]; $this->db->insert('product', $data); } }
Create User Command
Command class name must be *Command.php
and be placed in application/commands
folder.
application/commands/TestCommand.php
<?php class TestCommand extends Command { public function __invoke() { $this->stdio->outln('<<green>>This is TestCommand class<<reset>>'); } }
Command Help class name must be *CommandHelp.php
and be placed in application/commands
folder.
application/commands/TestCommandHelp.php
<?php class TestCommandHelp extends Help { public function init() { $this->setSummary('A single-line summary.'); $this->setUsage('<arg1> <arg2>'); $this->setOptions(array( 'f,foo' => "The -f/--foo option description", 'bar::' => "The --bar option description", )); $this->setDescr("A multi-line description of the command."); } }
Reference
How to Run Tests
To run tests, you must install CodeIgniter first.
$ composer create-project kenjis/codeigniter-composer-installer codeigniter
$ cd codeigniter
$ composer require kenjis/codeigniter-cli:1.0.x@dev --dev
$ php vendor/kenjis/codeigniter-cli/install.php
$ cd vendor/kenjis/codeigniter-cli
$ composer install
$ phpunit