詳解 CakePHP辞典 2.0/2.1/2.2/2.3対応

概 要

CakaPHPの膨大な量のメソッドやオプション値を詳細に解説したリファレンスです。CakePHPはそのままでも使い勝手のいいフレームワークですが、より高度な機能を使うには、オプションを編集したほうが効率が良くなります。しかし、オプション値の詳細な情報がわからないため、時間ばかり失ってしまったり、自作した機能が実はコアライブラリに存在したことが後で分かったりといった失敗もよく耳にします。本書は、CakePHPの入門書が取り上げないメソッドとオプションについてのリファレンス情報を詳細かつ大量に掲載しました。テストAPIやコアライブラリの解説も充実しており、必要なデータを素早く引けるように工夫した圧倒的情報量の便利な辞典です。

著者 滝下真玄
価格 本体3200円(税別)
ISBN 978-4-7980-3746-2
発売日 2013/3/15
判型 A5
色数 1色
ページ数 728
CD/DVD
対象読者 中級
シリーズ 詳解辞典
表紙イメージ
購入 アマゾンで購入する
楽天で購入する

※リンク先によっては、販売ページが用意されていないことがあります。あらかじめご了承ください。

新しいウィンドウで開く 書籍購入のご案内

サポート

サポート情報は以下からご参照下さい。

サポート情報へのリンク

目次

第1章 イントロダクション

CakePHPとは?

CakePHPの特徴

アーカイブの入手とインストール

アーカイブの入手

設定の変更

CakePHPでの基本的な制作方法

第2章 設定編

CakePHPの基本的な設定(app/Config/core.php)

debug デバッグレベルの設定

Error エラーハンドラの設定

Expression 例外処理の設定

App.encoding 文字エンコーディングの設定

App.baseUrl ベースURLパスの設定

Routing.prefixes prefixルーティングの指定

Cache.disable キャッシュの無効化

Cache.check キャッシュのチェック設定

Cache.viewPrefix キャッシュのチェック設定

LOG_ERROR ログのデフォルトのエラーレベル設定

Session セッション設定

Security.level セキュリティレベルの設定

Security.salt ハッシュ生成のための固有値

Security.cipherSeed 可逆暗号のための固有値

Asset.timestamp ファイル書き出し時のファイル名にタイムスタンプを付加

Asset.filter.css CSSファイルをフィルタリングするためのコード設定

Asset.filter.js JavaScriptファイルをフィルタリングするためのコード設定

Acl.classname データベースACLを用いる場合のモデル名

Acl.database データベースACLを用いる場合のデータソース名

date_default_timezone_set デフォルトのタイムゾーン

Cache::config('_cake_core_')

Cache::config('_cake_model_') CakePHPコアシステムのキャッシュ設定

データベース設定(app/Config/database.php)

ルーティング(app/Config/routes.php)

ブートストラップ(app/Config/bootstrap.php)

アプリケーション用キャッシュ設定

パスの設定

語尾変化の設定

プラグインの利用登録

ディスパッチャーフィルターの設定

CakeLogの設定

第3章 モデル・ビヘイビア編

モデルの概要

Modelクラス

アソシエーション

モデルの作成と利用

Modelクラス

Model::associations() アソシエーションタイプの入手

Model::bindModel() アソシエーション設定を動的に行う

Model::buildQuery() クエリ用のデータを整える

Model::create() モデルの初期化

Model::deconstruct() 日時データを指定フィールドが認識できる日時形式に加工する

Model::delete() レコードの削除

Model::deleteAll() 条件の一致するレコードを全て削除

Model::escapeField() フィールド名の補正

Model::exists() 現在のモデル値がテーブル中に存在するか調べる

Model::field() 指定フィールドの値を入手する

Model::find() データソースからデータを検索して入手

Model::getAffectedRows() 更新されたレコードの数を入手

Model::getAssociated() 利用可能なアソシエーションの設定を入手

Model::getColumnType() 指定カラムのデータ形式を入手

Model::getColumnTypes() 各カラムのデータ形式をまとめて入手

Model::getDataSource() データソースオブジェクトを入手

Model::getEventManager() イベントマネージャの入手

Model::getID() プライマリキーの入手

Model::getInsertID()

Model::getLastInsertID() 挿入されたレコードのIDを入手

Model::getNumRows() 取得データ数の入手

Model::getVirtualField() バーチャルフィールドの定義内容を入手

Model::hasAny() 条件の一致するレコードがあるか調べる

Model::hasField() 指定した名前のフィールドが存在するかをチェック

Model::hasMethod() モデル内にメソッドが存在するか調べる

Model::implementedEvents() 定義されたイベントを入手する

Model::invalidFields() フィールド値のバリデーション

Model::invalidate() 指定フィールドをエラーにする

Model::isForeignKey() 指定フィールドが外部キーかを調べる

Model::isUnique() 該当フィールドがユニークであるかを調べる

Model::isVirtualField() 指定したフィールド名がバーチャルフィールドかをチェック

Model::joinModel() 結合されたモデルのフィールド名を入手

Model::query() SQLを直接指定してデータを入手

Model::read() 指定プライマリキーのデータを取得

Model::resetAssociations() 動的に変更したアソシエーションを元に戻す

Model::save() 1レコード分のデータを保存

Model::saveAll() 指定レコードを全て保存

Model::saveAssociated() アソシエーションモデルを含んだデータの保存

Model::saveField() フィールド値を保存

Model::saveMany() 複数レコードの保存

Model::set() 値のセット

Model::setDataSource() データソースオブジェクトのセット

Model::setInsertID() 挿入レコードのid値をセット

Model::setSource() 指定テーブル利用のためのセッティング

Model::schema() スキーマを入手

Model::unbindModel() アソシエーションを動的に解除する

Model::updateAll() 指定レコードを全て更新

Model::updateCounterCache() カウンターキャッシュの更新

Model::validateAssociated() アソシエーションモデルのデータをバリデート

Model::validateMany() 複数レコードのバリデーション

Model::validates() バリデーションの実行

Model::validator() バリデーターオブジェクトの入手と設定

Model::_addToWhiteList() saveAll()時のホワイトリストの追加

Model::_clearCache() モデルキャッシュの消去

Model::_collectForeignKeys() 外部キーフィールド名の収集

Model::_constructLinkedModel() アソシエーションモデルの初期化

Model::_createLinks() アソシエーション設定の初期化

Model::_deleteDependent() アソシエーションモデルの対象レコードの削除

Model::_deleteLinks() HABTMアソシエーションの対象結合テーブルレコードを削除

Model::_filterResults() findの結果をフィルタリングする

Model::_findCount() レコードの数を調べる

Model::_findFirst() 最初のレコードを見つける

Model::_findList() 条件に合ったレコードのリストを作成

Model::_findNeighbors() 隣り合うレコードを見つける

Model::_findThreaded() 検索結果をスレッド形式で入手

Model::_generateAssociation() アソシエーションモデルを配列形式で生成

Model::_isUUIDField() UUIDが格納可能であるかを調べる

Model::_normalizeXmlData() 配列化されたXMLデータの正規化

Model::_prepareUpdateFields() 更新フィールドの準備

Model::_saveMulti() hasAndBelongsToManyアソシエーションの保存処理

Model::_validateWithModels() hasAndBelongsToManyアソシエーションのためのバリデーション処理

Model::beforeFind() 検索実行前のコールバック

Model::afterFind() 検索実行後のコールバック

Model::beforeSave() 保存実行前のコールバック

Model::afterSave() 保存実行後のコールバック

Model::beforeDelete() 削除実行前のコールバック

Model::afterDelete() 削除実行後のコールバック

Model::beforeValidate() バリデートを行う前のコールバック

Model::afterValidate() バリデートを行った後のコールバック

Model::onError() エラーが発生した場合のコールバック

バリデーション

ビルトイン・バリデーション

カスタム・バリデーション

バリデーション・ルールの記述

バリデーションで入力される値

Validationクラス

Validation::alphaNumeric() 半角英数字かを調べる

Validation::between() 文字長が指定範囲内であるかを調べる

Validation::boolean() 値が論理値であるかを調べる

Validation::blank() 値が空であるかを調べる

Validation::cc() クレジットカード番号であるかを調べる

Validation::comparison() 2つの値を演算する

Validation::custom() 正規表現で値をチェックする

Validation::date() 値が日付であるかチェックする

Validation::datetime() 値が日付+時間であるかチェックする

Validation::decimal() 値が十進数の数値であるかを調べる

Validation::email() 値がメールアドレスであるかを調べる

Validation::equalTo() 値が指定値と同じであるかを調べる

Validation::extension() ファイル拡張子を調べる

Validation::filesize() アップロードファイルのファイルサイズを調べる

Validation::inList() 値がリスト中に含まれているかを調べる

Validation::ip() 値がIPアドレスであるかを調べる

Validation::luhn() Luhnアルゴリズムを用いて値が正しいか検証する

Validation::maxLength() 値が指定以下の長さの文字列かを調べる

Validation::mimeType() MIME Typeのチェック

