フォルダ構造

Grav は、データベースを持たないファイルベースの CMS のため、サイトのフォルダ構造は非常に重要です。Grav をインストールしたトップレベルのフォルダ構造は次のようになります。

/assets
/backup
/bin
/cache
/images
/logs
/system
/tmp
/vendor
/user

それぞれのフォルダが何なのかを説明します。

/assets

assets 管理するために利用され、変換された .css and .js が保存されています。

このフォルダは、定期的にクリアされるため、ユーザーデータを保管するために利用すべきではありません。

/backup

デフォルトのバックアップの保存先です。

/bin

Grav の CLI コマンドが含まれています。これらは開発用機能なので、この話題は別の章で説明します。

/cache

Grav の実行速度を上げるためのキャッシュファイルを格納するために利用されます。デフォルトではキャッシュは自動的に行われ、サーバー環境に応じて最適なオプションが選択され、可能な限り実行速度を高速化します。

Grav が最適だと判断したキャッシュ方法でキャッシュファイルが生成されます。Twig テンプレートのプリコンパイルされたファイルもこのフォルダに保存されます。

このフォルダは、定期的にクリアされるため、ユーザーデータを保管するために利用すべきではありません。

/images

Grav は画像操作ライブラリにより、画像サイズを変換することがで、その結果の画像を保存するためにこのフォルダが利用され、再度、変換要求があった場合は、保存された画像を再利用します。

このフォルダもキャッシュのように利用されますので、ユーザーが作成するデータは、 user/pages/, user/themes/, user/images/ フォルダに保存してください。

このフォルダは、定期的にクリアされるため、ユーザーデータを保管するために利用すべきではありません。

/logs

エラー情報や、追加ログやプロファイリングをオンにしていた場合に、関連情報が保存されます。

/system

Grav の動作に必要なファイルが保存されています。Grav のアップデートによって上書きされる可能性があるため、このフォルダ内のものは編集しないようにしましょう。Grav の動作に関連する変更をしたい場合は、別の章で説明するようにプラグインを使用するて対応できます。

/tmp

Gravやプラグインが一時ファイルを保存するために使用します。

このフォルダは、定期的にクリアされるため、ユーザーデータを保管するために利用すべきではありません。

/vendor

Grav の動作に必要な、依存するライブラリが保存されています。このフォルダも system フォルダ同様に、このフォルダ内のものは編集しないようにしましょう。

GitHub からインストールした場合は、vendor フォルダは生成されません。bin/grav install を実行するか、composer install して作成してください。

/user

Grav の利用には、このフォルダが最も重要です。このフォルダ内のファイルを操作して、コンテンツの作成、プラグインの使用、テーマの編集を行います。

/user/accounts
/user/blueprints
/user/config
/user/data
/user/images
/user/languages
/user/pages
/user/plugins
/user/themes

/user/accounts

サイトの特定の部分へのアクセス制限が必要な場合に、ユーザーアカウントの定義に利用されます。

/user/blueprints

The blueprints folder contains your custom blueprints for the site.

/user/config

Web サイトの設定に利用されます。

/user/data

プラグインがデータを保存するために利用されます。例としては、Form プラグインがあり、フォームに入力した情報が、このフォルダ内に保存されます。

デフォルトで、ブラウザからは、このフォルダにアクセスできません。

/user/images

画像の保存に利用されます。image:// でアクセスできます。

/user/languages

The languages folder contains Translation Overrides.

/user/pages

コンテンツを作成・編集する場所です。Grav を利用する場合、最も重要で、利用頻度の高いフォルダになります。

/user/plugins

サイトで利用するプラグインが保存されます。オリジナルのプラグインを自身で開発することもできます。

/user/themes

サイトの見た目を定義するテンプレートファイルを配置できます。GetGrav.org/downloads/themes からダウンロードして利用することもできますし、自身で作成することもできます。


オリジナル : https://learn.getgrav.org/17/basics/folder-structure