README

日本語 | Changelog | 変更履歴

An enhanced CodeIgniter 3 package providing extended core classes (controllers, models, views) and utility classes.

Table of Contents

• Features
• Requirements
• Installation
• Quick Start
• Configuration
• Usage Examples
• Testing
• Documentation
• License

Features

Core Extensions

• Enhanced Controllers - JSON response, template rendering, access control
• Advanced Models - Query caching, batch operations, helper methods
• Enhanced Router - Annotation-based access control

Utility Classes

• Image Processing - Resize, crop, format conversion, GIF frame extraction, PDF to image
• Video Processing - Video file manipulation and conversion
• File Operations - Advanced file and directory operations with locking
• CSV Handling - Import/export utilities
• Email - Template-based emails, Amazon SES integration
• REST Client - HTTP client for API integrations
• Security - Encryption/decryption, IP validation
• Validation - Custom rules (hostname, IP, CIDR, datetime, paths)
• Session Management - Database-backed sessions with custom columns
• Logging - Enhanced logging with context
• Template Engine - Twig integration with session variables

AWS Integration

• Amazon Rekognition - Face detection, comparison, and analysis
• Amazon SES - Reliable email delivery service

Requirements

• PHP 7.3.0 or later
• Composer
• PHP Extensions:
  • php-gd
  • php-mbstring
  • php-xml
  • php-imagick (optional, for GIF operations)

Optional: ImageMagick Installation

Required for extractFirstFrameOfGif method in \X\Util\ImageHelper.

Amazon Linux 2:

sudo yum -y install ImageMagick php-imagick

Amazon Linux 2023:

# Install ImageMagick and PECL
sudo dnf -y install ImageMagick ImageMagick-devel php-pear.noarch

# Install imagick extension
sudo pecl install imagick
echo "extension=imagick.so" | sudo tee -a /etc/php.ini

# Restart services
sudo systemctl restart nginx php-fpm

Installation

Create a new project using Composer:

composer create-project takuya-motoshima/codeigniter-extension myapp
cd myapp

Quick Start

1. Set Permissions

sudo chmod -R 755 public/upload application/{logs,cache,session}
sudo chown -R nginx:nginx public/upload application/{logs,cache,session}

2. Configure Web Server

Copy the Nginx configuration:

sudo cp nginx.sample.conf /etc/nginx/conf.d/myapp.conf
sudo systemctl restart nginx

3. Set Up Database

Import the database schema:

mysql -u root -p your_database < skeleton/init.sql

4. Build Frontend Assets

cd client
npm install
npm run build

5. Access Application

Open http://{your-server-ip}:3000/ in your browser.

Default Credentials:

• Email: robin@example.com
• Password: password

Screenshots

Configuration

Basic Config (application/config/config.php)

Access Control Setup

1. Define Default Route

In application/config/routes.php:

$route['default_controller'] = 'users/login';

2. Set Session Constant

In application/config/constants.php:

const SESSION_NAME = 'session';

3. Configure Hooks

In application/config/hooks.php:

use \X\Annotation\AnnotationReader;
use \X\Util\Logger;

$hook['post_controller_constructor'] = function() {
  if (is_cli()) return;

  $CI =& get_instance();
  $meta = AnnotationReader::getAccessibility($CI->router->class, $CI->router->method);
  $loggedin = !empty($_SESSION[SESSION_NAME]);

  if (!$meta->allow_http)
    throw new \RuntimeException('HTTP access is not allowed');
  else if ($loggedin && !$meta->allow_login)
    redirect('/users/index');
  else if (!$loggedin && !$meta->allow_logoff)
    redirect('/users/login');
};

$hook['pre_system'] = function () {
  $dotenv = Dotenv\Dotenv::createImmutable(ENV_DIR);
  $dotenv->load();
  set_exception_handler(function ($e) {
    Logger::error($e);
    show_error($e->getMessage(), 500);
  });
};

Usage Examples

Controllers

use \X\Annotation\Access;

class Users extends AppController {
  /**
   * @Access(allow_login=true, allow_logoff=false, allow_role="admin")
   */
  public function index() {
    $users = $this->UserModel->get()->result_array();
    parent::set('users', $users)->view('users/index');
  }

  /**
   * @Access(allow_http=true)
   */
  public function api() {
    $data = ['message' => 'Success'];
    parent::set($data)->json();
  }
}

Models

class UserModel extends AppModel {
  const TABLE = 'user';

  public function getActiveUsers() {
    return $this
      ->where('active', 1)
      ->order_by('name', 'ASC')
      ->get()
      ->result_array();
  }
}

Twig Templates

Session variables are automatically available:

// PHP
$_SESSION['user'] = ['name' => 'John Smith', 'role' => 'admin'];

{# Template #}
{% if session.user is defined %}
  <p>Welcome, {{ session.user.name }}!</p>
  {% if session.user.role == 'admin' %}
    <a href="/admin">Admin Panel</a>
  {% endif %}
{% endif %}

Using Utilities

// Image processing
use \X\Util\ImageHelper;
ImageHelper::resize('/path/to/image.jpg', '/path/to/output.jpg', 800, 600);

// File operations
use \X\Util\FileHelper;
FileHelper::makeDirectory('/path/to/dir', 0755);

// Encryption
use \X\Util\Cipher;
$encrypted = Cipher::encrypt('secret data', 'encryption-key');

// REST client
use \X\Util\RestClient;
$client = new RestClient(['base_url' => 'https://api.example.com']);
$response = $client->get('/users');

Testing

Run unit tests:

composer test

Test files are located in:

• __tests__/*.php - Test cases
• phpunit.xml - Configuration
• phpunit-printer.yml - Output format

Documentation

• API Documentation - Complete API reference
• Demo Application - Full working example
• Changelog - Version history and changes
• CodeIgniter 3 Guide - Official framework documentation

Generate PHPDoc

# Download phpDocumentor (one-time)
wget https://phpdoc.org/phpDocumentor.phar
chmod +x phpDocumentor.phar

# Generate docs
php phpDocumentor.phar run -d src/ --ignore vendor --ignore src/X/Database/Driver/ -t docs/

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Author

Takuya Motoshima

• GitHub: @takuya-motoshima
• Twitter: @TakuyaMotoshima
• Facebook: takuya.motoshima.7

License

MIT License