Validation::minLength() 値が指定以上の長さの文字列かを調べる

Validation::money() 値が金額かを調べる

Validation::multiple() multiple形式のselectタグの戻り値を調べる

Validation::naturalNumber() 自然数であるかのチェック

Validation::notEmpty() 値が空でないかを調べる

Validation::numeric() 値が数値データであるかを調べる

Validation::phone() 値が電話番号であるかを調べる

Validation::postal() 値が郵便番号であるかを調べる

Validation::range() 値が数値の範囲内であるかを調べる

Validation::ssn() 値が社会保障番号であるかを調べる

Validation::time() 値が時間であるかを調べる

Validation::uploadError() アップロードが正しく行われたかチェック

Validation::url() 値がURLであるかを調べる

Validation::userDefined() オリジナルの定義を使ってチェックを行う

Validation::uuid() 値がユニークコードであるかを調べる

CakeValidation

ModelValidatorクラス

ModelValidator::add() バリデーションルールの追加

ModelValidator::count() バリデーションフィールドの個数を入手

ModelValidator::errors() バリデーションエラーの入手

ModelValidator::getField() 対象フィールドのバリデーションオブジェクトを入手

ModelValidator::getIterator() バリデーションオブジェクトに対するイテレータの入手

ModelValidator::getMethods() モデルメソッドの入手

ModelValidator::getModel() バリデータ対象モデルオブジェクトの入手

ModelValidator::invalidate() バリデーションエラーメッセージの追加

ModelValidator::offsetExists() 指定フィールドのバリデーションが存在するか調べる

ModelValidator::offsetGet() 指定フィールドのバリデーションオブジェクトを入手

ModelValidator::offsetSet() 指定フィールドのバリデーションオブジェクトをセット

ModelValidator::offsetUnset() 指定フィールドのバリデーションオブジェクトを破棄

ModelValidator::remove() バリデーションルールの削除

ModelValidator::setValidationDomain() 国際化されたバリデーションメッセージのドメイン変更

ModelValidator::validateAssociated() アソシエーションモデルのデータをバリデート

ModelValidator::validateMany() 複数レコードのバリデートを実行

ModelValidator::validates() バリデーションの実行

CakeValidationSetクラス

CakeValidationSet::count() バリデーションルールの数をカウント

CakeValidationSet::getIterator() イテレータの入手

CakeValidationSet::getRule() ルールオブジェクトの入手

CakeValidationSet::getRules() 全てのルールオブジェクトの入手

CakeValidationSet::offsetExists() バリデーションルールが存在するか調べる

CakeValidationSet::offsetGet() バリデーションオブジェクトルールの入手

CakeValidationSet::offsetSet() バリデーションルールオブジェクトのセット

CakeValidationSet::offsetUnset() バリデーションオブジェクトルールの削除

CakeValidationSet::removeRule() バリデーションルールの削除

CakeValidationSet::setMethods() バリデーションメソッドのセット

CakeValidationSet::setRule() バリデーションルールオブジェクトのセット

CakeValidationSet::setRules() バリデーションルールの追加

CakeValidationSet::setValidationDomain() 国際化されたバリデーションメッセージのドメイン変更

CakeValidationSet::validate() バリデートの実行

CakeValidationRuleクラス

CakeValidationRule::checkRequired() 必須データであることが正しいかチェック

CakeValidationRule::checkEmpty() 空のデータであることをチェック

CakeValidationRule::getOptions() ルールオプション値の入手

CakeValidationRule::getValidationResult() バリデーション結果を入手

CakeValidationRule::isEmptyAllowed() 空のデータを許可しているか調べる

CakeValidationRule::isLast() バリデーションエラー時の打ち切りがあるかどうかを調べる

CakeValidationRule::isRequired() 必須フィールドかを調べる

CakeValidationRule::isUpdate() 保存形式が更新であるかを調べる

CakeValidationRule::isValid() バリデーションの通過チェック

CakeValidationRule::process() バリデートの実行

CakeValidationRule::skip() バリデート処理のスキップ対象かを調べる

ビヘイビア

ビヘイビアの利用例

ビルトインビヘイビアの利用

ContainableBehaviorクラス

ContainableBehavior::contain() アソシエーションモデルの指定

ContainableBehavior::containments() Contain処理のための前処理

ContainableBehavior::containmentsMap() Contain処理に関連するモデルのマッピング

ContainableBehavior::fieldDependencies() データ取得に必要なフィールド名の入手

ContainableBehavior::resetBindings() 一時的なモデルアソシエーションの結合をリセット

TranslateBehaviorクラス

TranslateBehavior::bindTranslation() 翻訳フィールドの動的追加

TranslateBehavior::translateModel() 翻訳用モデルのインスタンスを入手

TranslateBehavior::unbindTranslation() 翻訳フィールドの動的削除

TreeBehaviorクラス

TreeBehavior::childCount() 子ノードの数を数える

TreeBehavior::children() 子ノードの入手

TreeBehavior::generateTreeList() ツリー構造リストを作成

TreeBehavior::getParentNode() 親ノードの取得

TreeBehavior::getPath() 最上位から指定IDまでのパスに存在するレコードを取得

TreeBehavior::moveDown() 同一階層のノードの順番を下げる

TreeBehavior::moveUp() 同一階層のノードの順番を上げる

TreeBehavior::recover() 問題のある階層構造の復旧を試みる

TreeBehavior::removeFromTree() 指定ノードの取り外し

TreeBehavior::reorder() 指定ノードより下位の階層を並び替える

TreeBehavior::verify() 整合性のチェック

カスタムビヘイビアの制作

ModelBehaviorクラス

ModelBehavior::_addToWhitelist() ホワイトリストにフィールドを追加

ModelBehavior::setup() ビヘイビアのセットアップ処理

ModelBehavior::cleanup() ビヘイビアの解放処理

ModelBehavior::beforeFind() 検索実行前のコールバック

ModelBehavior::afterFind() レコード検索実行後のコールバック

ModelBehavior::beforeSave() 保存実行前のコールバック

ModelBehavior::afterSave() 保存実行後のコールバック

ModelBehavior::beforeValidate() バリデートを行う前のコールバック

ModelBehavior::beforeDelete() 削除実行前のコールバック

ModelBehavior::afterDelete() 削除実行後のコールバック

ModelBehavior::onError() エラーが発生した場合のコールバック

第4章 コントローラ・コンポーネント編

コントローラの概要

Controllerクラス

Controller::constructClasses() ModelやComponentの読み込みと初期化

Controller::disableCache() ブラウザ内キャッシュの抑止

Controller::flash() リダイレクトされる簡易的なメッセージを表示

Controller::header() HTTPヘッダを変更する

Controller::httpCodes() HTTPコードに対するメッセージの入手または設定

Controller::invokeAction() アクションの起動

Controller::getEventManager() イベントマネージャの入手

Controller::loadModel() モデルを動的に読み込む

Controller::paginate() ページングを考慮したデータの検索を行う

Controller::postConditions() ポスト形式の連想配列からモデルの検索条件を作成

Controller::redirect() リダイレクト処理を実行する

Controller::referer() リファラを入手

Controller::render() ビューのレンダリング

Controller::set() ビューにデータをセット

Controller::setAction() 他のアクションを実行

Controller::setRequest() リクエスト情報クラスのインスタンスをセット

Controller::shutdownProcess() コントローラの終了プロセスを実行

Controller::startupProcess() コントローラの開始プロセスを実行

Controller::validate() バリデーションエラーの数を取得する

Controller::validateErrors() バリデーションエラーのメッセージを取得する

Controller::_parseBeforeRedirect() beforeRedirectからのパラメータを統合する

Controller::_isPrivateAction() プライベートアクションであるかを調べる

Controller::_getScaffold() スキャフォルドクラスのインスタンスを入手

Controller::_mergeControllerVars() 親クラスのプロパティ値を合成

Controller::_mergeUses() モデル設定の結合

Controller::beforeFilter() コントローラ処理開始前のコールバック

Controller::beforeRender() ビューレンダリング前のコールバック

Controller::beforeRedirect() リダイレクト前のコールバック

Controller::afterFilter() コントローラ処理後のコールバック

Controller::beforeScaffold() スキャフォルド実行前のコールバック

Controller::afterScaffoldSave() スキャフォルド内での保存処理実行後のコールバック

Controller::afterScaffoldSaveError() スキャフォルドの保存処理実行でのエラー時コールバック

Controller::scaffoldError() スキャフォルド内でのエラー時コールバック

Controller::_beforeScaffold() スキャフォルド実行前のコールバック

Controller::_afterScaffoldSave() スキャフォルド内での保存処理実行後のコールバック

Controller::_afterScaffoldSaveError() スキャフォルドの保存処理実行でのエラー時コールバック

Controller::_scaffoldError() スキャフォルド内でのエラー時コールバック

AppControllerクラス

PagesControllerクラス

PagesController::display() 静的ページの表示

コンポーネント

コンポーネントを利用する

コンポーネントを作成する

コールバック

組み込みコンポーネント

Componentクラス

Component::initialize() コンポーネント初期化時のコールバック

Component::startup() コントローラのスタートアップ時のコールバック

Component::beforeRender() ビューレンダリング前のコールバック

Component::beforeRedirect() リダイレクト前のコールバック

Component::shutdown() コントローラのシャットダウン時のコールバック

AuthComponentクラス

AuthComponent::allow() 承認なしで許可するアクションのセット

AuthComponent::isAuthorized() 認証済みかを調べる

AuthComponent::constructAuthenticate() 認証機能の初期化

AuthComponent::constructAuthorize() 承認機能の初期化

AuthComponent::deny() 承認の必要なアクションを指定

AuthComponent::flash() フラッシュメッセージのセット

AuthComponent::identify() 認証済みのユーザ情報の入手

AuthComponent::loggedIn() 認証済かを調べる

AuthComponent::login() ログイン処理を行う

AuthComponent::logout() ログアウトを行う

AuthComponent::mapActions() アクションのCRUDに対応する承認設定

AuthComponent::password() パスワードのハッシュ化

AuthComponent::redirect() リダイレクト先のURLの登録と入手

AuthComponent::user() 認証済みユーザのユーザ情報の登録と入手

CookieComponentクラス

CookieComponent::check() 指定クッキー値の削除

CookieComponent::delete() 指定クッキー値の削除

CookieComponent::destroy() クッキー登録値を全て破棄

CookieComponent::read() クッキーから値の読み込み

CookieComponent::type() Cookieの暗号化アルゴリズムの指定

CookieComponent::write() クッキーに値の書き込み

EmailComponentクラス

EmailComponent::reset() 設定値の初期化

EmailComponent::send() メールの送信

PaginatorComponentクラス

PaginatorComponent::checkLimit() ページレコード数の上限をチェック

PaginatorComponent::getDefaults() デフォルトのページングオプション値の取得

PaginatorComponent::mergeOptions() オプション値を統合する

PaginatorComponent::paginate() ページングのためのデータレコードを検索

PaginatorComponent::validateSort() ソート条件の検証

RequestHandlerComponentクラス

RequestHandlerComponent::accepts() 指定された形式がクライアントに受け入れられるかを調べる

RequestHandlerComponent::addInputType() 入力タイプと変換処理コールバックの登録

RequestHandlerComponent::convertXml() 入力データのXMLコンバート

RequestHandlerComponent::getAjaxVersion() Ajaxのバージョンを調べる

RequestHandlerComponent::getClientIP() クライアント側のIPアドレスを入手する

RequestHandlerComponent::getReferer() リファラを入手する

RequestHandlerComponent::isAjax() Ajaxからのリクエストであるかを調べる

RequestHandlerComponent::isAtom() Atomのレスポンスが可能か調べる

RequestHandlerComponent::isDelete() DELETEでのリクエストかを調べる

RequestHandlerComponent::isFlash() Flashからのリクエストであるかを調べる

RequestHandlerComponent::isGet() GETでのリクエストかを調べる

RequestHandlerComponent::isMobile() モバイル端末からのリクエストであるかを調べる

RequestHandlerComponent::isPost() POSTでのリクエストかを調べる

RequestHandlerComponent::isPut() PUTでのリクエストかを調べる

RequestHandlerComponent::isRss() RSSのレスポンスが可能か調べる

RequestHandlerComponent::isSSL() SSL通信であるかを調べる

RequestHandlerComponent::isWap() WAP端末からのリクエストであるかを調べる

RequestHandlerComponent::isXml() XMLのリクエストを許可しているかをを調べる

RequestHandlerComponent::mapAlias() Content-Typeのエイリアス名からMIMETypeを入手

RequestHandlerComponent::mapType() Content-Typeからエイリアス名を入手

RequestHandlerComponent::prefers() クライアントの表示優先度の高いタイプを調べる

RequestHandlerComponent::renderAs() 指定形式にあったビューレンダー設定をコントローラに対して行う

RequestHandlerComponent::requestedWith() コンテンツタイプの入手または判定

RequestHandlerComponent::respondAs() レスポンスの形式を指定する

RequestHandlerComponent::responseType() 現在のレスポンスのタイプ名を入手

RequestHandlerComponent::setContent() Content-Typeをセットする

SecurityComponentクラス

SecurityComponent::blackHole() 不正なリクエストに対して行う処理を指定

SecurityComponent::generateToken() トークンの生成

SecurityComponent::requireAuth() 認証済みを要求するアクションの設定

SecurityComponent::requireDelete() DELETEアクセスを要求するアクションの設定

SecurityComponent::requireGet() GETアクセスを要求するアクションの設定

SecurityComponent::requirePost() POSTアクセスを要求するアクションの設定

SecurityComponent::requirePut() PUTアクセスを要求するアクションの設定

SecurityComponent::requireSecure() HTTPSアクセスを要求するアクションの設定

SessionComponentクラス

SessionComponent::check() セッション値の存在チェック

SessionComponent::delete() セッション値の削除

SessionComponent::destroy() セッションの破棄

SessionComponent::error() セッション内のエラーを入手

SessionComponent::id() セッションIDを入手、もしくは設定

SessionComponent::read() セッションから値の読み出し

SessionComponent::renew() セッションIDを振り直す

SessionComponent::setFlash() 一時的なビューに表示するためのメッセージを設定する

SessionComponent::started() セッションが開始しているかを調べる

SessionComponent::userAgent() ユーザエージェントの登録および入手

SessionComponent::valid() セッションが有効であるか調べる

SessionComponent::write() セッションに値を記録する

第5章 ビュー・ヘルパー編

ビューの概要

ビューファイルの作成とビュークラスの利用

Viewクラス

View::addScript() スクリプトを追加

View::append() ビューブロックに追記

View::assign() ビューブロックの開始

View::blocks() ビューブロック名の入手

View::element() エレメントの入手

View::elementExists() エレメントの存在チェック

View::end() ビューブロックの終了宣言

View::extend() ビューテンプレートの拡張

View::fetch() ビューブロックの内容を入手

View::get() コントローラからビューに送出された値の入手

View::getEventManager() イベントマネージャの入手

View::getVar() コントローラからビューに送出された値の入手

View::getVars() コントローラからビューに送出された値を全て入手

View::loadHelper() ヘルパーの読み込み

View::loadHelpers() ヘルパーを全て読み込む

View::pluginSplit() プラグイン名の分離

View::prepend() ビューブロックの前方に文字列を追加

View::renderLayout() レイアウトのレンダリング

View::render() ビューのレンダリング

View::renderCache() キャッシュのレンダリング

View::set() ビューで使用する値のセット

View::start() ビューブロックの開始

View::startIfEmpty() ビューブロックが一度も登録されていない場合の開始

View::uuid() ユニークIDの発行

View::_elementCache() キャッシュ済みエレメントの読み込み

View::_evaluate() ビューの描画

View::_getElementFileName() エレメントファイルのパスを生成

View::_getExtensions() 拡張子の入手

View::_getLayoutFileName() エレメントファイルのパスを生成

View::_getViewFileName() ビューテンプレートファイルのパスを生成

View::_paths() ビューに必要なファイルパスを全て入手

View::_render() ビューレンダリングの実行本体

View::_renderElement() エレメントのレンダリング

ViewBlockクラス

ViewBlock::active() アクティブなビューブロック名の入手

ViewBlock::append() ビューブロックに追記する

ViewBlock::concat() ビューブロックの前方もしくは後方に追記する

ViewBlock::end() ビューブロックの終了

ViewBlock::get() ビューブロックコンテンツの取り出し

ViewBlock::keys() 登録済みのビューブロック名を全て取り出す

ViewBlock::set() ビューブロックコンテンツのセット

ViewBlock::start() ビューブロックの開始

ViewBlock::startIfEmpty() ビューブロックが一度も登録されていない場合の開始

ViewBlock::unclosed() 閉じられていないビューブロック名の入手

ヘルパー

ヘルパーの利用

FormHelperクラス

FormHelper::button() ボタンタグの生成

FormHelper::checkbox() checkboxタグの生成

FormHelper::create() フォームの開始を宣言する

FormHelper::dateTime() 日時タグを生成

FormHelper::day() 「日」のセレクトタグを生成

FormHelper::end() フォームの終了宣言

FormHelper::error() エラーメッセージの出力

FormHelper::file() ファイルインプットタグの生成

FormHelper::hidden() hiddenタグの生成

FormHelper::hour() 「時」のセレクトタグを生成

FormHelper::isFieldError() フィールドのエラーがあるかを調べる

FormHelper::input() 入力フォームの生成

FormHelper::inputDefaults() インプットフォームのデフォルト値を設定する

FormHelper::inputs() 入力フォームをまとめて生成

FormHelper::label() ラベルタグ文字列を生成する

FormHelper::meridian() 午前/午後のセレクトタグを生成

FormHelper::minute() 「分」のセレクトタグを生成

FormHelper::month() 「月」のセレクトタグを生成

FormHelper::postButton() 単独動作のサブミットボタンを作成

