この記事では、CodeIgniter 4のHooksについて以下の観点から詳しく解説します。

• フックの基本概念と役割
• 使用できるイベントの一覧とタイミング
• 実用的なサンプルコード
• サービスプロバイダを活用した高度なフック管理
• 実運用における注意点とベストプラクティス

初心者の方はもちろん、すでにCodeIgniter 4を業務で利用している中級者以上の方にも、実践的な活用のヒントとなる内容を網羅的に解説します。

フックとは何か？CodeIgniterにおける位置づけ

フックとは、CodeIgniterのライフサイクルの特定ポイントに処理を追加できる仕組みです。たとえば、「すべてのリクエストが来る前にIP制限をかけたい」「コントローラが実行される直前にログ出力したい」といったニーズに対して、コアコードを汚さずスマートに対応できます。

CodeIgniter 3では、application/config/hooks.phpに配列形式で記述するややレガシーな形式でしたが、CodeIgniter 4ではよりモダンに、イベントベースでの登録が可能になりました。これにより、PHPのオブジェクト指向的な設計とも親和性が高まり、テスト可能なコード設計も容易になります。

利用可能なイベント一覧と活用例

CodeIgniter 4では、以下のようなイベントが用意されており、アプリケーションの特定のタイミングで処理を挟むことが可能です。

これらのイベントに対してフックを登録することで、アプリケーション全体の挙動を柔軟にカスタマイズできます。

実践：IPアドレスによるアクセス制限のフックを実装

以下に、特定のIP以外からのアクセスを拒否するシンプルなフックの例を紹介します。

app/Hooks/CheckIPHook.php

namespace App\Hooks;

class CheckIPHook
{
    public static function check()
    {
        $allowedIPs = ['127.0.0.1', '192.168.0.1'];
        $clientIP = $_SERVER['REMOTE_ADDR'] ?? '0.0.0.0';

        if (!in_array($clientIP, $allowedIPs)) {
            http_response_code(403);
            exit('Access denied for IP: ' . $clientIP);
        }
    }
}

このフックをイベントに登録します：

app/Config/Events.php

use App\Hooks\CheckIPHook;
use CodeIgniter\Events\Events;

Events::on('pre_system', [CheckIPHook::class, 'check']);

このように登録することで、アプリケーション全体でIP制限が適用されます。

実践：すべてのレスポンスにカスタムヘッダーを追加

X-App-Versionという独自ヘッダーをレスポンスに追加する例です。

app/Hooks/AddHeaderHook.php

namespace App\Hooks;

class AddHeaderHook
{
    public static function apply()
    {
        header('X-App-Version: 1.0.0');
    }
}

app/Config/Events.php

use App\Hooks\AddHeaderHook;

Events::on('post_system', [AddHeaderHook::class, 'apply']);

応用：サービスプロバイダでのフック登録

イベント登録をEvents.phpにベタ書きするのではなく、サービスプロバイダを使うことで管理しやすくなります。

app/Providers/HookEventProvider.php

namespace App\Providers;

use CodeIgniter\Events\EventsInterface;
use CodeIgniter\Service\ServiceProvider;
use App\Hooks\CheckIPHook;
use App\Hooks\AddHeaderHook;

class HookEventProvider extends ServiceProvider
{
    public function register(): void {}

    public function boot(EventsInterface $events): void
    {
        $events->on('pre_system', [CheckIPHook::class, 'check']);
        $events->on('post_system', [AddHeaderHook::class, 'apply']);
    }
}

このファイルを作成後、Autoload.phpの$psr4に追加すれば自動で読み込まれます。

注意点とベストプラクティス

注意点

• pre_systemではLoggerやConfigが使えません。
• header系の出力処理はpost_system以前に行う必要があります。
• 無限ループを招くような処理やエラーハンドリングには慎重な設計が必要です。

ベストプラクティス

• 責任の明確な単機能クラス設計（1フック = 1責務）
• 名前空間で機能ごとに整理する
• 環境（開発／本番）に応じた動作切り替えを意識する
• テスト用・開発用フックは明示的にON/OFF制御できるようにする

まとめ

CodeIgniter 4のHooks機能は、フレームワークの処理に柔軟に介入する強力な仕組みです。Filterのようなルーティングベースの仕組みよりも、より低レベルでの制御が可能なため、セキュリティ・ロギング・バージョン管理・外部連携などさまざまなニーズに対応できます。

うまく使えば、処理の重複を避けてDRYなコードを実現できますが、設計や依存の整理を怠るとトラブルの原因にもなります。責任範囲を明確にしたフック設計を心がけ、CodeIgniterの柔軟なイベントシステムを最大限活用していきましょう。

Entityの存在意義と役割

Entityとは？

CodeIgniter4のEntityは、データベースから取得したデータをオブジェクト指向的に操作するための仕組みです。単なる配列やstdClassではなく、データのバリデーション・整形・ミューテーションを簡単に行えるのが特徴です。

なぜEntityを使うのか？

• データの一貫性を保つ
  直接データを変更するのではなく、Entityを介して操作することで、バリデーションや加工処理を統一できる。
• getter/setterの活用で安全性を向上
  getFullName() のようなカスタムメソッドを作成できるため、ロジックを一元管理しやすい。
