先生と生徒の会話形式で理解しよう

生徒

「CodeIgniterでWebアプリケーションを作りたいんですが、コントローラって何ですか？」

先生

「コントローラは、ユーザーからのリクエストを受け取って、適切な処理を行う司令塔のような役割を持つものです。CodeIgniterでは、コントローラクラスを作成することで、Webページの動きを制御できます。」

生徒

「難しそうですね…どうやって作るんですか？」

先生

「大丈夫です。基本的な手順を覚えれば、誰でも簡単にコントローラクラスを作成できますよ。それでは、順番に見ていきましょう！」

1. CodeIgniterのコントローラとは？基本概念を理解しよう

CodeIgniterのコントローラは、MVCアーキテクチャにおける重要な要素の一つです。MVCとは、Model（モデル）、View（ビュー）、Controller（コントローラ）の頭文字を取ったもので、プログラムを役割ごとに分けて管理する設計手法です。

コントローラは、ユーザーがブラウザでURLにアクセスしたときに、最初に呼び出される場所です。例えるなら、レストランのウェイターのような存在です。お客さん（ユーザー）の注文（リクエスト）を受け取り、キッチン（モデル）に伝え、できあがった料理をお皿に盛り付けて（ビュー）、お客さんに提供する役割を担います。

CodeIgniterでは、コントローラクラスを作成することで、Webページの表示や、フォームから送信されたデータの処理など、さまざまな機能を実装できます。初心者の方でも、基本的なルールを守れば、簡単にコントローラを作成できるので安心してください。

2. コントローラファイルの保存場所とファイル名の規則

CodeIgniterでコントローラクラスを作成する前に、まずファイルをどこに保存するかを理解しましょう。コントローラファイルは、CodeIgniterプロジェクトのapp/Controllersディレクトリに保存します。このディレクトリは、すべてのコントローラファイルを管理する専用の場所です。

ファイル名には重要なルールがあります。ファイル名の最初の文字は必ず大文字にする必要があります。例えば、Welcome.php、Home.php、Blog.phpのようになります。小文字で始まるwelcome.phpのようなファイル名は、CodeIgniterでは正しく認識されません。

また、ファイル名とクラス名は一致させる必要があります。Home.phpというファイルを作った場合、その中に定義するクラス名もHomeにします。この規則を守ることで、CodeIgniterが自動的にファイルを読み込んで実行できるようになります。

3. 最もシンプルなコントローラクラスの作成方法

それでは、実際にコントローラクラスを作成してみましょう。最もシンプルな例として、「Hello World」と表示するコントローラを作ります。以下のコードをapp/Controllers/Hello.phpとして保存してください。


<?php

namespace App\Controllers;

class Hello extends BaseController
{
    public function index()
    {
        echo 'Hello World!';
    }
}

このコードを見ていきましょう。namespace App\Controllers;は、このクラスがどのグループに属するかを示す名前空間の宣言です。CodeIgniterでは、コントローラは必ずApp\Controllers名前空間に属します。

class Hello extends BaseControllerの部分で、Helloという名前のクラスを定義しています。extends BaseControllerは、CodeIgniterが用意している基本的なコントローラクラスを継承することを意味します。継承とは、親クラスの機能を引き継いで使えるようにすることです。

public function index()は、コントローラの中のメソッド（関数）です。indexメソッドは、URLで特に指定がない場合に自動的に呼び出される、デフォルトのメソッドです。このコントローラにブラウザでアクセスすると、「Hello World!」と表示されます。

4. ビューを使ってHTMLページを表示するコントローラ

実際のWebアプリケーションでは、echoで直接文字を出力するのではなく、ビューと呼ばれるHTMLテンプレートファイルを使って画面を表示します。ビューを使うことで、デザインとプログラムのロジックを分離でき、管理がしやすくなります。

以下は、ビューを読み込んで表示するコントローラの例です。


<?php

