— y2sunlight 2020-07-29

Apricot ドキュメント に戻る

目次

• Apricot 特徴と概要
• Apricot 配置と構成
• Apricot ログとエラー処理
• Apricot リクエストとレスポンス
• Apricot フロントエンド
• Apricot データベースとモデル
• Apricot ミドルウェア
• Apricot コントローラ
• Apricot ユーティリティ

Apricotのリクエストクラスは、PHPのスーパーグローバル変数を個別にカプセル化したシングルトンです。リクエスト取得用に以下のシングルトンがあります：

• Input — フォーム送信データ(GET変数またはPOST変数：methodに依存)
• QueryString — クエリ文字列(GET変数)
• Session — SESSION変数
• Flash — １回限り有効なSESSION変数
• Cookie — COOKIE変数

これらはシングルトンなので、アプリケーションのどこからでもリクエストを取得することができます。

Inputクラスはフォームの送信データを取得するシングルトンで、methodに従って、$_GETまたは$_POSTから生成されます。Inputクラスは後述のQueryStringクラスは同じく Apricot\Foundation\SimpleInput クラスをシングルトンにしたものです。

使用法: Input::{メソッド}

QueryStringクラスはクエリ文字列を取得する為のシングルトンです。このクラスはApricot\Foundation\SimpleInput クラスをシングルトンにしたもので、$_GETから生成します。

使用法: QueryString::{メソッド}

Sessionクラスはセッション変数を設定及び取得をするシングルトンで、Apricot\Foundation\SimpleSession クラスから作ります。Sessionシングルトン後述するフラッシュデータを包含しています。

使用法: Session::{メソッド}

使用例：

TODO:

セッションには以下の設定ファイルが存在します。

{your-project}/config/setting

session.setting.php

<?php
/**
 * This file contains session settings.
 */
return
[
    'name' => 'SID'.substr(md5(env('APP_SECRET', env('APP_NAME'))),0,16),
    'ini' =>[
        'gc_maxlifetime' => null,   /* default: 1440[sec] */
        'gc_probability' => null,   /* default: 1         */
        'gc_divisor' => null,       /* default: 100       */
        'cookie_lifetime' => null,  /* default: 0[sec]    */
    ],
];

• name — セッション名(初期設定値は環境変数APP_SECRETを使って設定します)
• ini.gc_maxlifetime — サーバに保存されるセッション変数の有効期間(デフォルト値は1440[秒])
• ini.gc_probability — PHPのマニュアルを参照して下さい(既定値は1)
• ini.gc_divisor — PHPのマニュアルを参照して下さい(デフォルト値は100)
• ini.cookie_lifetime — セッションクッキーの有効期間(デフォルト0ではブラウザを閉じたらセッションは破棄されます)

フラッシュとは、セッション内で一回限りだけ有効なセッション変数（次の画面の遷移のときまで保存される変数）のことです。Flashクラスはフラッシュ変数の設定及び取得を行うシングルトンで、Apricot\Foundation\SimpleFlash クラスから作ります。

使用法: Flash::{メソッド}

使用例：

TODO:

Cookieクラスはクッキーの設定及び取得を行うシングルトンで、Apricot\Foundation\SimpleCookie クラスを使って実装します。

使用法: Cookie::{メソッド}

使用例：

TODO:

クッキーには以下の設定ファイルが存在します。

{your-project}/config/setting

cookie.setting.php

<?php
/**
 * This file contains cookie settings.
 */
return
[
    'path' => '',
    'domain' => '',
    'secure' => FALSE,
    'httponly' => FALSE,
];

• path — ドメイン上のクッキーが有効なパス(デフォルト値はカレントパス:即ち公開パスpublic)
• domain— クッキーが有効なドメイン(デフォルト値はカレントURLのドメイン)
• secure— TRUEを設定すると、セキュアな接続が存在する場合にのみクッキーを設定します
• httponly— TRUEを設定すると、HTTPを通してのみクッキーを設定します

設定値の詳細は、PHPマニュアルのsetcookieを参照して下さい。

リクエスト取得用のボイラープレートには以下の関数があります。input()からcookie()までは、それぞれのリクエスト変数を取得する関数で、HTMLテンプレートでよく使われるます。inputLabels()はInputクラスからバリデーションの項目名を取得するのに便利な関数です。

Responseクラスはレスポンスのベースクラスで、その目的はHTMLヘッダーとフラッシュデータの管理です。後述の RenderResponse(レンダリング用) と RedirectResponse(リダイレクト用) はResponseクラスから派生します。Responseクラスは以下のメソッドを持ちます。

RenderResponseクラスはResponseクラスから派生します。HTMLレンダリングを行うレスポンス用のクラスで、以下のメソッドを持ちます。addHeader()などのResponseクラスのメソッドも使用できます。

アプリケーションでは、直接RenderResponseクラスを使うのではなく、後述する render() 関数を使用します。

RedirectResponseクラスはResponseクラスから派生したリダイレクト用のクラスです。リダイレクトではフラッシュデータを使ってリダイレクト先のページにデータを送ることが多いので、フラッシュ用のメソッドが追加されています。RedirectResponseクラスは以下のメソッドを持ちます。addHeader()などのResponseクラスのメソッドも使用できます。

TODO: 以下は、レスポンスで使用するフラッシュデータのキーとその内容です。特に _old_inputs と errors はHTMLテンプレートで良く使用されます。

アプリケーションでは、直接RedirectResponseクラスを使うのではなく、後述する redirect() 関数を使用します。

レスポンス処理用のボイラープレートには以下の関数があります。render()とredirect()はコントローラアクションで、その他はHTMLテンプレートでよく使われる関数です。

使用例：

TODO: