— y2sunlight 2020-07-29

Apricotの使用法 に戻る

目次

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

以下にプロジェクトフォルダの構成を示します。

/your-project

your-project [プロジェクト]
 |
 ├── app [アプリケーション]
 |    |
 |    ├── Controllers [コントローラ]
 |    ├── Exceptions [例外]
 |    ├── Foundation [基盤]
 |    ├── Helpers    [ヘルパー]
 |    ├── Middleware [ミドルウェア]
 |    └── Models     [モデル]
 | 
 ├── assets [リソース]
 |    |
 |    ├── lang  [言語別の出力テキスト]
 |    ├── sql   [SQLファイル]
 |    └── views [HTMLテンプレート]
 | 
 ├── config [設定ファイル]
 |    | 
 |    ├── setting [機能別の一般設定]
 |    └── setup   [機能別の起動設定]
 |
 ├── core [Apricotのコア]
 |    |
 |    ├── Derivations [ライブラリの派生クラス]
 |    ├── Exceptions  [例外]
 |    ├── Foundation  [基盤]
 |    └── helpers     [ヘルパー関数]
 | 
 ├── public [公開フォルダ]
 |    |
 |    ├── css/
 |    ├── img/
 |    ├── js/
 |    ├── var/
 |    ├── .htaccess
 |    └── index.php
 | 
 ├── var  [データファイル]
 |    |
 |    ├── cache [キャッシュ]
 |    ├── db    [DBファイル(sqlite)]
 |    └── logs  [ログ]
 | 
 └── vendor [外部ライブラリ]

アプリケーションの本体を保存するフォルダーで以下のクラスが存在します。

• 【 基盤 】コントローラ、モデル、エラーバッグなどのベースクラス
• 【 例外 】アプリケーション例外クラスと集約例外コントローラ
• 【 モデル 】通常データベースのテーブル単位で作り、アプリケーションのデータモデルとなる
• 【 コントローラ 】通常画面単位に作り、URLと結びついたアクション(メソッド)から構成されている
• 【 ミドルウェア 】アクション起動時の前処理(まはた後処理)を行うクラス
• 【 ヘルパー 】ビューヘルパーなどの共通のユーティリティクラス

アプリケーションのリソースを保存します。

• 【 ビューテンプレート 】画面を作成するHTMLテンプレート(BladeOneで使用)
• 【 言語別のテキスト 】トランスレーションの為の言語別のテキスト
• 【 SQLファイル 】データベース構築の為のSQL

アプリケーションの設定を保存します。

• 【 起動設定 】機能別のアプリケーション起動時の設定ファイル
• 【 一般設定 】機能別の一般設定ファイル

Apricotのコアクラスを保存します。コアの主な目的は次の３つです。

• アプリケーションの構成管理を提供する
• リクエストからレスポンスまでの標準的な処理方法を提供する
• ロギング、例外集約、デバックの機能を提供する

公開用のフォルダです。ここのはApricotのフロントコントローラ( index.php )があります。

アプリケーションの次のデータを保存するフォルダです。

• ログファイル
• キャッシュファイル
• データベースファイルなど

Composerが使用する外部ライブラリーの保存フォルダです。

/your-project

.env

# Application
APP_NAME=Apricot
APP_VERSION=1.0.0
#APP_SECRET=Please set a random 32 characters
APP_SECRET=0123456789ABCEDF0123456789ABCEDF
APP_DEBUG=true
APP_TIMEZONE=Asia/Tokyo
APP_LANG=ja
 
# Loging
LOG_NAME ="apricot"
LOG_LEVEL = "debug"

app.php はライブラリとミドルウェアに関する構成とセキュリティーの定義が含まれています。

/your-project/config

app.php

<?php
/**
 * This file contains application settings.
 */
return
[
    'setup' =>[
        config_dir('setup/whoops.setup.php'),    /* Error handler (whoops) */
        config_dir('setup/bladeone.setup.php'),  /* View template (BladeOne) */
        config_dir('setup/aliases.setup.php'),   /* Class aliases for view template and so on */
        config_dir('setup/idiorm.setup.php'),    /* ORM (idiorm) */
        config_dir('setup/validator.setup.php'), /* Valitron\Validator */
    ],
    'middleware' =>[
        \App\Middleware\AccessLog::class,        /* Access log */
        \App\Middleware\VerifyCsrfToken::class,  /* Verify CSRF Token */
//      \App\Middleware\Auth\BasicAuth::class,   /* Basic authentication */
        \App\Middleware\Auth\SessionAuth::class, /* Session authentication */
    ],
    'csrf' =>[
        'disposable' => false,
    ],
    'auth' =>[
        'db'=>[
            'user'=>[
                'account' =>'account',
                'password' =>'password',
                'remember' =>'remember_token',
            ],
        ],
        'expires_sec'=> 2*7*24*3600, /* 2weekws */
        'menu'=> true,
    ],
];

• setup — ライブラリの初期化ファイルの所在(フルパス)
• middleware — ミドルウェアの完全修飾クラス名
• auth — ユーザ認証(セッション認証)の設定
• csrf — CSRFトークンの設定

TODO

TODO