FuelPHPで複数のファイルを添付してメールを送る方法

メール送信入力画面に以下のようなファイル添付フォームを用意します。

<?= Form::open(['action' => '/path/to/controller/send', 'method' => 'post', 'enctype' => 'multipart/form-data']); ?>

…

<?php foreach($file_numbers as $index => $file_number):?>
    <li>
        <dl>
            <dt>添付資料<?php echo $index ?></dt>
            <dd>
                <input type="file" name="<?php $file_number ?>”>
            </dd>
        </dl>
    </li>
<?php endforeach;?>

<p>
    <input type="submit" value="送信する" onClick="return confirm('メール送信します。よろしいですか？');">
</p>


…

<?= Form::close(); ?>

ファイルの添付はattachメソッドを使います。このメソッドは、config/email.phpのattach_pathsにセットされたパスの中からファイルを検索します。パラメーターは以下の通りです。

第一引数は必須です。

• $file string

false。同封したいファイルのパス。

• $inline bool

false。インラインでファイルを添付するかどうか。

• $cid string

null。コンテンツ ID 。インライン画像として添付する場合に使用。

• $mime string

null。デフォルトでは、mimetype は core/config/mimes の配列から検索。

• $name string

null。上書きする添付名。

\Input::post()でメールアドレスや本文などのメール送信内容を取得し、\Upload::get_files()で添付ファイルを取得します。

取得した添付ファイルをforeach()でまわし、バリデートに成功した場合、メールにファイルを添付します。

その後はいつものメール送信のように、送信先メールアドレス・送信元メールアドレス・題名・本文をセットし、完了です。

本文はnl2br()関数を使い、改行文字の前にHTMLの改行タグを挿入しています。

/**
* 複数ファイルを添付してメール送信
*/
public function post_send()
{
    try {
        // 送信内容取得
        $params = \Input::post();

        // 全ファイル取得
        $file_details = \Upload::get_files();

        // インスタンス生成
        $email = \Email::forge();

        // メールにファイル添付
        $target_file_index = 0;
        foreach ($file_details as $file_no => $file_detail) {
            if ($file_detail['name']) {
                $target_file_index = $file_no;

                // ファイルバリデーション
                $file_valid = \Upload::is_valid($target_file_index);
                if (! $file_valid) {
                    throw new \Exception();
                }

                // 対象のファイルを取得
                $upload_file_detail = \Arr::get(\Upload::get_files(), $target_file_index);
                $file = $upload_file_detail['file'];

                // 対象ファイルのパスとファイル名取得
                $path_and_name = explode('/', $file);
                $tmp_path = DS . $path_and_name[1] . DS;
                $tmp_name = $path_and_name[2];

                // 対象ファイルを添付
                $email->attach($tmp_path.$tmp_name, false, null, null, $file_detail['name']);
            }
        }

        $email->to($params['email'])
        ->from(sample@example.com)
        ->subject($params['title'])
        ->html_body(nl2br ($params['message']))
        ->send();
    } catch (\EmailValidationFailedException $e) {
        Log::warning($e->getTraceAsString());
        Log::warning($e->getMessage());
        throw $e;
    } catch (\EmailSendingFailedException $e) {
        Log::warning($e->getTraceAsString());
        Log::warning($e->getMessage());
        throw $e;
    } catch (\Exception $e) {
        Log::warning($e->getTraceAsString());
        Log::warning($e->getMessage());
        throw $e;
    }
}

以上、複数のファイルを添付してメールを送る方法でした。

参考：

FuelPHPでバリデーションを使い、エラーメッセージを表示させる

バリデーションの引っかかった場合に、エラーメッセージを表示させます。エラーメッセージが複数ある場合を考慮し、implode()で配列要素を文字列として表示させています。

・edit.php

...

<?php if (Session::get_flash('errors')): ?>
    <div class="alert alert-danger">
        <p class="errorTxt">
            <?php echo implode('</p><p class="errorTxt">', e((array) Session::get_flash('errors'))); ?>
        </p>
    </div>