FormHelper::postLink() POSTにて値の送出が可能なHTMLリンクの生成

FormHelper::radio() radioタグの生成

FormHelper::select() selectタグの生成

FormHelper::secure() CSRF対策用トークンの埋め込み

FormHelper::submit() サブミットボタンタグの生成

FormHelper::tagIsInvalid() フィールドエラーの発生している箇所を調べる

FormHelper::textarea() textareaタグの生成

FormHelper::unlockField() セキュア機能の非対象フィールドを指定

FormHelper::year() 「年」のセレクトタグを生成

HtmlHelperクラス

HtmlHelper::addCrumb() パンくずリストに項目を追加する

HtmlHelper::charset() 文字エンコーディングの設定

HtmlHelper::css() CSSを出力する

HtmlHelper::div() divタグを生成

HtmlHelper::docType() doctypeタグを生成する

HtmlHelper::meta() メタタグの生成

HtmlHelper::getCrumbList() パンくずリストの生成

HtmlHelper::getCrumbs() パンくずリストを生成

HtmlHelper::image() 画像タグの生成

HtmlHelper::link() リンクの生成

HtmlHelper::loadConfig() 設定ファイルを読み込む

HtmlHelper::media() メディアHTMLを生成

HtmlHelper::nestedList() リストの生成

HtmlHelper::para() pタグ文字列を生成

HtmlHelper::script() スクリプトリンクの生成

HtmlHelper::scriptBlock() JavaScriptのコードをHTML内に記述

HtmlHelper::scriptEnd() スクリプトの終了を宣言してコード生成

HtmlHelper::scriptStart() スクリプトの開始宣言をする

HtmlHelper::style() インラインスタイルシートを表示

HtmlHelper::tableCells() テーブルセル(td)の生成

HtmlHelper::tableHeaders() テーブルヘッダー(th)の生成

HtmlHelper::tag() 一般的に用いられるHTMLタグの生成

HtmlHelper::useTag() 一般的に用いられるHTMLタグの生成

JsHelperクラス・JsBaseEngineHelperクラス

JsHelper::buffer() バッファにスクリプトコードを追加する

JsHelper::getBuffer() スクリプトバッファからコードを取り出す

JsHelper::set() JavaScriptで使用する値を登録する

JsHelper::link() Ajaxに対応したリンクの生成

JsHelper::submit() Ajaxに対応したサブミットボタンの生成

JsHelper::value() JavaScript値の生成

JsHelper::writeBuffer() スクリプトバッファの内容を書き出す

JsBaseEngineHelper::alert() ダイアログを表示する

JsBaseEngineHelper::confirm() 確認ダイアログを生成する

JsBaseEngineHelper::confirmReturn() 戻り値付きの確認ダイアログを生成する

JsBaseEngineHelper::domReady() domReadyイベントで実行するスクリプトを設定

JsBaseEngineHelper::drag() オブジェクトをドラッグできるようにする

JsBaseEngineHelper::drop() オブジェクトをドロップできるようにする

JsBaseEngineHelper::each() イテレーション処理の実行

JsBaseEngineHelper::effect() エフェクトを生成する

JsBaseEngineHelper::escape() スクリプト内をエスケープする

JsBaseEngineHelper::event() JavaScriptイベントの設定

JsBaseEngineHelper::get() 対象JavaScriptオブジェクトの指定

JsBaseEngineHelper::object() JavaScriptオブジェクトを生成する

JsBaseEngineHelper::prompt() プロンプトダイアログを生成する

JsBaseEngineHelper::redirect() JavaScriptでリダイレクト指定する

JsBaseEngineHelper::request() リクエストを発行する

JsBaseEngineHelper::serializeForm() フォームの内容をシリアライズする

JsBaseEngineHelper::slider() スライダーの設置

JsBaseEngineHelper::sortable() 入れ替え可能オブジェクトの生成

NumberHelperクラス

NumberHelper::addFormat() 通貨単位の追加

NumberHelper::currency() 通貨単位による数値のフォーマッティング

NumberHelper::defaultCurrency() デフォルトの通貨単位をセット

NumberHelper::format() 数値のフォーマッティング

NumberHelper::precision() 小数点以下の桁を切り詰める

NumberHelper::toPercentage() 数値をパーセント表記にする

NumberHelper::toReadableSize() バイト数を計算して大きな単位の数値表現にする

PaginatorHelperクラス

PaginatorHelper::counter() ページカウンターを入手

PaginatorHelper::current() 現在のページ番号を入手

PaginatorHelper::defaultModel() デフォルトモデルの入手

PaginatorHelper::first() 「最初へ」リンクの生成

PaginatorHelper::hasPrev() 「戻る」が表示できるかをチェック

PaginatorHelper::hasNext() 「次へ」が表示できるかをチェック

PaginatorHelper::hasPage() 該当ページが存在するかをチェック

PaginatorHelper::last() 「最後へ」リンクの生成

PaginatorHelper::link() リンクを生成する

PaginatorHelper::next() 「進む」リンクの作成

PaginatorHelper::numbers() ページ番号のリンクを生成する

PaginatorHelper::options() オプションの設定

PaginatorHelper::params() ページネーションに関するパラメータの入手

PaginatorHelper::prev() 「戻る」リンクの作成

PaginatorHelper::sort() ソート用リンクを生成

PaginatorHelper::sortDir() 現在のソート方向を入手

PaginatorHelper::sortKey() 現在のソート対象のフィールド名を入手

PaginatorHelper::url() URLを生成する

RssHelperクラス

RssHelper::channel() チャンネルエレメントの生成

RssHelper::document() RSSであることを宣言する

RssHelper::elem() チャンネルエレメントの生成

RssHelper::item() item要素を個別に生成

RssHelper::items() アイテムの設置

RssHelper::time() RSS用時間文字列の生成

SessionHelperクラス

SessionHelper::read() セッションから値の読み出し

SessionHelper::check() セッション値の存在チェック

SessionHelper::error() セッションに関するエラーメッセージの入手

SessionHelper::flash() 一時的なメッセージの表示

SessionHelper::valid() セッションが有効であるか調べる

TextHelperクラス

TextHelper::autoLink() URLおよびメールアドレスと思われる文字列に対して自動でリンクを生成

TextHelper::autoLinkEmails() メールアドレスと思われる文字列に対して自動でリンクを生成

TextHelper::autoLinkUrls() URLと思われる文字列に対して自動でリンクを生成

TextHelper::excerpt() 文字列から指定キーワードを中心とする指定文字数のテキストを抜き出す

TextHelper::highlight() ハイライト化されたテキストの生成

TextHelper::stripLinks() リンクタグを除去する

TextHelper::truncate() 長い文字列を切り詰める

TextHelper::toList() 配列の文字列を文章形式に変換

TimeHelperクラス

TimeHelper::convertSpecifiers() 国際化を考慮したstrftime()フォーマットの入手

TimeHelper::convert() 時差の補正

TimeHelper::dayAsSql() 特定日を検索するためのSQL条件式を生成する

TimeHelper::daysAsSql() 特定日をまたぐSQL条件式を生成する

TimeHelper::format() 日付の入手

TimeHelper::fromString() 時間文字列からUNIX時間に変換

TimeHelper::gmt() 世界標準時の入手

TimeHelper::i18nFormat() 国際化を考慮した日付の入手

TimeHelper::isThisMonth() 今月であるかを調べる

TimeHelper::isThisWeek() 今週であるかを調べる

TimeHelper::isThisYear() 今年であるかを調べる

TimeHelper::isToday() 今日であるかを調べる

TimeHelper::isTomorrow() 明日であるかを調べる

TimeHelper::nice() 英語表記の日付表示に変換する

TimeHelper::niceShort() 簡略化した英語表記の日付表示に変換する

TimeHelper::serverOffset() サーバ内の時差を入手する

TimeHelper::timeAgoInWords() 現在からの経過時間を生成

TimeHelper::toAtom() Atom形式の時間に変換

TimeHelper::toQuarter() 四半期を調べる

TimeHelper::toRSS() RSS形式の時間に変換

TimeHelper::toUNIX() UNIX時間に変換する

TimeHelper::wasWithinLast() 指定日時が期間内かを調べる

TimeHelper::wasYesterday() 昨日であるかを調べる

ヘルパーの作成

Helperクラス

Helper::addClass() タグのオプションに要素を追加する

Helper::assetTimestamp() ファイルのタイムスタンプを付加したファイルパスを入手

Helper::assetUrl() アセットのURLを生成

Helper::clean() アウトプットを汚染されていないコンテンツにクリーニングする

Helper::domId() タグ用オプションにDOMのIDを与える

Helper::entity() 現在のエンティティ名を入手

Helper::field() 現在の対象フィールド名を入手

Helper::model() カレントモデル名を入手

Helper::output() 出力用のコンテンツを得る

Helper::setEntity() 与えたエンティティ名からビューにエンティティをセットする

Helper::url() URL文字列を取得

Helper::value() タグ用オプションもしくはデータから値の入手