• データのミューテーション（変換）
  setPassword() でパスワードのハッシュ化を自動化するなど、データ変換を簡単に実装できる。

Entityの使用例

Entityクラスの作成

まずは、app/Entities/User.php にEntityクラスを作成します。

namespace App\Entities;

use CodeIgniter\Entity\Entity;

class User extends Entity
{
    // 自動的にキャストするフィールド
    protected $attributes = [
        'id'       => null,
        'username' => null,
        'email'    => null,
        'password' => null,
    ];

    // パスワードのハッシュ化
    public function setPassword(string $password)
    {
        $this->attributes['password'] = password_hash($password, PASSWORD_DEFAULT);
        return $this;
    }

    // フルネームを取得する例（仮）
    public function getFullName()
    {
        return $this->attributes['first_name'] . ' ' . $this->attributes['last_name'];
    }
}

Entityをモデルと組み合わせる

次に、Entityを利用するために、UserModel にEntityクラスを設定します。

namespace App\Models;

use CodeIgniter\Model;

class UserModel extends Model
{
    protected $table = 'users';
    protected $primaryKey = 'id';
    
    protected $returnType = 'App\Entities\User'; // ここでEntityを指定する
    protected $allowedFields = ['username', 'email', 'password'];

    // 自動的にタイムスタンプを更新
    protected $useTimestamps = true;
}

コントローラーでの使用例

use App\Models\UserModel;
use App\Entities\User;

$userModel = new UserModel();

// 新しいユーザーの作成
$user = new User();
$user->username = 'testuser';
$user->email = 'test@example.com';
$user->setPassword('securepassword');

$userModel->save($user);

setPassword() を呼ぶことで、自動的にパスワードをハッシュ化できます。

データ取得時の活用

$user = $userModel->find(1);
echo $user->getFullName(); // フルネームを取得

Entityを使わない場合との比較

Entityなし（配列ベースの管理）

$data = [
    'username' => 'testuser',
    'email' => 'test@example.com',
    'password' => password_hash('securepassword', PASSWORD_DEFAULT),
];

$userModel->insert($data);

この方法でも保存は可能ですが、ロジックをコントローラーに書いてしまうため、コードの再利用性や可読性が低下します。

Entityあり

Entityを使用すると、バリデーションやデータ変換を統一でき、オブジェクト指向的に管理できるため、スッキリしたコードが書けます。

まとめ

Entityを使うことで、データをオブジェクトとして扱い、バリデーションや整形を一元管理できるため、よりクリーンなコードを実現できます！

背景

現在、私が運用しているプロジェクトは、CodeIgniter3をベースにした中規模なウェブアプリケーションです。初期の頃はMVC構成で十分だったものの、機能追加やページ数の増加とともに、コントローラーやビューが肥大化し、保守性が低下していきました。

特に、ある機能を別の機能でも使い回したいとき、毎回コピペやincludeを駆使するのは面倒で非効率。そんなときに目を付けたのが「HMVCパターン」でした。

しかし、既存のModelはかなり作り込まれており、ゼロから作り直すのは現実的ではありません。そこで、Modelは既存のものをそのまま使用しつつ、HMVCを導入することでコントローラーとビューをモジュール化し、効率的な開発環境を目指すことにしました。

HMVCとは？

HMVC（Hierarchical Model-View-Controller）は、MVCの各要素をモジュール単位で管理するアーキテクチャです。従来のMVCでは、コントローラー、モデル、ビューがそれぞれ一つのディレクトリに配置されますが、HMVCでは「モジュール」ごとにそれらをグループ化できます。

例えば、application/modulesディレクトリ内に以下のような構造でモジュールを配置します。

application/modules/
  blog/
    controllers/
    views/
    models/
  shop/
    controllers/
    views/
    models/

これにより、特定の機能を独立して管理・再利用できるようになります。

導入手順

ライブラリのダウンロード

wiredesignzのcodeigniter-modular-extensions-hmvcをGitHubからダウンロードします。

GitHub - codinghamster/codeigniter-modular-extensions-hmvc

Contribute to codinghamster/codeigniter-modular-extensions-hmvc development by creating an account on GitHub.

github.com

CodeIgniterへの組み込み

ダウンロードしたMXディレクトリをapplication/third_partyに配置します。

次にcoreディレクトリにあるMY_Controller.phpとMY_Router.phpを自プロジェクトのapplication/coreにコピーします。

config.phpを修正

application/config/config.phpを次のように修正します。

$config['modules_locations'] = array(
    APPPATH.'modules/' => '../modules/',
);

モジュールの作成

例えば、ブログ機能をモジュールとして作成する場合

application/modules/blog/controllers/Blog.php

application/modules/blog/views/index.php

※Modelは既存のapplication/models内のものを使用

モジュールの利用

モジュールから別のモジュールを呼び出す際もシンプルです。

$this->load->module('shop/cart');
$this->cart->add_item($item_id);

実装のポイント

• Modelは既存のものをそのまま使用
  新たにModelを作る必要がないため、導入コストを抑えられる。
• 共通機能のモジュール化
  例えば、ログイン処理やフォームバリデーションなど、複数ページで使う機能をモジュール化することで、DRY（Don’t Repeat Yourself）を徹底。