namespace App\Controllers;

class Home extends BaseController
{
    public function index()
    {
        return view('welcome_message');
    }
}

return view('welcome_message');の部分で、app/Views/welcome_message.phpというビューファイルを読み込んで表示しています。view()関数は、CodeIgniterが提供するヘルパー関数で、ビューファイルを簡単に読み込めます。

ビューファイルには、通常のHTMLを記述します。例えば、app/Views/welcome_message.phpに以下のようなHTMLを書くことができます。


<!DOCTYPE html>
<html>
<head>
    <title>ようこそ</title>
</head>
<body>
    <h1>CodeIgniterへようこそ！</h1>
    <p>これは最初のページです。</p>
</body>
</html>

5. 複数のメソッドを持つコントローラの作成

一つのコントローラには、複数のメソッドを定義できます。それぞれのメソッドは、異なるURLに対応し、異なる処理を実行できます。これにより、関連する機能をまとめて管理できるようになります。

例えば、ブログ記事を管理するコントローラを考えてみましょう。記事の一覧表示、詳細表示、新規作成など、複数の機能が必要になります。以下は、複数のメソッドを持つコントローラの例です。


<?php

namespace App\Controllers;

class Blog extends BaseController
{
    public function index()
    {
        echo '記事一覧ページ';
    }

    public function show($id)
    {
        echo '記事ID: ' . $id . ' の詳細ページ';
    }

    public function create()
    {
        echo '新規記事作成ページ';
    }
}

このコントローラでは、三つのメソッドを定義しています。index()は記事一覧、show()は記事詳細、create()は新規作成の処理を行います。show()メソッドは、$idというパラメータを受け取り、URLから渡された記事番号を表示します。

URLとメソッドの対応は以下のようになります。http://example.com/blogにアクセスするとindex()が呼ばれ、http://example.com/blog/show/5にアクセスするとshow(5)が呼ばれます。このように、URLの構造とメソッド名、パラメータが自動的に結びつきます。

6. データをビューに渡すコントローラの書き方

コントローラからビューにデータを渡すことで、動的なWebページを作成できます。例えば、データベースから取得した情報をページに表示したり、ユーザーが入力したデータを画面に反映させたりできます。

データをビューに渡すには、view()関数の第二引数に配列形式でデータを指定します。以下の例を見てみましょう。


<?php

namespace App\Controllers;

class User extends BaseController
{
    public function profile()
    {
        $data = [
            'name' => '山田太郎',
            'age' => 25,
            'email' => 'yamada@example.com'
        ];

        return view('user_profile', $data);
    }
}

この例では、$dataという配列に、ユーザーの名前、年齢、メールアドレスを格納しています。この配列をview()関数の第二引数として渡すことで、ビューファイル内でこれらのデータを使用できます。

ビューファイル（app/Views/user_profile.php）では、以下のように配列のキーを変数名として使えます。


<!DOCTYPE html>
<html>
<head>
    <title>プロフィール</title>
</head>
<body>
    <h1><?= $name ?>のプロフィール</h1>
    <p>年齢: <?= $age ?>歳</p>
    <p>メール: <?= $email ?></p>
</body>
</html>

<?= $name ?>は、PHPの短縮記法で、変数の値を出力します。コントローラから渡されたname、age、emailの値が、ビューで自動的に使えるようになります。

7. コンストラクタを使った初期化処理

コントローラが呼び出されたときに、最初に実行したい処理がある場合は、コンストラクタを使います。コンストラクタは、クラスのインスタンスが作成されるときに自動的に実行される特別なメソッドです。

例えば、すべてのメソッドで共通して使うデータの読み込みや、ログインチェックなどの処理をコンストラクタに書くことができます。CodeIgniterでコンストラクタを使う場合は、必ず親クラスのコンストラクタも呼び出す必要があります。

以下は、コンストラクタを使ったコントローラの例です。


<?php