<?php endif; ?>

...
<?= Form::open('action' => '/user/update/' . $user->id, 'method' => 'post']);?>
    <ul>
        <li>
            <dl>
                <dt>氏名</dt>
                <dd>
                    <?php echo Form::input('name', Input::post('name', isset($user->name) ? $user->name : ''), ['placeholder'=>'氏名']); ?>
                </dd>
            </dl>
        </li>
        <li>
            <dl>
                <dt>メールアドレス</dt>
                <dd>
                    <?php echo Form::input('email', Input::post('email', isset($user->email) ? \Crypt::decode($user->email) : ''), ['placeholder'=>'メールアドレス']); ?>
                </dd>
            </dl>
        </li>
        <li>
            <dl>
                <dt>電話番号</dt>
                <dd>
                    <?php echo Form::input('phone_number', Input::post('phone_number', isset($user->phone_number) ? $user->phone_number : ''), ['placeholder'=>'電話番号']); ?>
                </dd>
            </dl>
        </li>
    </ul>

...

<p class="btn">
    <input type="submit" value="登録する" class="main" onClick="return confirm('登録します。よろしいですか？');">
</p>

<?= Form::close(); ?>

バリデーションの処理は以下のように実装しました。

バリデーションを実行するメソッドを呼び出し、引っかかった場合はエラーメッセージと共にViewにリダイレクトします。すると、先ほどViewで書いたif (Session::get_flash(‘error’))がtrueになるのでバリデーションのエラーメッセージが表示されます。

例えば、氏名を空で送信すると、「氏名は必須入力です。」のようなエラーメッセージが表示されます。

バリデートに成功した場合は、try・catch内でトランザクションを張って更新処理を実装するような形になります。

バリデーションのルールは公式リファレンスに詳しく書いてあります。

・users.php

...

private $validator;

/**
* 更新処理
* @param int $id
*/
public function post_update(int $id)
{
    // Viewから送られてきた入力値を取得する(今回の場合は、氏名・メールアドレス・電話番号)
    $params = \Input::post();

    // バリデーション実行
    $validator = $this->validate($params);

    // バリデートに失敗した場合はリダイレクトし、エラーメッセージを表示
    if (!$validator) {
        \Session::set_flash('errors', $this->validator->error());
        \Response::redirect('/user/edit/' . $id);
    }

    // 更新処理
...

}

/**
* バリデーション実行
* @param array $params
* @return bool
*/
private function validate(array $params)
{
    $validator = \Validation::forge('user');
    $validator->add_callable('\Api\Validation_MyRules');
    $validator->add_field('name', '氏名', 'required|max_length[50]');
    $validator->add_field('email', 'メールアドレス', 'required|valid_email|max_length[50]');
    $validator->add_field('phone_number', '電話番号', 'required|max_length[15]|valid_string[numeric]');

    if (!$validator->run($params)) {
        $this->validator = $validator;
        return false;
    }

    return true;
}

...

バリデーションを独自で拡張する場合は、以下のように新規ファイルを作成して独自ルールのメソッドを追加します。
・myrules.php

<?php

class Validation_MyRules
{
    /**
    * ユーザーIDの存在チェック
    *
    * @param int $val
    * @return boolean
    */
    public static function _validation_check_user_id($val)
    {
        $user = \Model_Db_User::find($val);
        return isset($user);
    }

...

}

使うときは以下のようにして呼び出します。

$val = Validation::forge();
$val->add_callable('Validation_MyRules');

非静的に追加すると、静的メソッドも非静的メソッドも使用できます。

$val->add_callable(new Validation_MyRules());

マイグレーション機能

マイグレーション機能を活用することで、簡単にDBのテーブルの変更や削除などの操作や管理を行うことできます。

マイグレーションファイルを実行することで、ファイルの中身に基づいてテーブルを生成してくれるため、複数人で開発しているときなどDB環境をあわせるのに役立つ機能となっています。

FuelPHP バージョンを確認

以下のコマンドでFuelPHPフレームワークのバージョンを確認しておきます。

