— y2sunlight 2020-07-29

Apricotの使用法 に戻る

目次

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

以下にプロジェクトディレクトリーの構成を示します。

/your-project

your-project [プロジェクトディレクトリー]
 |
 ├── app
 ├── assets
 ├── config
 ├── core
 ├── public
 ├── var
 └── vendor

アプリケーションの本体を保存するディレクトリーで以下のクラスが存在します。

• [ Foundation ] コントローラ、モデル、エラーバッグなどのベースクラスを配置します。
• [ Exceptions ] アプリケーション例外クラスと集約例外コントローラを配置します。
• [ Models ] 通常データベースのテーブル単位で作り、アプリケーションのデータモデルを配置します。
• [ Controllers ] 通常画面単位に作り、URLと結びついたアクション(メソッド)からを配置します。
• [ Middleware ] アクション起動時の前処理(まはた後処理)を行うミドルウェアを配置します。
• [ Helpers ] ビューヘルパーなどの共通のユーティリティクラスを配置します。

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

• [ views ] 画面を作成するHTMLテンプレート(BladeOneで使用)
• [ lang ] トランスレーションの為の言語別のテキスト
• [ sql ] データベース構築の為のSQL

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

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

Apricotのコアクラスを配置します。コアクラスはApricotフレームワークライブラリとして提供され、次の３つの主要な目的があります。

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

公開用のディレクトリーです。ここにApricotのフロントコントローラ( index.php )があります。

アプリケーションの次のデータを保存するディレクトリーです。

• [ logs ] ログファイル
• [ cache ] キャッシュファイル
• [ db ] データベースファイルなど

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