Helper::webroot() webroot上のファイルパスを入手する

Helper::_clean() アウトプットを汚染されていないコンテンツにクリーニングする

Helper::_formatAttribute() アトリビュート値をフォーマットに従って書き出す

Helper::_initInputField() 入力フィールドについて初期化

Helper::_name() タグオプション値の「name」を反映する

Helper::_parseAttributes() アトリビュートをパースする

Helper::_reset() コンテンツのクリーニング後のリセット

Helper::_selectedArray() 選択されたHABTMフォームデータの入手

Helper::beforeRender() ビューのレンダリング開始前のコールバック

Helper::afterRender() ビューのレンダリング終了直後のコールバック

Helper::beforeLayout() レイアウトのレンダリング開始前のコールバック

Helper::afterLayout() レイアウトのレンダリング終了後のコールバック

Helper::beforeRenderFile() ファイルのレンダリング開始前のコールバック

Helper::afterRenderFile() ファイルのレンダリング開始後のコールバック

テーマ

テーマの作成

テーマ内で使用するファイルの設置

コントローラでのテーマの指定

メディアビュー

第6章 ルーティング編

URLからコントローラ・アクションを特定する(ルーティング)

基本的なルーティング指定

プラグインの利用

prefixルーティング

Routerクラス

Router::connect() ルーティングの設定

Router::connectNamed() 名前付きパラメータの設定

Router::currentRoute() カレントのリクエストルーティングを入手する

Router::defaultRouteClass() デフォルトのルーティングクラス名を入手

Router::extensions() ルーティングに有効な拡張子の入手

Router::getNamedExpressions() 名前付きパラメータのデフォルト正規表現の入手

Router::getParam() リクエストパラメータの特定値を入手

Router::getParams() リクエストパラメータの入手

Router::getPaths() パスを入手

Router::getRequest() CakeRequestオブジェクトの入手

Router::mapResources() RESTリソースのマッピング

Router::namedConfig() 名前付きパラメータの設定情報を入手

Router::normalize() URLを正規化する

Router::parse() URL文字列をパースしてパス情報を入手

Router::parseExtensions() パースする拡張子の設定

Router::popRequest() リクエストオブジェクトのスタックからオブジェクトの取り出し

Router::prefixes() マッピング済みのprefixルーティングを入手

Router::promote() 指定ルーティング順を昇格させる

Router::queryString() クエリストリングの生成・追加

Router::redirect() リダイレクトルーティングの追加

Router::reload() ルーティング情報を読み直す

Router::requestRoute() 親のリクエストルーティングを入手する

Router::resourceMap() RESTリソースマップの登録および入手

Router::reverse() 逆ルーティングを行う

Router::setExtensions() ルーティングに有効な拡張子を登録

Router::setRequestInfo() リクエストオブジェクトの登録

Router::stripPlugin() プラグイン名を取り除く

Router::url() URLの生成

CakeRouteクラス

CakeRoute::compile() ルートのコンパイルを行う

CakeRoute::compiled() コンパイル済みであるかを調べる

CakeRoute::match() URLとルートパラメータのマッチング

CakeRoute::parse() URLのパース処理

CakeRoute::persistParams() パース済みURL内に不足したパラメータを補う

CakeRoute::_matchNamed() 名前付きパラメータが正当か調べる

CakeRoute::_parseArgs() URLパラメータのパース

CakeRoute::_writeRoute() ルート情報の書き出し

CakeRoute::_writeUrl() URLの書き出し

第7章 ACL編

ACLとは?

ACLの設定

ACL用データベースの設定

ACLを使うための設定

AROの登録

ACOの登録

AROのACOに対するアクセス権設定を行う

アクセス権のチェック

AclComponent

AclComponentクラス

AclComponent::adapter() アダプターの作成

AclComponent::allow() AROのACOに対するアクセス権を許可にする

AclComponent::check() AROがACO対してアクセス権があるかを調べる

AclComponent::deny() AROのACOに対するアクセス権を「拒否」にする

AclComponent::inherit() AROのACOに対するアクセス権を親のものに継承させる

第8章 キャッシュ編

Cacheクラス

Cacheクラスの利用例

Cacheクラス

Cache::clear() 全てのキャッシュ値を削除

Cache::clearGroup() 指定グループのキャッシュを消去

Cache::config() キャッシュシステムの設定

Cache::configured() 設定情報を全て入手

Cache::decrement() キャッシュ値を減少させる

Cache::delete() キャッシュ値の削除

Cache::drop() 設定情報を削除する

Cache::gc() ガベージコレクションの実行

Cache::increment() キャッシュ値を増加する

Cache::isInitialized() キャッシュエンジンの初期化が完了済みかを調べる

Cache::read() キャッシュから値の読み込み

Cache::set() 一時的に設定変更を行う

Cache::settings() キャッシュ設定情報を入手

Cache::write() キャッシュに値を記録

CacheHelperクラス

CacheHelper::cache() キャッシュの読み出しと保存

第9章 コアライブラリ編

基本ライブラリ

CakePHPグローバル関数(basics.php)

am() 配列を結合する

cache() ファイルキャッシュの読み書き

clearCache() ファイルキャッシュの削除

config() コンフィグファイルの読み込み

convertSlash() スラッシュを変換する

debug() デバッグ情報の生成

env() 環境変数の入手

fileExistsInPath() 指定ファイルがパス内に存在するかをチェックする

h() 特殊文字をHTMLエンティティに変換する

LogError() エラーログの出力

sortByKey() 対象キーをソート対象とした配列の並び替え

pluginSplit() 文字列をプラグイン名とクラス名に分割する

pr() 値の内容を可視化する

stripslashes_deep() 再帰的にクォートされた文字列のクォート部分を取り除く

__() 指定単語を翻訳する

__c() カテゴリを考慮した翻訳を行う

__d() ドメインを考慮した翻訳を行う

__dc() ドメイン・カテゴリを考慮した翻訳を行う

__dcn() ドメイン・カテゴリ・複数形を考慮した翻訳を行う

__dn() ドメイン・複数形を考慮した翻訳を行う

__n() 複数形を考慮した翻訳を行う

Appクラス

App::build() パスを追加登録

App::core() コアコードのディレクトリパスを入手

App::import() コードのインポート

App::init() Appの初期化

App::load() クラスファイルのローディング

App::location() 指定クラスのパッケージ名を入手

App::objects() 存在するクラスオブジェクトを調べる

App::path() 指定パッケージ名で有効なパスを入手する

App::paths() 有効なパスを全て入手

App::pluginPath() 指定プラグインの格納されているディレクトリパスを入手

App::shutdown() アプリケーションのシャットダウン処理

App::themePath() テーマの格納されているディレクトリを入手

App::uses() 利用クラスを宣言する

Configureクラス

Configure::bootstrap() ブートストラップ処理を行う

Configure::check() 指定設定情報が存在するか調べる

Configure::clear() 設定情報を全て破棄する

Configure::config() 設定リーダーの登録

Configure::configured() 設定リーダーが登録されているか調べる

Configure::delete() 設定値の削除

Configure::drop() 設定リーダーの破棄

Configure::dump() 設定値を指定リーダー形式でダンプする

Configure::load() 設定リーダーから設定内容を読み込み

Configure::read() 設定情報の読み込み

Configure::restore() キャッシュから設定値を復元する

Configure::store() キャッシュに設定値を保存する

Configure::version() CakePHPのバージョンを入手

Configure::write() 設定情報の記録

Objectクラス

Object::dispatchMethod() メソッドのコール

Object::log() ログの出力

Object::requestAction() 他のアクションを実行する

Object::toString() クラス名を返す

Object::_mergeVars() 別のクラスオブジェクトとプロパティ値をマージする

Object::_set() プロパティ値をまとめてセット

Object::_stop() 処理の強制終了

ClassRegistryクラス

ClassRegistry::addObject() オブジェクトの登録

ClassRegistry::config() 初期化情報をあらかじめ登録する

ClassRegistry::flush() オブジェクトの全消去

ClassRegistry::getInstance() クラスインスタンスを入手する

ClassRegistry::getObject() オブジェクトの入手

ClassRegistry::init() モデルクラスの初期化とオブジェクトの入手

ClassRegistry::isKeySet() 登録名が存在するかチェック

ClassRegistry::keys() 登録名を全て入手

ClassRegistry::map() 別名をマッピングする

ClassRegistry::mapKeys() マップされたキーの入手

ClassRegistry::removeObject() オブジェクトの削除

Multibyteクラス

Multibyte::ascii() 分解された文字コードを文字列に復元する

Multibyte::checkMultibyte() マルチバイト文字列かを調べる

Multibyte::mimeEncode() MIMEエンコーディングを行う

Multibyte::stripos() 大文字小文字を区別しないで文字列の位置を取得

Multibyte::stristr() 大文字小文字を区別しないで文字列を最初に見つけた位置から前後を取得

Multibyte::strlen() 文字列の長さを得る

Multibyte::strpos() 大文字小文字を区別して文字列の位置を取得

Multibyte::strrpos() 大文字小文字を区別して文字列が最後に現れる位置を取得