• チーム開発でのメリット
  複数人で開発する場合も、モジュールごとに担当を分けることでコンフリクトを減らせる。

まとめ

CodeIgniter3にHMVCパターンを導入することで、コードの可読性や保守性が劇的に向上しました。特に、既存のModelを活かしつつ導入できたことで、スムーズに移行できたのが大きなポイントです。

「CodeIgniterのMVCが限界かも…」と感じている方は、ぜひHMVCの導入を検討してみてください。

実際、私が.env導入に踏み切ったのは、ローカル・ステージング・本番と複数環境を使い分けるプロジェクトで、ちょっとした設定ミスで本番DBに接続してしまい、ヒヤッとしたことがきっかけでした。

「これはマズイ、何とかしないと…」

Laravelではおなじみの.env。CI3でも使えたら便利だなと思い、試行錯誤の末、無事導入しました。その方法を、同じ悩みを抱える皆さんと共有したいと思います。

.envファイルとは？

.envファイルは、アプリケーションの設定値を”環境変数”として定義・管理するためのファイルです。データベース接続情報やAPIキー、アプリの動作モードなどを、この1つのファイルで切り替え可能にします。

CI3では標準サポートされていませんが、PHPのvlucas/phpdotenvライブラリを活用すれば、簡単に導入できます。

導入で何が変わるのか？

• 設定ミスが減る
  本番・開発で設定を間違えて大惨事…を防げる！
• セキュリティ向上
  APIキーやDBパスワードをコードに直書きしない。
• メンテナンス楽々
  環境追加や設定変更が超簡単。

導入手順

.envファイルを作成

プロジェクトのルートに.envを作ります

CI_ENV=development
DB_HOST=localhost
DB_USER=root
DB_PASS=secret
DB_NAME=ci_project

.gitignoreに追加

.env

phpdotenvをインストール

composer require vlucas/phpdotenv

index.phpを編集

require __DIR__ . '/../vendor/autoload.php';
$dotenv = Dotenv\Dotenv::createImmutable(__DIR__ . '/../');
$dotenv->load();

設定ファイルでgetenv()を使う

application/config/database.phpなどで

'hostname' => getenv('DB_HOST'),
'username' => getenv('DB_USER'),
'password' => getenv('DB_PASS'),
'database' => getenv('DB_NAME'),

導入後の変化と感想

.envを導入してから、環境切り替え時のストレスが一気に減りました。何より、「本番に接続してしまった…！」という冷や汗から解放されたのは大きいです。CI3を使い続けるなら、ぜひ導入をおすすめします！

GitHub - vlucas/phpdotenv: Loads environment variables from `.env` to `getenv()`, `$_ENV` and `$_SERVER` automagically.

Loads environment variables from `.env` to `getenv()`, `$_ENV` and `$_SERVER` automagically. - vlucas/phpdotenv

github.com

インストールと設定

ダウンロードとインストール

「HybridIgniter」ライブラリをダウンロードし、CodeIgniterのapplication/libraries/ディレクトリに配置します。

HybridAuthライブラリのダウンロード

HybridAuthの公式リポジトリからHybridAuthをダウンロードし、application/third_party/HybridAuth/に設置します。

設定ファイルの作成

application/config/にhybridauthlib.phpという設定ファイルを作成し、以下のように設定します。

$config['hybridauth'] = [
    "base_url" => base_url("hauth/endpoint"),
    "providers" => [
        "Google" => [
            "enabled" => true,
            "keys" => ["id" => "YOUR_GOOGLE_CLIENT_ID", "secret" => "YOUR_GOOGLE_CLIENT_SECRET"],
        ],
        "Facebook" => [
            "enabled" => true,
            "keys" => ["id" => "YOUR_FACEBOOK_APP_ID", "secret" => "YOUR_FACEBOOK_APP_SECRET"],
        ],
        "Twitter" => [
            "enabled" => true,
            "keys" => ["key" => "YOUR_TWITTER_CONSUMER_KEY", "secret" => "YOUR_TWITTER_CONSUMER_SECRET"],
        ],
    ],
];

各プロバイダー（Google、Facebook、Twitterなど）のクライアントIDやシークレットを入力します。

コントローラーの作成

application/controllers/Hauth.phpというコントローラーを作成し、以下のように認証の処理を実装します。

<?php
defined('BASEPATH') OR exit('No direct script access allowed');

class Hauth extends CI_Controller {

    public function __construct() {
        parent::__construct();
        $this->load->library('hybridauthlib');
    }

    public function login($provider) {
        try {
            $service = $this->hybridauthlib->authenticate($provider);
            if ($service->isUserConnected()) {
                $userProfile = $service->getUserProfile();
                // ユーザーデータの取得と保存処理
                print_r($userProfile);
            }
        } catch(Exception $e) {
            show_error($e->getMessage());
        }
    }

    public function endpoint() {
        $this->hybridauthlib->process();
    }
}

loginメソッドで認証プロバイダ（Google、Facebookなど）を指定し、ユーザー認証を行います。

ルーティングの設定

application/config/routes.phpに、HybridAuthのエンドポイントとログインパスを追加します。

