従来のアプリケーションスケルトン

pieceofcake2/app-legacy は、本家の CakePHP 2 と同じようにクラスがグローバルで、テンプレートが .ctp ファイルの CakePHP 2 アプリケーションのためのアプリケーションスケルトンです。pieceofcake2/app と同じ CakePHP 5 と互換性のあるディレクトリ構成 (config/、src/、templates/、tests/、webroot/)、同じ設定ファイルと .env ファイル、同じホームページ、レイアウト、エラーページ、スタイルを持っています。違うのはコードの形だけです。

	pieceofcake2/app-legacy	pieceofcake2/app
アプリケーションのクラス	グローバル (`AppController`)	`App` 名前空間 (`App\Controller\AppController`)
`src/` のオートロード	クラスマップ。クラスのファイルを追加したら `composer dump-autoload` を実行します	PSR-4 (`src/` から `App\`、`tests/` から `App\Test\`)
テンプレート	`Layouts/`、`Elements/`、`Emails/`、`Errors/` にある `.ctp` ファイル	`layout/`、`element/`、`email/`、`Error/` にある `.php` ファイル
コーディング規約	`CakePHP2`	`CakePHP2Namespace`

既存の CakePHP 2 アプリケーションと同じ形のコードにしたいとき、たとえばアプリケーションを少しずつスケルトンに移すときに、このスケルトンを使ってください。クラスはあとから名前空間に移せます (名前空間付きのクラスへの移行を参照)。

WARNING

CakePHP 2.x は既存アプリケーションのメンテナンスのためのものです。新しいプロジェクトには、 CakePHP の現在のメジャーバージョンを使ってください。

インストール

Composer の create-project コマンドで新しいアプリケーションを作成します。

bash

composer create-project pieceofcake2/app-legacy my_app

動作要件、インストールされるパッケージ、設定の手順は pieceofcake2/app と同じです。動作要件とインストールをご覧ください。要点は、config/database.php.default を config/database.php にコピーして config/.env.local に DATABASE_URL (テスト用データベースは config/.env.test.local) を設定し、セキュリティ用のソルトを変更することです (セキュリティ用のソルトの生成を参照)。

Bake プラグインと DebugKit プラグインは開発用の依存パッケージです。config/bootstrap.php はインストールされていればこれらを読み込むので、すぐに bin/cake bake が使え、本番環境では composer install --no-dev でも動作します。 DebugKit のツールバーを表示するには、開発用プラグインのとおりに AppController にコンポーネントを追加します。namespace の行は不要です。

ディレクトリ構成

text

my_app/
├── bin/
│   └── cake            the console
├── config/             configuration (core.php, bootstrap.php, routes.php, database.php, ...)
├── logs/               log files
├── plugins/            plugins installed by Composer
├── resources/
│   └── locales/        translation files
├── src/                PHP code
│   ├── Console/        shells, tasks and bake templates
│   ├── Controller/
│   ├── Lib/
│   ├── Model/
│   └── View/           helpers
├── templates/          view templates (.ctp)
│   ├── Elements/       elements (Flash/ for the flash messages)
│   ├── Emails/         email templates (html/, text/)
│   ├── Errors/         error pages
│   ├── Layouts/        layouts (Emails/ for the email layouts)
│   └── Pages/          pages of PagesController
├── tests/
│   ├── Fixture/
│   └── TestCase/
├── tmp/                cache, sessions and test files
├── vendor/             Composer packages, including CakePHP
└── webroot/            document root (index.php, test.php, css/, js/, img/)

CakePHP がディレクトリを見つける仕組みはディレクトリ構成と CakePHP のフォルダ構造をご覧ください。

クラスとオートロード

src/ のクラスはグローバルで、Composer がクラスマップで読み込みます。

json

"autoload": {
    "classmap": ["src/"]
}

クラスマップは src/ のどのフォルダにあるクラスも見つけますが、composer dump-autoload の後でなければ見つけられません。クラスのファイルを追加するたびに実行してください。CakePHP のクラスは、pieceofcake2/app と同じく use 文でインポートします。

php

// src/Controller/AppController.php
use Cake\Controller\Controller;

class AppController extends Controller
{
}

オートロードをご覧ください。

テンプレート

テンプレートは、CakePHP 2 のディレクトリ名を使った .ctp ファイルです。

templates/Layouts/default.ctp: 上部のナビゲーションバーとコンテンツのコンテナ。debug が 2 の間は、コンテンツの下に SQL ログが表示されます。
templates/Layouts/error.ctp: 本番環境のエラーページ用の最小限のレイアウト。
templates/Layouts/flash.ctp: Controller::flash() が描画するページ。
templates/Elements/Flash/: default、success、error、warning、info のフラッシュメッセージ。
templates/Pages/home.ctp: debug が有効な間 / に表示されるホームページ。debug を無効にする前に独自のページに置き換えてください。
templates/Errors/error400.ctp と error500.ctp: エラーページ。

見た目は pieceofcake2/app のテンプレートと同じです。スタイルシートと、エラーページやフラッシュメッセージのスクリーンショットはページとスタイルをご覧ください。

ホームページ

以前のバージョンのスケルトンから作成したアプリケーションで新しい見た目を使うには、templates/Layouts/、 templates/Elements/Flash/、templates/Errors/、webroot/css/、webroot/font/ と webroot/img/cake.logo.svg をアプリケーションにコピーしてください。

設定と開発

そのほかは pieceofcake2/app と同じです。

設定と環境変数 (.env)
データベースとメーラーの DSN
アプリケーションの実行
テストの実行と End-to-End テスト。 tests/TestCase/ のテストケースと tests/Fixture/ のフィクスチャはグローバルなクラスです。
静的解析

vendor/bin/phpcs は、pieceofcake2/phpcs-cakephp2 の CakePHP2 規約でコードをチェックします (アプリケーションの phpcs.xml を参照)。

名前空間付きのクラスへの移行

このスケルトンから作成したアプリケーションを pieceofcake2/app の形に移すには、 pieceofcake2/upgrade の layout コマンドと namespace コマンドを実行します。すでにモダン構成のアプリケーションでは、layout はテンプレートを CakePHP 5 のディレクトリにある .php ファイルに名前を変え、namespace はクラスを App 名前空間に移します。モダン構成への移行をご覧ください。

由来

このパッケージは cakephp/cakephp (Packagist では cakephp/cakephp、アップストリームの最終バージョンは 2.10.24) の app/ ディレクトリをもとに別のパッケージとして切り出したもので、元の作者は CakePHP コミュニティ (Cake Software Foundation, Inc.) です。 pieceofcake2 が、モダンな PHP で動く CakePHP 2 向けにメンテナンスしています。オリジナルからの変更点はコミット履歴で確認できます。

従来のアプリケーションスケルトン ​

インストール ​

ディレクトリ構成 ​

クラスとオートロード ​

テンプレート ​

設定と開発 ​

名前空間付きのクラスへの移行 ​

由来 ​