Multibyte::strrchr() 大文字小文字を区別して文字を最後に見つけた位置から前後を取得

Multibyte::strrichr() 大文字小文字を区別しないで文字を最後に見つけた位置から前後を取得

Multibyte::strripos() 大文字小文字を区別しないで文字列が最後に現れる位置を取得

Multibyte::strstr() 大文字小文字を区別して文字列を最初に見つけた位置から前後を取得

Multibyte::strtolower() 全て小文字の文字列に変換する

Multibyte::strtoupper() 全て大文字の文字列に変換する

Multibyte::substr() 文字列の一部分を取得

Multibyte::substrCount() 文字列の出現回数を入手

Multibyte::utf8() 文字列をUTF-8の文字コード1文字単位に分解する

ロギング関連

CakeLogクラス

CakeLog::alert() 緊急的なログメッセージを登録

CakeLog::config() CakeLog設定を行う

CakeLog::configured() 登録済みストリーム名の入手

CakeLog::critical() 危機的ログメッセージを登録

CakeLog::debug() デバッグレベルのログメッセージを記録

CakeLog::defaultLevels() デフォルトのログレベルを入手

CakeLog::disable() 指定ストリーム名のLogEngineを休止

CakeLog::drop() 指定ストリーム名のLogEngineを破棄

CakeLog::info() 情報レベルのログメッセージを登録

CakeLog::emergency() 致命的状況を示すログメッセージを登録

CakeLog::enabled() 指定ストリーム名のLogEngineを有効化

CakeLog::error() エラーレベルのログメッセージを登録

CakeLog::levels() ログレベルの追加とリストの入手

CakeLog::notice() 注意レベルのログメッセージを登録

CakeLog::stream() LogEngineオブジェクトの入手

CakeLog::warning() ワーニングレベルのログメッセージを登録

CakeLog::write() ログの記録

CakeLogInterfaceインターフェース

CakeLogInterface::write() ログの記録

BaseLogクラス

BaseLog::config() LogEngine設定を行う

BaseLog::write() ログの記録

リクエストとレスポンス

CakeRequestクラス

CakeRequest::acceptLanguage() 許可言語の入手

CakeRequest::accepts() 指定された形式がクライアントに受け入れられるかを調べる

CakeRequest::addDetector() ディテクターの登録

CakeRequest::addParams() リクエストパラメータの登録

CakeRequest::addPaths() パスの変更

CakeRequest::clientIp() クライアント側のIPアドレスを入手する

CakeRequest::data() リクエストデータの入手とセット

CakeRequest::domain() ドメイン名を入手

CakeRequest::header() HTTPヘッダ情報を入手

CakeRequest::here() カレントのパスを入手

CakeRequest::host() ホスト名の入手

CakeRequest::input() インプットストリームからのデータ入手

CakeRequest::is() リクエストタイプの判定

CakeRequest::method() リクエストメソッドの入手

CakeRequest::offsetGet() 指定パラメータの入手

CakeRequest::offsetSet() 指定パラメータのセット

CakeRequest::offsetExists() 指定パラメータの存在チェック

CakeRequest::offsetUnset() 指定パラメータの消去

CakeRequest::onlyAllow() リクエストタイプが許可されているか調べる

CakeRequest::parseAccept() HTTP_ACCEPTのパース

CakeRequest::query() クエリストリング中の指定パラメータを入手

CakeRequest::referer() リファラの入手

CakeRequest::subdomains() サブドメイン名の入手

CakeResponseクラス

CakeResponse::body() コンテンツの登録と入手

CakeResponse::cache() キャッシュヘッダの登録

CakeResponse::charset() Charsetの登録

CakeResponse::compress() レスポンスデータの圧縮

CakeResponse::checkNotModified() 変更なしコンテンツであるかのチェック

CakeResponse::cookie() クッキー情報の入手とセット

CakeResponse::disableCache() キャッシュを行わない設定をする

CakeResponse::download() コンテンツのダウンロードファイル名をセット

CakeResponse::expires() コンテンツの有効期限をセット

CakeResponse::etag() ETagのセット

CakeResponse::file() ファイルの表示もしくはダウンロード

CakeResponse::getMimeType() MIME-Typeの入手

CakeResponse::header() レスポンスヘッダの入手・登録

CakeResponse::httpCodes() HTTPステータスコードメッセージの入手

CakeResponse::length() Content-Length値の登録と入手

CakeResponse::mapType() MIME-Typeからエイリアス名を入手

CakeResponse::maxAge() コンテンツの鮮度を指定する

CakeResponse::modified() コンテンツの変更時間を指定する

CakeResponse::mustRevalidate() キャッシュ有効チェックの指定をする

CakeResponse::notModified() 未更新レスポンスの設定

CakeResponse::outputCompressed() コンテンツ出力が圧縮可能かを調べる

CakeResponse::protocol() プロトコルのセットと入手

CakeResponse::send() レスポンスの送出

CakeResponse::sharable() キャッシュの共有が可能であるかの設定と入手

CakeResponse::sharedMaxAge() キャッシュの共有可能な有効時間の設定と入手

CakeResponse::statusCode() ステータスコードのセットと入手

CakeResponse::type() Content-Typeの登録と入手

CakeResponse::vary() Varyヘッダの設定と入手

ネットワーク関連

CakeSocketクラス

CakeSocket::address() 接続先のIPアドレスを入手

CakeSocket::addresses() 関連性のあるIPアドレスの入手

CakeSocket::connect() ソケット接続の実行

CakeSocket::context() ストリームコンテキストのオプション値を入手

CakeSocket::disconnect() ソケット接続の切断

CakeSocket::enableCrypto() 接続済みのソケットについて暗号化のON/OFFの切り替え

CakeSocket::host() 接続先のホスト名を入手

CakeSocket::lastError() 最新のエラーを入手

CakeSocket::read() データ受信

CakeSocket::reset() 設定情報のリセット

CakeSocket::setLastError() ソケット通信エラーのセット

CakeSocket::write() データ送信

HttpSocketクラス

HttpSocket::buildCookies() クッキー情報からクッキー用のヘッダ文字列を生成する

HttpSocket::configAuth() HTTPAuthの設定

HttpSocket::configProxy() プロキシの設定

HttpSocket::delete() DELETEで通信を行い結果を得る

HttpSocket::get() GETで通信を行い結果を得る

HttpSocket::post() POSTで通信を行い結果を得る

HttpSocket::put() PUTで通信を行い結果を得る

HttpSocket::request() リクエストを行う

HttpSocket::reset() インスタンス内を初期化する

HttpSocket::setContentResource() リソースのセット

HttpSocket::url() URIをパースしてURLを生成

HttpResponse/HttpSocketResponseクラス

HttpSocketResponse::body() コンテンツの入手

HttpSocketResponse::getHeader() ヘッダ中のデータ入手

HttpSocketResponse::isOk() 正常レスポンスかを調べる

HttpSocketResponse::isRedirect() リダイレクトであるかを調べる

HttpSocketResponse::offsetExists() オフセットが存在するかを調べる

HttpSocketResponse::offsetGet() オフセットに対する値の入手

HttpSocketResponse::offsetSet() オフセット値をセット

HttpSocketResponse::offsetUnset() オフセット値を削除

HttpSocketResponse::parseCookies() クッキー値のパース

HttpSocketResponse::parseResponse() レスポンスデータのパース

セッション関連

CakeSessionクラス

CakeSession::check() セッション値の存在チェック

CakeSession::clear() セッション値のクリア

CakeSession::delete() セッション値の削除

CakeSession::destroy() セッションの破棄

CakeSession::error() セッション内のエラーを入手

CakeSession::id() セッションIDを入手、もしくは設定

CakeSession::init() セッション機能の初期化

CakeSession::read() セッションから値の読み出し

CakeSession::renew() セッションIDを振り直す

CakeSession::start() セッションの開始

CakeSession::started() セッションが開始しているかを調べる

CakeSession::userAgent() ユーザエージェントの登録および入手

CakeSession::valid() セッションが有効であるか調べる

CakeSession::write() セッションに値を記録する

メール送信関連

CakeEmailクラス

CakeEmail::addAttachments() 添付ファイルの追加

CakeEmail::addBcc() BCCを送るメールアドレスを追加

CakeEmail::addCc() CCを送るメールアドレスを追加

CakeEmail::addHeaders() メールヘッダの内容を追加する

CakeEmail::addTo() 送信先メールアドレスを追加

CakeEmail::attachments() 添付ファイルを設定する

CakeEmail::bcc() BCCを送るメールアドレスを設定

CakeEmail::cc() CCを送るメールアドレスを設定

CakeEmail::charset() メールの文字コードを設定

CakeEmail::config() メール設定情報を登録

CakeEmail::deliver() メール情報をまとめて設定して送信

CakeEmail::domain() ドメイン名の設定

CakeEmail::emailFormat() メールフォーマットの設定

CakeEmail::from() 送信元メールアドレスを設定

CakeEmail::getHeaders() ヘッダ情報の入手