$route['hauth/(:any)'] = 'hauth/$1';

利用方法

認証プロバイダーのURLにアクセスすることで、ユーザー認証を開始できます。

https://example.com/hauth/login/Google

認証後、ユーザーのプロフィール情報が$userProfileに格納されます。これを使って、ユーザーのデータを取得したり、ユーザー情報をデータベースに保存することができます。

GitHub - hybridauth/hybridauth: Open source social sign on PHP Library. HybridAuth goal is to act as an abstract api between your application and various social apis and identities providers such as Facebook, Twitter and Google.

Open source social sign on PHP Library. HybridAuth goal is to act as an abstract api between your application and variou...

github.com

MY_Modelという共通ベースモデルを作成する

CodeIgniterでは、MY_ プレフィックスをつけたファイルを作成することで、フレームワークのコアクラスを拡張できます。これを利用して、全てのモデルに共通する機能をまとめたベースモデルを作成しましょう。

ステップ

コアクラスにベースモデルを作成

application/core/MY_Model.php というファイルを作成し、共通のロジックを記述します。

<?php
class MY_Model extends CI_Model {

    public function __construct() {
        parent::__construct();
    }

    public function find($id, $table) {
        return $this->db->where('id', $id)->get($table)->row();
    }

    public function get_all($table) {
        return $this->db->get($table)->result();
    }

    public function insert($table, $data) {
        return $this->db->insert($table, $data);
    }

    public function update($id, $table, $data) {
        return $this->db->where('id', $id)->update($table, $data);
    }

    public function delete($id, $table) {
        return $this->db->where('id', $id)->delete($table);
    }
}

モデルでベースモデルを継承

例えば、User_model や Product_model などのモデルでこの共通ベースモデルを継承します。

class User_model extends MY_Model {

    protected $table = 'users';

    public function __construct() {
        parent::__construct();
    }

    public function get_active_users() {
        return $this->db->where('status', 'active')->get($this->table)->result();
    }
}

モデル内での共通処理を簡素化する

ベースモデルを作成することで、データベース操作に関する共通処理を各モデルで簡単に行えるようになります。特に、テーブル名を各モデルで設定し、ベースモデルのメソッドで利用することで、コードが大幅に短縮されます。

class MY_Model extends CI_Model {

    protected $table;

    public function find($id) {
        return $this->db->where('id', $id)->get($this->table)->row();
    }

    public function get_all() {
        return $this->db->get($this->table)->result();
    }

    public function insert($data) {
        return $this->db->insert($this->table, $data);
    }

    public function update($id, $data) {
        return $this->db->where('id', $id)->update($this->table, $data);
    }

    public function delete($id) {
        return $this->db->where('id', $id)->delete($this->table);
    }
}

共通のバリデーションルールをベースモデルに追加

各モデルでよく使うバリデーションを共通化するために、ベースモデルにバリデーションルールを追加します。これにより、モデルごとのコードの重複を避け、管理しやすくなります。

ベースモデルにバリデーションルールを追加

class MY_Model extends CI_Model {

    protected $table;
    protected $validation_rules = array();

    public function __construct() {
        parent::__construct();
        $this->load->library('form_validation');
    }

    public function validate($data) {
        $this->form_validation->set_data($data);
        $this->form_validation->set_rules($this->validation_rules);

        if ($this->form_validation->run() == FALSE) {
            return $this->form_validation->error_array();
        } else {
            return TRUE;
        }
    }
}

モデルごとのバリデーションルール設定例

class User_model extends MY_Model {

    protected $table = 'users';

    public function __construct() {
        parent::__construct();
        $this->validation_rules = array(
            array(
                'field' => 'name',
                'label' => 'Name',
                'rules' => 'required'
            ),
            array(
                'field' => 'email',
                'label' => 'Email',
                'rules' => 'required|valid_email'
            )
        );
    }
}

まとめ

これらのテクニックを使うことで、CodeIgniter 3でのモデル管理が簡単かつ効率的になります。共通処理をベースモデルにまとめることで、コードの重複を減らし、保守性を向上させることができます。ぜひ、これらの技を活用して、より良い開発環境を整えてください。

ここではLinux環境へCodeIgniter3のフレームワークをセットアップする方法について説明します。

またドキュメントルートは

/var/www/html/codeigniter3/public

とし、ホスト名はwww.example.comとします。

フレームワークの取得・設置

サーバへターミナル等でログイン後、次のコマンドでディレクトリ移動します。

# cd /var/www/html/

　次のダウンロードサイトからCodeIgniter v3.2.0-dev (Current version)のリンクURLを取得します。

CodeIgniter のダウンロード — CodeIgniter 3.2.0-dev ドキュメント

codeigniter.jp

次のようにURLを指定してコマンドを実行します。

# wget https://codeload.github.com/bcit-ci/CodeIgniter/zip/develop

コマンド実行後developというファイルが取得されますが、このファイル名では何のファイルが不明なので次のように名前変更します。

# mv develop develop.zip

次にこのファイルを解凍します。

# unzip develop.zip

解凍後、CodeIgniter-developのファイルの存在が確認できますが更に次のコマンドで名前変更します。

# mv CodeIgniter-develop codeigniter3