namespace App\Controllers;

class Admin extends BaseController
{
    protected $adminName;

    public function __construct()
    {
        parent::__construct();
        $this->adminName = '管理者';
        echo '管理画面にアクセスしました
';
    }

    public function dashboard()
    {
        echo $this->adminName . 'のダッシュボード';
    }
}

__construct()がコンストラクタメソッドです。このメソッド内でparent::__construct();を呼び出すことで、親クラス（BaseController）の初期化処理を実行しています。これを忘れると、CodeIgniterの機能が正しく動作しない可能性があるので注意してください。

コンストラクタで設定した$this->adminNameは、クラス内のすべてのメソッドから$this->adminNameとしてアクセスできます。このように、複数のメソッドで共通して使う値を保存しておくと便利です。

8. リダイレクト機能を使ったページ遷移

Webアプリケーションでは、ある処理が完了した後に別のページに移動させるリダイレクトという機能がよく使われます。例えば、フォームの送信が完了したら確認ページに移動する、ログインに成功したらトップページに移動する、といった場合に使います。

CodeIgniterでは、redirect()関数を使って簡単にリダイレクトを実装できます。この関数は、指定したURLにユーザーを自動的に転送します。リダイレクトを使うことで、ユーザーに適切なページを表示し、スムーズな操作体験を提供できます。

リダイレクトには、コントローラ名とメソッド名を指定する方法と、完全なURLを指定する方法があります。状況に応じて使い分けることで、柔軟なページ遷移を実現できます。フォーム送信後の二重送信を防ぐためにも、リダイレクトは重要な技術です。

9. コントローラでよく使う便利な機能

CodeIgniterのコントローラには、開発を効率化する便利な機能が多数用意されています。BaseControllerを継承することで、これらの機能を簡単に使えるようになります。

ヘルパーの読み込みは、よく使う機能の一つです。ヘルパーとは、特定の処理をまとめた便利な関数の集まりです。例えば、url_helperを読み込むと、URLを生成するbase_url()などの関数が使えるようになります。$this->helper('url');のように記述して読み込みます。

セッション管理も重要な機能です。セッションを使うと、ユーザーごとに情報を保存できます。ログイン状態の管理や、ショッピングカートの情報保存などに使われます。$this->sessionでセッションにアクセスでき、$this->session->set('key', 'value')でデータを保存、$this->session->get('key')でデータを取得できます。

リクエストオブジェクトを使うと、ユーザーから送信されたデータを取得できます。$this->request->getPost('name')でフォームのPOSTデータを、$this->request->getGet('id')でURLパラメータを取得できます。これらの機能を組み合わせることで、本格的なWebアプリケーションを構築できます。

10. コントローラ作成時の注意点とベストプラクティス

CodeIgniterでコントローラを作成する際には、いくつかの重要な注意点があります。まず、ファイル名とクラス名を必ず一致させることです。Blog.phpというファイルにはclass Blogと書きます。大文字小文字も正確に合わせる必要があります。

次に、コントローラには複雑な処理を書きすぎないことが推奨されます。データベース操作などの複雑な処理は、モデルに分離するべきです。コントローラは、リクエストを受け取り、適切なモデルを呼び出し、結果をビューに渡す、という橋渡し役に徹することで、コードの保守性が高まります。

セキュリティ対策も忘れてはいけません。ユーザーから受け取ったデータは必ず検証し、不正な値が入っていないかチェックします。CodeIgniterには、入力検証のための機能が用意されているので、積極的に活用しましょう。また、データベースに保存する前には、SQLインジェクション対策として、適切なエスケープ処理を行います。

最後に、メソッド名は処理内容がわかりやすい名前にしましょう。index()、create()、update()、delete()のように、RESTfulな命名規則に従うと、他の開発者にも理解しやすいコードになります。コメントも適切に記述し、チーム開発でもスムーズに作業できるよう心がけましょう。