CakeEmail::headerCharset() ヘッダ用文字コードの設定

CakeEmail::helpers() テンプレート内で使用するヘルパーの設定

CakeEmail::messageId() メッセージIDの登録

CakeEmail::message() メール本文の入手

CakeEmail::replyTo() 返信先メールアドレスの登録

CakeEmail::readReceipt() 開封通知返信先メールアドレスの登録

CakeEmail::reset() メール情報のリセット

CakeEmail::returnPath() ドメイン付き返信先の登録

CakeEmail::send() メール送信

CakeEmail::sender() 差出人を登録

CakeEmail::setHeaders() ヘッダ情報のセット

CakeEmail::subject() メールタイトルの登録

CakeEmail::to() 宛先を登録

CakeEmail::template() ビューテンプレートの設定

CakeEmail::theme() テーマの設定

CakeEmail::transport() Transport名のセット

CakeEmail::transportClass() Transportオブジェクトの入手

CakeEmail::viewRender() ビュークラスの登録

CakeEmail::viewVars() レンダリングに用いるパラメータのセット

AbstractTransportクラス

AbstractTransport::config() Transportの設定

AbstractTransport::send() メール送信

ファイルとディレクトリ

Fileクラス

File::append() ファイルにデータを追記

File::close() ファイルクローズ

File::copy() ファイルコピー

File::create() ファイルの新規作成

File::delete() ファイルの削除

File::executable() 実行可能形式かを調べる

File::exists() ファイルが存在するかを調べる

File::ext() ファイル拡張子を入手

File::folder() Folderオブジェクトの入手

File::group() ファイルのグループを入手

File::info() ファイル情報の入手

File::lastAccess() ファイルの最終アクセス時間を入手

File::lastChange() ファイルの最終更新時間を入手

File::md5() md5チェックサムの入手

File::mime() MIME-Typeの入手

File::name() ファイル名の入手

File::open() ファイルオープン

File::offset() ファイルデータのオフセット変更およびオフセット値の入手

File::owner() ファイル所有者の入手

File::perms() パーミッションの入手

File::prepare() 改行コードを整える

File::pwd() ファイルのフルパスを入手

File::read() ファイル内容の読み込み

File::readable() ファイルが読み込み可能かを調べる

File::safe() 安全なファイル名に整形する

File::size() ファイルサイズの入手

File::writable() ファイルが書き込み可能かを調べる

File::write() ファイル内容の書き込み

Folderクラス

Folder::addPathElement() ディレクトリパスの追加

Folder::cd() カレントディレクトリの移動

Folder::chmod() パーミッションの変更

Folder::copy() ディレクトリごとのコピー

Folder::correctSlashFor() パス区切り文字の抽出

Folder::normalizePath()

Folder::create() ディレクトリの作成

Folder::delete() ディレクトリの削除

Folder::dirsize() カレントディレクトリ内の容量を入手

Folder::errors() エラーメッセージの入手

Folder::find() ファイルを探す

Folder::findRecursive() ファイルを再帰的に探す

Folder::inCakePath() CakePHPのアプリケーション・パスであるかを調べる

Folder::inPath() パスがカレントパス配下に存在するか調べる

Folder::isAbsolute() 絶対パスであるかを調べる

Folder::isWindowsPath() Windows形式のパスであるかを調べる

Folder::isSlashTerm() パスの最後がパス区切り文字であるかを調べる

Folder::messages() 処理メッセージの入手

Folder::move() ディレクトリの移動

Folder::pwd() カレントパスの入手

Folder::read() カレントディレクトリの内容を入手

Folder::realpath() 実際のパスに整形

Folder::slashTerm() パスの終端にパス区切り文字を付加

Folder::tree() 指定ディレクトリパスの構造をフルパスで入手

その他のライブラリ

Setクラス

Set::apply() 抽出結果をコールバック処理

Set::check() 指定パスの存在チェック

Set::classicExtract() 古典的な方法で配列から指定キーの値を抽出

Set::combine() 2つ以上のパスから新たな連想配列を生成する

Set::contains() 配列の値が内包されているかを調べる

Set::countDim() 配列の次元数

Set::diff() 配列の差分を抽出する

Set::enum() 指定するキーの値を見つける

Set::expand() 配列の拡張

Set::extract() 配列から指定キーの値を抽出

Set::filter() 空の要素を取り除く

Set::flatten() 連想配列のパスをフラット化する

Set::format() フォーマットに従って値を抽出・生成する

Set::get() 指定パスの値を入手

Set::insert() 指定パスの最後に値を挿入する

Set::map() 配列をオブジェクトにマッピングする

Set::matches() 条件にマッチしているかを調べる

Set::merge() 配列を結合する

Set::nest() 1次元データからツリー構造のデータを生成

Set::normalize() 値を正規化する

Set::numeric() 配列内の全ての値が数字であるかをチェックする

Set::pushDiff() 配列の差分を付加する

Set::remove() 配列から指定パスを削除

Set::reverse() オブジェクトを連想配列に戻す

Set::sort() パスで示した値を対象にソートする

Hashクラス

Hash::apply() 抽出データのコールバック処理

Hash::check() 指定パスの存在チェック

Hash::combine() 2つ以上のパスから新たな連想配列を生成する

Hash::contains() 配列の値が内包されているかを調べる

Hash::diff() 配列の差分を抽出する

Hash::dimensions() 配列の次元数を数える

Hash::expand() 配列の拡張

Hash::extract() 配列から指定キーの値を抽出

Hash::flatten() 連想配列のパスをフラット化する

Hash::filter() コールバック処理を実行

Hash::format() フォーマットに従って値を抽出・生成する

Hash::get() 指定パスの値を入手

Hash::insert() 指定パスの最後に値を挿入する

Hash::map() 配列から値を抽出後コールバックに送る

Hash::maxDimensions() 配列の最も大きな次元数を数える

Hash::merge() 配列を結合する

Hash::mergeDiff() 差分をマージ

Hash::nest() 1次元データからツリー構造のデータを生成

Hash::normalize() 配列を正規化する

Hash::numeric() 配列内の値が全て数値であるか調べる

Hash::reduce() 配列から値を抽出後コールバックに送る

Hash::remove() 配列から指定パスを削除

Hash::sort() パスで示した値を対象にソートする

Inflectorクラス

Inflector::camelize() キャメルケースに変換する

Inflector::classify() クラス名に変換する

Inflector::humanize() 人にわかりやすい形式に変換する

Inflector::pluralize() 複数形に変換

Inflector::reset() キャッシュと変換ルールのリセット

Inflector::rules() 変換ルールの登録

Inflector::singularize() 単数形に変換

Inflector::slug() 特殊文字を除外する

Inflector::tableize() テーブル名に変換する

Inflector::underscore() アンダースコアケースに変換する

Inflector::variable() 変数名に変換する

Sanitizeクラス

Sanitize::clean() 複数のサニタイズを同時に行う

Sanitize::escape() SQLで問題の起きない文字列にエスケープする

Sanitize::html() HTML上で問題のない文字列にサニタイズする

Sanitize::paranoid() 英数字以外を除外する

Sanitize::stripImages() 画像タグの除去

Sanitize::stripAll() ホワイトスペース除去・画像除去・スクリプト除去を同時実行

Sanitize::stripScripts() スクリプトの除去

Sanitize::stripTags() タグの除去

Sanitize::stripWhitespace() ホワイトスペースの除去

Securityクラス

Security::cipher() 文字列を暗号化/復号する

Security::generateAuthKey() 認証キーの生成

Security::hash() 文字列をハッシュ化する

Security::inactiveMins() 無活動時間の入手

Security::rijndael() rijndael形式の暗号化・復号を行う

Security::setCost() Blowfish暗号のコスト値をセット

Security::setHash() ハッシュ化のタイプをセット

Security::validateAuthKey() authKeyのバリデートを行う

CakeNumberクラス

CakeNumber::formatDelta() 差分表示用のフォーマッティング

CakeTimeクラス

CakeTime::isWithinNext() 指定時間と現在時間の差が範囲内かを調べる

CakeTime::listTimezones() タイムゾーン識別子のリストを入手

CakeTime::timezone() タイムゾーンオブジェクトの入手

CakeTime::toServer() サーバ時間に合わせた日時の入手

Stringクラス

String::cleanInsert() テンプレート内から不要な文字列を消去する

String::excerpt() 文字列中にある文を見つけ付近のテキストを入手

String::highlight() 文字の強調

String::insert() テンプレート文字列に文字を挿入する

String::stripLinks() リンクタグの除外

String::tail() 文字列の末尾から指定数の切り取り

String::tokenize() 文字列のトークン化

String::toList() 英語表記の項目をリスト化

String::truncate() 長い文字列を切り詰める

String::uuid() ユニークIDを生成する

String::wrap() 適宜改行を入れる

Xmlクラス

Xml::build() XMLオブジェクトの構築

Xml::fromArray() 配列からXMLオブジェクトの生成

Xml::toArray() XMLオブジェクトを配列に変換

Cakeイベント