ファイル構造の変更

Codeigniter3内のファイル構造は次の通りです。

/var/www/html
└ codeigniter3
　├application(ディレクトリ)
　├build-release.sh
　├composer.json
　├contributing.md
　├DCO.txt
　├.editorconfig
　├.github(ディレクトリ)
　├.gitignore
　├index.php
　├license.txt
　├readme.rst
　├system(ディレクトリ)
　└tests(ディレクトリ)

上記構造のうちドキュメントルートに設置する予定のindex.phpを起点とするとsystemディレクトリとapplicationディレクトリは公開する必要のないディレクトリになりキー情報やこの後設定するデータベースの接続情報など、外部に漏れてはいけない状況がドキュメントルート配下に配置環境の為、セキュアではありません。

尚、systemディレクトリやapplicationディレクトリ内のファイルは全て

<?php
defined('BASEPATH') OR exit('No direct script access allowed');

のように定数によるアクセス制限を掛けている為、直接アクセスする事はできない意味では安全ですが、これはPHPが正常に動作した場合に限り安全というには根本的な対策にはなっていません。

この対策としてsystemディレクトリとapplicationディレクトリをドキュメントルート配下でなない上位ディレクトリへ設置するように変更します。

ディレクトリの作成・ファイルの移動

# mkdir public

publicディレクトリを作成します。

mv index.php ./public/

index.phpをpublicディレクトリ内へ移動します。

ディレクトリ設定の変更

index.phpを次のように変更します。

        // 93行目付近
	$system_path = '../system'; 

        // 110行目付近
	$application_folder = '../application';

上記の更新にてドキュメントルート配下からその上位ディレクトリへの変更が完了となります。

設定ファイルの変更

ホスト名の指定など次のファイルを編集します。

application/config/config.php

設定内容は次のようにキー名と値の構成になります。

$config[キー名] = '値’

次の表は初期設定の際に必要となる主要な設定情報の一覧になります。

データベースの設定

以下のファイルを編集しデータベースMySQLの接続情報を設定します。

application/config/database.php

$db['default'] = array(
	'dsn'	=> '',
	'hostname' => 'ホスト名',
	'username' => 'DBユーザー名',
	'password' => 'パスワード',
	'database' => 'データ',
	'dbdriver' => 'mysqli',
	'dbprefix' => '',
	'pconnect' => FALSE,
	'db_debug' => (ENVIRONMENT !== 'production'),
	'cache_on' => FALSE,
	'cachedir' => '',
	'char_set' => 'utf8',
	'dbcollat' => 'utf8_general_ci',
	'swap_pre' => '',
	'encrypt' => FALSE,
	'compress' => FALSE,
	'stricton' => FALSE,
	'failover' => array(),
	'save_queries' => TRUE
);

綺麗なURLにする

例えば複数の会員情報の一覧から特定の会員IDが5番のプロフィール詳細ページは一般的に次のようになります。

http://www.example.com/index.php/profile/view/id/5

上記URLではindex.phpのインデックスファイルの後にパラメータがスラッシュ区切りで構成される為、綺麗ではないのでindex.phpを削除して綺麗にURLにする為、次のファイルを作成・編集します。

public/.htaccess

RewriteEngine On
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule ^(.*)$ index.php/$1 [L]

ライブラリ・ヘルパーの自動読み込み

常に使用するライブラリや頻繁に使用するヘルパーなどは自動読み込み設定する事でコントローラー内で都度読み込み宣言を記載する手間を省く事ができます。

次のファイルを編集します。

application/config/autoload.php

// ライブラリ自動読み込み
$autoload['libraries'] = [
  'database',
  'session',
];

// ヘルパー自動読み込み
$autoload['helper'] = [
  'url',
  'form',
];

これで環境の用意はひとまず完了です。

これ以外に必要な情報は別途ドキュメントを参照して編集してください。

CodeIgniter ユーザガイド — CodeIgniter 3.2.0-dev ドキュメント

codeigniter.jp

設定

プロパティについて、次に説明します。

<?php

namespace App\Models;

use CodeIgniter\Model;

class UserModel extends Model
{
    protected $table = 'users';
    protected $primaryKey = 'user_id';
    protected $useAutoIncrement = false;
    protected $returnType= 'array';
    //protected $returnType = User::class;
    protected $useSoftDeletes = true;
    protected $allowedFields = [
        'username',
        'email',
        'password',
    ];
    protected bool $allowEmptyInserts = false;

    // date property
    protected $useTimestamps = true;
    protected $dateFormat = 'datetime';
    protected $createdField = 'created_at';
    protected $updatedField = 'updated_at';
    protected $deletedField = 'deleted_at';
}

$table

利用するテーブル物理名を設定するプロパティです。
必ず設定する必要があります。

$primaryKey

テーブルのプライマリーキーを設定するプロパティです。
デフォルトはidなので、ほとんどのテーブルでは設定しなくても問題ありませんが、
id以外のカラムをPKにする場合は、必ず設定する必要があります。

$useAutoIncrement

オートインクリメント機能を利用するか設定するプロパティです。
デフォルトはtrueなので、ほとんどのテーブルでは設定しなくても問題ありませんが、
オートインクリメントではないカラムをPKにする場合は、falseに設定する必要があります。

