README

CodeIgniter 3 Framework Pack

Codeigniter 3 complete solution pack with enhanced & modern framework extensions

Codeigniter 3 is a great PHP framework with lite portability and high performance, but nowadays it is not so powerful and lacks of design pattern. There are still many maintenance requirements, even suitable development scenario for CodeIgniter 3, so this framework pack provides a total solution to enhance and modernize CodeIgniter 3 with collection of helpful extensions.

OUTLINE

• Requirements
• Installation
• Extensions
  • PSR-4
  • ORM Model
  • RESTful API
  • Widget
  • Unit Test
  • Queue Worker
• Configuration
• Best Practice
  • Server Environment
  • Application Structure

REQUIREMENTS

This library requires the following:

• PHP 5.4.0+
• CodeIgniter 3.0.0+
• Extensions Pack

INSTALLATION

Run Composer in your CodeIgniter project under the folder \application:

composer require yidas/codeigniter-pack

Check CodeIgniter application/config/config.php:

$config['composer_autoload'] = TRUE;

You could customize the vendor path into $config['composer_autoload']

EXTENSIONS

PSR-4

• yidas/codeigniter-psr4-autoload
  CodeIgniter 3 PSR-4 Autoloader for Application

ORM Model

• yidas/codeigniter-model
  CodeIgniter 3 Active Record (ORM) Standard Model with Laravel Eloquent & Yii2 AR like

RESTful API

• yidas/codeigniter-rest
  CodeIgniter 3 RESTful API Resource Controller

Widget

• yidas/codeigniter-widget
  CodeIgniter 3 Widget for reusable building view blocks

Unit Test

• yidas/codeigniter-phpunit
  CodeIgniter 3 PHPUnit Test extension library

Queue Worker

• yidas/codeigniter-queue-worker
  CodeIgniter 3 Queue Worker Management Controller

CONFIGURATION

The necessary configurations of the extensions are below:

• UnitTest Configuration

BEST PRACTICE

Server Environment

Codeigniter 3 server configuration for Nginx & Apache

Application BaseUrl Setting (Set / base for base_url at least)

Application Structure

Codeigniter3/
├── application/            CI app root
    ├── cache/              CI cache
    ├── config/             CI app configurations
    ├── contracts           PSR-4 Contracts (ex.Interfaces)
    ├── controllers/        CI app controllers
    ├── core/               CI app level core extension
    ├── helpers/            PSR-4/CI helpers (Recommended to use PSR-4 only)
    ├── hooks/              CI app hooks
    ├── language/           CI app language
    ├── libraries/          CI app components (One time loading)
    ├── logs/               CI app logs
    ├── models/             CI app models (ORM/Active-Record entities)
    ├── presenters/         PSR-4 Presenters
    ├── services/           PSR-4 Services
    ├── third_party/        CI app third party
    ├── vender/             Composer vendor
    ├── views/              CI app views
        └── controller-name/    Each controller has it own view folder
            └── action.php      Each controller action has it own view file
    └── widgets/            PSR-4 Widgets
├── assets/                 Public assets
└── system/                 CI Framework system