イベント駆動の仕組み

Cakeイベントの利用方法

CakeEventManagerクラス

CakeEventManager::attach() イベントのアタッチ

CakeEventManager::detach() イベントのデタッチ

CakeEventManager::dispatch() イベントの実行

CakeEventManager::instance() インスタンスの入手およびセット

CakeEventManager::listeners() イベントリスナーを入手する

CakeEventListenerクラス

CakeEventListener::implementedEvents() イベントの登録

CakeEventクラス

CakeEvent::isStopped() イベントが停止中であるかを調べる

CakeEvent::name() イベント名の入手

CakeEvent::stopPropagation() イベント停止の通知

CakeEvent::subject() イベントの実行元オブジェクトの入手

ディスパッチャ・フィルタ

独自のディスパッチャ・フィルタを作成する

ビルトイン・ディスパッチャ・フィルタ

ディスパッチャ・フィルタクラス

DispatcherFilterクラス

DispatcherFilter::implementedEvents() ディスパッチャ・イベントの登録

DispatcherFilter::beforeDispatch() ディスパッチ処理前のコールバック

DispatcherFilter::afterDispatch() ディスパッチ処理後のコールバック

第10章 CakePHPコンソール編

CakePHPコンソールを起動する

シェルを作成する

タスクを作成する

組み込みのシェルを利用する

Cakeコンソール関連クラス

Shellクラス

Shell::clear() コンソール画面をクリアする

Shell::createFile() ファイルの作成

Shell::dispatchShell() 別のシェルを実行する

Shell::err() エラー出力

Shell::error() エラーメッセージの出力

Shell::getOptionParser() コンソール・オプションパーサーの入手

Shell::hasMethod() クラス内にパブリックメソッドがあるかを調べる

Shell::hasTask() 利用可能なタスクが存在するか調べる

Shell::in() 入力処理

Shell::loadTasks() タスクの読み込み

Shell::runCommand() コマンドの実行

Shell::hr() テキストベースの罫線を出力する

Shell::nl() 指定回数分の改行コードを入手する

Shell::out() 文字列を出力する

Shell::shortPath() ショートパスの生成

Shell::wrapText() 文字列をラップ処理する

Shell::_checkUnitTest() PHPUnitが動作できる状況かを調べる

Shell::_controllerName() コントローラ名を入手

Shell::_controllerPath() コントローラパスの生成

Shell::_displayHelp() ヘルプを表示する

Shell::_getInput() インプットの実行

Shell::_loadModels() モデルの読み込み

Shell::_modelKey() モデルキーの入手

Shell::_modelName() モデル名の入手

Shell::_modelNameFromKey() モデルキーからモデル名を入手

Shell::_singularHumanName() 人の読みやすい単数形の文字列に変換する

Shell::_singularName() 単数形の単語に変換する

Shell::_pluralHumanName() 人の読みやすい複数形の文字列に変換する

Shell::_pluralName() 複数形の単語に変換する

Shell::_pluginPath() プラグイン格納パスの入手

Shell::_welcome() ウェルカム画面の表示

Shell::initialize() 初期化コールバック

Shell::startup() スタートアップコールバック

Shell::main() メイン処理

Shell::execute() コマンド処理

ConsoleOptionParserクラス

ConsoleOptionParser::addArgument() 引数の追加

ConsoleOptionParser::addArguments() 引数をまとめて追加

ConsoleOptionParser::addOption() オプションの追加

ConsoleOptionParser::addOptions() オプションをまとめて追加

ConsoleOptionParser::addSubcommand() サブコマンドの追加

ConsoleOptionParser::addSubcommands() サブコマンドをまとめて追加

ConsoleOptionParser::arguments() 引数の入手

ConsoleOptionParser::buildFromArray() 配列の設定値でインスタンスを構築

ConsoleOptionParser::command() コマンド名の登録および入手

ConsoleOptionParser::create() インスタンスの作成

ConsoleOptionParser::description() 概要文の登録および入手

ConsoleOptionParser::epilog() 末文の登録および入手

ConsoleOptionParser::help() ヘルプ文の入手

ConsoleOptionParser::options() オプション値の入手

ConsoleOptionParser::parse() オプション値のパースを実行

ConsoleOptionParser::subcommands() サブコマンドオブジェクトの入手

ConsoleOutputクラス

ConsoleOutput::styles() スタイルの登録および入手・削除

ConsoleOutput::outputAs() アウトプットタイプの設定および入手

ConsoleOutput::styleText() スタイルを反映した文字列を入手

ConsoleOutput::write() 標準出力へのメッセージ出力

第11章 テスト編

ユニットテストの概要

テストの制作

PHPUnitについて

PHPUnitのインストール

データベースの準備

テストケースクラスの作成

テストケースの生成(モデルの制作が済んでいる場合)

フィクスチャの生成

空のモデルメソッドとテストメソッドを作成

テストメソッドの編集

モデルメソッドの作成とテスト実行

テストスイートの作成

テスト関連クラス

CakeTestCaseクラス

CakeTestCase::assertEqual() 評価値が期待値と同一か調べる

CakeTestCase::assertIdentical() 評価値が期待値と同一であるかを厳密に調べる

CakeTestCase::assertIsA() 指定クラスのインスタンスであるかを調べる

CakeTestCase::assertNoErrors() エラーなしの発行

CakeTestCase::assertNotEqual() 評価値が期待値と同一でないことを調べる

CakeTestCase::assertNotIdentical() 評価値が期待値と同一であるかを厳密に調べる

CakeTestCase::assertNoPattern() 正規表現にマッチしないことを調べる

CakeTestCase::assertPattern() 正規表現にマッチするかを調べる

CakeTestCase::assertReference() 等しいリファレンス値であるかを調べる

CakeTestCase::assertTags() タグが正しく存在しているかチェック

CakeTestCase::assertTextContains() テキストの一部であることを調べる

CakeTestCase::assertTextEquals() テキストが同一であることを調べる

CakeTestCase::assertTextNotContains() テキストの一部でないことを調べる

CakeTestCase::assertTextNotEquals() テキストが同一でないことを調べる

CakeTestCase::assertTextStartsNotWith() テキストの最初の文字列が同じでないことを調べる

CakeTestCase::assertTextStartsWith() テキストの最初の文字列が同じであることを調べる

CakeTestCase::assertTextEndsNotWith() テキストの最後の文字列が同じでないことを調べる

CakeTestCase::assertTextEndsWith() テキストの最後の文字列が同じであることを調べる

CakeTestCase::assertWithinMargin() 値が範囲内であるかを調べる

CakeTestCase::date() テスト開始時間の入手

CakeTestCase::expectError() エラー発生のチェック

CakeTestCase::expectException() 例外発生のチェック

CakeTestCase::getMockForModel() モデルのモックオブジェクトを入手

CakeTestCase::loadFixtures() フィクスチャの読み込み

CakeTestCase::skipIf() テストのスキップ

CakeTestCase::skipUnless() テストのスキップ

CakeTestCase::_array_permute() 総当たりでアイテムの順序を入れ替えて配列を生成

CakeTestCase::_arrayPermute()

CakeTestCase::run() テストメソッドの実行

CakeTestCase::setUp() セットアップの実行

CakeTestCase::assertPreConditions() テストメソッド実行前のコールバック

CakeTestCase::startTest() テストメソッド実行前のコールバック

CakeTestCase::assertPostConditions() テストケースの終了後のコールバック

CakeTestCase::endTest() テストケースの終了後のコールバック

CakeTestCase::tearDown() テストの後始末を実行

CakeTestSuiteクラス

CakeTestSuite::addTestDirectory() ディレクトリ内のテストファイルを全て登録

CakeTestSuite::addTestDirectoryRecursive() ディレクトリ内のテストファイルを再帰的に全て登録

CakeTestFixtureクラス

CakeTestFixture::create() データベース内のテーブル生成

CakeTestFixture::drop() データベース内のテーブル破棄

CakeTestFixture::init() フィクスチャの準備

CakeTestFixture::insert() フィクスチャデータのインサート

CakeTestFixture::truncate() フィクスチャデータを空にする

第12章 プラグイン編

プラグインを作成する

プラグインディレクトリを作る

プラグイン用AppControllerとAppModelの作成

モデル・コントローラ・ビューの作成

プラグインを利用する

プラグイン内の「アセット」を使う

CakePluginクラス

CakePlugin::bootstrap() プラグイン内のbootstrapを読み込み

CakePlugin::load() プラグインの登録

CakePlugin::loadAll() プラグインの一括登録

CakePlugin::loaded() プラグインがロード済みか調べる

CakePlugin::path() プラグインの格納パスを調べる

CakePlugin::routes() プラグイン内のルーティング設定を登録

CakePlugin::unload() プラグインの解除

Appendix

CakePHPの定数

CakePHPの例外

CakePHPの処理の流れ

リクエスト受付から処理終了までの流れ

モデル処理の流れ

CakePHPに関する情報の入手

公式サイト

フォーラム・アンテナサイト

Twitter

PR

秀和システム