$returnType

CRUD実行時に返却される結果の形式を設定するプロパティです。
デフォルトはarrayなので配列形式で返されますが、Entity形式も指定できます。

$useSoftDeletes

delete()でのレコード削除を論理削除にするか設定するプロパティです。
デフォルトはfalseなので、物理削除テーブルとして扱われます。
trueに設定すると論理削除になるだけでなく、find()による取得時も論理削除されたデータは取得されないような条件でSQLが構築されます。

$allowedFields

登録/更新を許可するカラムを設定するプロパティです。
指定されていないカラムは値をセットしていても無視されるので、意図しないカラムの更新を防ぐことが出来ます。
なお、取得には影響しません。

$allowEmptyInserts

空データのinsertを許容するか設定するプロパティです。
デフォルトはfalseなので、許容されません。
何かしらの理由で。空データをまず登録した後で必要な値に更新したいケースがあれば、利用することがありそうですが、基本的には利用しないと思います。

$useTimestamps

登録や更新に、現在日付を自動的に登録するか設定するプロパティです。
デフォルトはfalseです。
trueにした場合は、$dateFormatで指定した形式で自動的に登録します。

$dateFormat

自動登録する日付の型を設定するプロパティです。
デフォルトはdatetimeですが、他にもdateかintが設定できます。

$createdField

登録日時に現在日時を登録するカラムを設定するプロパティです。
デフォルトは、created_atです。

$updatedField

更新日時に現在日時を登録するカラムを設定するプロパティです。
デフォルトは、updated_atです。

$deletedField

削除日時に現在日時を登録するカラムを設定するプロパティです。
デフォルトは、deleted_atです。

バリデーション

次に、モデルを利用した登録/更新時にバリデーションを行う際の各種設定です。

<?php

namespace App\Models;

use CodeIgniter\Model;

class UserModel extends Model
{
    protected $validationRules = [
        'username'     => 'required|max_length[30]|alpha_numeric_space|min_length[3]',
        'email'        => 'required|max_length[254]|valid_email|is_unique[users.email]',
        'password'     => 'required|max_length[255]|min_length[8]',
        'pass_confirm' => 'required_with[password]|max_length[255]|matches[password]',
    ];
    protected $validationMessages = [
        'email' => [
            'is_unique' => '既に登録されているメールアドレスです。',
        ],
    ];
    protected $skipValidation = false;
    protected $cleanValidationRules = true;
}

$validationRules

バリデーションルールを配列形式で設定するプロパティです。
デフォルトは、[]です。

$validationMessages

バリデーションエラー時のメッセージを配列形式で設定するプロパティです。
デフォルトは、[]です。

$skipValidation

登録/更新時にバリデーションを行うか設定するプロパティです。
デフォルトは、falseなのでバリデーションは行います。
ただ、前述の$validationRulesを指定しないと行われません。

$cleanValidationRules

渡されたデータに存在しないバリデーションルールは、バリデーション対象から除外するか設定するプロパティです。
デフォルトはtrueなので除外されます。
更新時に一部カラムだけ更新したい場合に、trueにしておけばバリデーションエラーを回避できます。

コールバック

各CRUD実行時に使用可能なコールバックです。

<?php

namespace App\Models;

use CodeIgniter\Model;

class UserModel extends Model
{
    protected $allowCallbacks = true;
    protected $beforeInsert = [];
    protected $afterInsert = [];
    protected $beforeUpdate = [];
    protected $afterUpdate = [];
    protected $beforeFind = [];
    protected $afterFind = [];
    protected $beforeDelete = [];
    protected $afterDelete = [];
}

$allowCallbacks

コールバック処理を許可するか設定するプロパティです。
デフォルトはtrueなので、コールバック処理が実装されていれば実行されます。

$beforeInsert、$beforeUpdate、$beforeFind、$beforeDelete

それぞれ、登録/更新/取得/削除前に行う処理を記載するメソッドです。
メソッドに渡される引数はそれぞれ異なります。

$afterInsert、$afterUpdate、$afterFind、$afterDelete

それぞれ、登録/更新/取得/削除後に行う処理を記載するメソッドです。
beforeと同様、メソッドに渡される引数はそれぞれ異なります。

CRUDメソッド

find($pk)

PKを条件にデータを取得するメソッドです。
論理削除されたデータは取得されません。

$user = $userModel->find(1); // PKで単一取得
$user = $userModel->find([1, 2]); // PKで複数取得
// SELECT * FROM `users` WHERE `users`.`deleted_at` IS NULL AND `users`.`id` IN (1,2)

findColumn($columeName)

単一カラムの取得を行うメソッドです。
論理削除されたデータは取得されません。

$user = $userModel->findColumn('login_id');
// SELECT `login_id` FROM `users` WHERE `users`.`deleted_at` IS NULL

findAll($limit, $offset)

データを全件取得するメソッドです。
条件を絞りたい場合はクエリビルダーのwhereなどを利用します。
論理削除されているデータは取得されません。

$user = $userModel->where('user_code', 'test')->findAll();
// SELECT * FROM `users` WHERE `user_code` = 'test' AND `users`.`deleted_at` IS NULL