$ php oil -v
Fuel: 1.8 running in "local" mode

FuelPHP マイグレーションファイルの自動生成

以下のコマンドでマイグレーションファイルを自動生成します。

オプションのコマンドで、テーブルのカラムを追加することができます。001は最初のファイルの番号で、続けて002、003とファイル名の先頭に追加されます。

$ php oil generate migration create_members
Creating migration: /var/www/fuel/app/migrations/001_create_members.php

自動生成されたファイルを確認すると、以下のようになっています。今回は、自動生成されたマイグレーションファイルを編集していきます。

up()は、マイグレーションのテーブル作成コマンド実行時に処理が流れます。down()は反対にテーブル削除実行時に流れます。

001_create_members.php

<?php

namespace Fuel\Migrations;

class Create_members
{
    public function up()
    {
        \DBUtil::create_table('members', array(
        'id' => array('constraint' => 11, 'type' => 'int', 'auto_increment' => true, 'unsigned' => true),
    ), array('id'));
}

    public function down()
    {
        \DBUtil::drop_table('members');
    }
}

FuelPHP マイグレーションファイルの編集

仮としてmembersテーブルのマイグレーションファイルを作成しました。array()の部分は使用しているPHPのバージョンが5.4以上なので[]に置換しておきました。

マイグレーションファイルにインデックスを作成することもできます。インデックスを作成することで、対象のカラムのデータを高速に検索し、取り出すことができます。

データ検索時はインデックスの方を検索するため、大量のデータを格納する場合はインデックスを作成しておきましょう。

<?php

namespace Fuel\Migrations;

class Create_members
{
    const TABLE_NAME = 'members';
    public function up()
    {
        // create table
        \DBUtil::create_table(self::TABLE_NAME, [
            'id' => ['constraint' => 11, 'type' => 'int', 'unsigned' => true, 'auto_increment' => true],
            'name' => ['constraint' => 32, 'type' => 'varchar'],
            'type' => ['constraint' => 11, 'type' => 'int', 'unsigned' => true],
            'email' => ['constraint' => 1024, 'type' => 'varchar', 'null' => false],
            'phone_number' => ['constraint' => 11, 'type' => 'int', 'unsigned' => true],
            'status' => ['constraint' => '"active","inactive","banned"', 'type' => 'enum'],
            'created_at' => ['type' => 'datetime'],
            'updated_at' => ['type' => 'datetime', 'null' => true],
            'deleted_at' => ['type' => 'datetime', 'null' => true],
        ], ['id']);

        // create index
        \DBUtil::create_index(self::TABLE_NAME, 
            ['type'],
            'idx_type'
        );
    }

    public function down()
    {
        // drop table
        \DBUtil::drop_table(self::TABLE_NAME);

        // drop index
        \DBUtil::drop_index(self::TABLE_NAME, 'idx_type');
    }
}

FuelPHP マイグレーションファイルの実行

作成したマイグレーションファイルを以下のコマンドで実行します。

エラーになる場合は、エラーメッセージからマイグレーションファイルを修正しましょう。

$ php oil refine migrate
Performed migrations for app:default:
001_create_members

データベースを確認すると、テーブルが追加されていることが確認できます。

テーブルを削除する場合は、downコマンドを実行します。するとテーブルが削除されていることが確認できます。

$ php oil refine migrate:down
Reverted migrations for app:default:
- 001_create_members

再度、テーブルを作成するときはupコマンドを実行しましょう。

$ php oil refine migrate:up
Newly installed migrations for app:default:
- 001_create_members

FuelPHP マイグレーションファイルの操作

他にもマイグレーションの操作には、以下のようなコマンドがあります。

現在のマイグレーションのバージョンを取得し、最新の状態に向けてマイグレーションファイルを実行していきます。

$ php oil refine migrate:current

以下のコマンドで、指定したバージョンに更新します。

$ php oil refine migrate --version='バージョン'

以上、簡単にマイグレーション作成と実行の流れをまとめてみました。