first()

単一のデータを取得するメソッドです。
条件を絞りたい場合はクエリビルダーのwhereなどを利用します。
論理削除されているデータは取得されません。

$user = $userModel->where('user_code', 'test')->first();
// SELECT * FROM `users` WHERE `user_code` = 'test' AND `users`.`deleted_at` IS NULL  LIMIT 1

withDeleted()

論理削除されたデータも取得したい時に利用するメソッドです。

$user = $userModel->where('user_code', 'test')->withDeleted()->findAll();
// SELECT * FROM `users` WHERE `user_code` = 'test'

onlyDeleted()

論理削除されたデータのみ取得したい時に利用するメソッドです。

$user = $userModel->onlyDeleted()->where('user_code', 'test')->findAll();
// SELECT * FROM `users` WHERE `user_code` = 'test' AND `users`.`deleted_at` IS NOT NULL

insert($data)

新規登録したい場合に利用するメソッドです。

$data = [
  'login_id' => 'user1',
  'password' => 'password',
];
$userModel->insert($data); // return PK
$userModel->insert($data, false); // returnクエリ成否。成功(true)、失敗(false)
$userModel->getInsertID(); // return 登録したPKの値
// INSERT INTO `users` (`login_id`, `password`, `created_at`, `updated_at`) VALUES ('user1', 'password', '2024-04-23 09:20:33', '2024-04-23 09:20:33')

allowEmptyInserts()

空のデータを新規登録したい場合に利用するメソッドです。

$userModel->allowEmptyInserts()
// created_at, updated_atの自動登録をモデルで設定している場合
// INSERT INTO `users` (`created_at`, `updated_at`) VALUES ('2024-04-23 09:33:57', '2024-04-23 09:33:57')
// created_at, updated_atの自動登録をモデルで設定していない場合
// INSERT INTO `users` VALUES ()

update($pk, $data)

データを更新したい場合に利用するメソッドです。

$data = [
   'login_id' => 'user1',
   'password' => 'password',
];
$userModel->update(1, $data); // return クエリ成否。返り値は成功(true)、失敗(false)。
// UPDATE `users` SET `login_id` = 'user1', `password` = 'password' WHERE `users`.`id` IN (1)

$userModel->update([10, 11, 12], $data); // 更新処理を実施
// UPDATE `users` SET `login_id` = 'user1', `password` = 'password' WHERE `users`.`id` IN (10,11,12)

$userModel->where('name', '山田')->set($data)->update(); // 主キー以外のupdateをしたい場合
// UPDATE `users` SET `login_id` = 'user1', `password` = 'password' WHERE `name` = '山田'

$userModel->set($data)->update(); // 更新処理を実施
// 4.3からwhereを指定しないとエラーになります
// Updates are not allowed unless they contain a "where" or "like" clause

save()

insert()/update()のラッパーで、PKが指定されていれば更新、されていなければ新規登録するメソッドです。

$data = [
   'login_id' => 'user1',
   'password' => 'password',
];
$userModel->save($data); // 新規登録。return クエリ成否。返り値は成功(true)、失敗(false)
// INSERT INTO `users` (`login_id`, `password`) VALUES ('user1', 'password')

$data = [
   'id' => 10,
   'login_id' => 'user1',
   'password' => 'password',
];
$userModel->save($data); // 更新
// UPDATE `users` SET `login_id` = 'user1', `password` = 'password' WHERE `users`.`id` IN (10)

delete()

データを削除したい場合に利用するメソッドです。
$useSoftDeletesが設定されていれば論理削除、されていなければ物理削除になります。

$userModel->delete(1); // PKで単一削除。return クエリ成否。返り値は成功(true)、失敗(false)。
// UPDATE `users` SET `deleted_at` = '2024-04-23 10:11:36' WHERE `id` IN (1) AND `deleted_at` IS NULL

$userModel->delete([1, 2]); // PKで複数削除
// UPDATE `users` SET `deleted_at` = '2024-04-23 10:12:14' WHERE `id` IN (1,2) AND `deleted_at` IS NULL

$userModel->where('login_id', 'user1')->delete(); // PK以外の条件場合はクエリビルダーのwhere等を使う
// UPDATE `users` SET `deleted_at` = '2024-04-23 10:13:00' WHERE `login_id` = 'user1' AND `deleted_at` IS NULL

purgeDeleted()

論理削除されたデータを全て物理削除するメソッドです。

$userModel->purgeDeleted();
// DELETE FROM `users` WHERE `users`.`deleted_at` IS NOT NULL

追加分

chunk()

バッチなどで大量のデータを処理する場合にメモリが枯渇しないように、分割取得して処理したい場合に利用するメソッドです。

$userModel->where('company_code', 1)->chunk(2, static function ($data) {
    // 何かしらの処理
});
// 取得するデータが5件ある場合
// SELECT COUNT(*) AS `numrows` FROM `users` WHERE `company_code` = 1
// SELECT * FROM `users` WHERE `company_code` = 1 LIMIT 2
// SELECT * FROM `users` WHERE `company_code` = 1 LIMIT 2, 2
// SELECT *　FROM `users`　WHERE `company_code` = 1　LIMIT 4, 2

protect()

一時的に$allowedFieldsを無視して、登録/更新したい際に利用するメソッドです。
seedでのテストデータ登録などで利用しますが、通常は使わないようにしましょう。

$userModel->protect(false)->insert($data)->protect(true); // シード実施時など、一時的に

asArray()、asObject()

$returnTypeに指定した形式以外で取得したい場合に利用するメソッドです。

$userModel->asArray()->where('status', 'active')->findAll();
$userModel->asObject()->where('status', 'active')->findAll();

クエリビルダーの呼び出し

モデルからクエリビルダーのメソッドは呼び出すことが出来ます。
（ビルダーからモデルのメソッドは呼び出すことは出来ません）

$userModel->builder();
$userModel->builder('books'); // 別テーブルのビルダーを取得

ソーシャルメディアログイン機能の実装にはHybridauthのライブラリを使用します。

Hybridauthライブラリのインストール

次のコマンドを実行してHybridauthライブラリをインストールします。

# composer require hybridauth/hybridauth

設定ファイルの作成

Configディレクトリ内にProvider.phpを以下の内容で作成します。

<?php
 
namespace App\Config;

use CodeIgniter\Config\BaseConfig;

class Provider extends BaseConfig
{
  public $configure = [
    // callback
    'callback' => 'https://www.example.com/auth/authenticate',
    'providers' => [
      // facebook.
      'Facebook' => [
        'enabled' => true,
        'keys' => [
          'id' => '<アプリID>',
          'secret' => '<秘密キー>',
        ],
      ],
      // twitter
      'Twitter' => [
        'enabled' => true,
        'keys' => [
          'key' => '<キー>',
          'secret' => '<秘密キー>',
        ],
      ],
    ],
  ];
}

アプリID、キー、秘密キーは各SNSのデベロッパーサイトで発行された値を指定します。

コントローラーの作成

Authコントローラーを作成します。

<?php

namespace App\Controllers;

use Hybridauth\Hybridauth;
use Hybridauth\HttpClient;

class Auth extends BaseController
{
  public function index()
  {
    return view('auth');
  } 
  
  public function authenticate($provider = false)
  {
    $userProfile = [];
    $config = new \App\Config\Provider();
    try {
      $auth = new Hybridauth($config->configure);
      $adapter = $auth->authenticate($provider);
      $tokens = $adapter->getAccessToken();
      $userProfile = $adapter->getUserProfile();
      $adapter->disconnect();
      
    } catch (\Exception $e) {
      echo $e->getMessage();
    }

    return view('result', ['userProfile' => $userProfile]);
  }

ビューの作成

ビューはログインとログイン後の画面を用意します。

auth.phpの作成

Viewsディレクトリにauth.phpを以下の内容で作成します。

<html>
<head>
<title>ソーシャルメディアログインテスト</title>

<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head>
<body>
<a href="<?php echo base_url('auth/authenticate/Facebook') ?>">Facebookアカウントでログイン</a><br>
<a href="<?php echo base_url('auth/authenticate/Twitter') ?>">Twitterアカウントでログイン</a>
</body>
</html>

result.phpの作成

Viewsディレクトリにresult.phpを以下の内容で作成します。

<html>
<head>
<title>ソーシャルメディアログインテスト</title>

<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head>
<body>
<?php var_dump($userProfile) ?>
</body>
</html>

動作確認

次のURLへアクセスしてログインできるか確認します。

https://www.example.com/auth

正常に動作していればソーシャルメディア上の登録ID、プロフィール名、サブネイル画像URLの表示が確認できます。

Hybridauth Social Login PHP Library

hybridauth.github.io

インストール

Codeigniterのインストール

次のComposerコマンドでCodeigniter3をインストールします、

# composer create-project kenjis/codeigniter-composer-installer ＜インストール先ディレクトリ名＞

Ion-Authのインストール

次のComposerコマンドでIon-Authをインストールします。

# cd ＜インストール先ディレクトリ名＞
# php bin/install.php ion-auth 2

データベースの設定

データベースのスキーマを管理する機能を追加します。

コマンド実行ファイルの作成

以下のファイルを/application/controllers/内に設置します。

Migrate.php
<?php
defined('BASEPATH') OR exit('No direct script access allowed');

class Migrate extends CI_Controller {

    function __construct()
    {   
        parent::__construct();
        if(! $this->input->is_cli_request()) {
            show_404();
            exit;
        }   
        $this->load->library('migration');
    }   

    function current()
    {   
        if ($this->migration->current()) {
            log_message('error', 'Migration Success.');
        } else {
            log_message('error', $this->migration->error_string());
        }   
    }   

    function rollback($version)
    {   
        if ($this->migration->version($version)) {
            log_message('error', 'Migration Success.');
        } else {
            log_message('error', $this->migration->error_string());
        }   
    }   

    function latest()
    {   
        if ($this->migration->latest()) {
            log_message('error', 'Migration Success.');
        } else {
            log_message('error', $this->migration->error_string());
        }   
    }

}
マイグレーションの設定
application/config/migration.phpを次のように編集します。

<?
// マイグレーションを有効化
$config['migration_enabled'] = TRUE;
// シーケンス番号で管理
$config['migration_type'] = 'sequential';