データを取得する

まず説明を始める前に、モデルの役割についてですが、モデルの役割の一つはいろいろなタイプのストレージからデータを取得することです。CakePHP のモデルクラスは、データの検索、ソート、ページング、フィルターなどの機能を提供しています。モデルで一番良く使われる関数は Model::find() です。

find

find(string $type = 'first', array $params = [])

find はデータ取得のための、非常に多機能でとても良く働いてくれる関数です。 $type は 'all', 'first', 'count', 'list', 'neighbors', 'threaded', または自分で定義したカスタム finder を指定できます。 $type は大文字と小文字を区別しますので、注意してください。大文字が含まれると (例えば All のように) 期待した結果になりません。

$params はいろいろな種類の find() へのパラメータを渡すために使われます。デフォルトでは以下のキーのパラメータを渡すことができます。これらキーの指定は任意です。

[
    'conditions' => ['Model.field' => $thisValue], // 検索条件の配列
    'recursive' => 1, // int
    // フィールド名の配列
    'fields' => ['Model.field1', 'DISTINCT Model.field2'],
    // 並び順を文字列または配列で指定
    'order' => ['Model.created', 'Model.field3 DESC'],
    'group' => ['Model.field'], // GROUP BYのフィールド
    'limit' => n, // int
    'page' => n, // int
    'offset' => n, // int
    'callbacks' => true, // falseの他に'before'、'after'を指定できます
    'having' => ['COUNT(Model.field) >' => 1], // HAVING 条件の配列
    'lock' => true, // FOR UPDATE ロックを有効にします
]

これ以外のパラメータを追加したり使用することが可能です。いくつかの find() のタイプとビヘイビアは、この機能を使用します。そして、あなた自身のモデルのメソッドでも可能です。

もし、find() 操作がレコードの照合に失敗した場合、空の配列を返します。

Added in version 2.10.0

having と lock オプションが追加されました。

並び順

order オプションには文字列または配列を指定します。Model::$order、$paginate の order キー、アソシエーションの order 設定も同じ形式です。各項目はフィールド (または SQL 式) と、省略可能なソート方向からなります。

// フィールド => ソート方向 の組
$this->Article->find('all', [
    'order' => ['Article.created' => 'DESC', 'Article.title' => 'asc'],
]);

// 同じ指定を文字列で書く場合
$this->Article->find('all', [
    'order' => 'Article.created DESC, Article.title ASC',
]);

// NULL を最後に並べる (PostgreSQL、SQLite 3.30 以降)
$this->Article->find('all', [
    'order' => ['Article.published' => 'DESC NULLS LAST'],
]);

// 式はキーに、ソート方向は値に書きます
$this->Article->find('all', [
    'order' => ["Article.status = 'draft'" => 'DESC'],
]);

ソート方向は ASC または DESC で、その後に NULLS FIRST または NULLS LAST を続けることもできます。大文字と小文字は区別せず、余分な空白は無視されるので、 'asc'、' Desc '、'desc nulls last' はいずれも有効です。

Piece of Cake 2 fork

v2.12.5 からソート方向を検証します。不正なソート方向を指定すると E_USER_DEPRECATED エラーが発生し、SQL はこれまでどおり生成されます。将来のバージョンでは代わりに例外を投げる予定です。

不正なソート方向の多くは、式の一部をソート方向の側に書いているものです。式はキーに移すか、生の SQL をそのままキーとして指定してください。

// 変更前: 非推奨エラーが発生します
$this->Article->find('all', [
    'order' => ['Article.status' => "= 'draft' DESC"],
]);

// 変更後
$this->Article->find('all', [
    'order' => ["Article.status = 'draft'" => 'DESC'],
]);

'Article.title DESC LIMIT 1' のように、文字列の order で ASC や DESC の後に別の SQL が続く場合も同様です。フィールドの後にはソート方向 (と NULLS FIRST / NULLS LAST) だけを書いてください。

order のフィールド部分は SQL として使われます。可能な場合はクォートされますがエスケープはされないので、リクエストデータを含めてはいけません。ソート方向にもリクエストデータをそのまま渡さないでください。ユーザーが並び順を選べるようにする場合は、入力をフィールドとソート方向のホワイトリストに対応付けます。

// src/Controller/ArticlesController.php
public function index()
{
    $sortable = [
        'title' => 'Article.title',
        'created' => 'Article.created',
    ];
    $sort = (string)$this->request->query('sort');
    $field = $sortable[$sort] ?? 'Article.created';
    $direction = strtolower((string)$this->request->query('direction'));
    $direction = $direction === 'asc' ? 'ASC' : 'DESC';

    $articles = $this->Article->find('all', [
        'order' => [$field => $direction],
    ]);
    $this->set(compact('articles'));
}

ページネーションでは PaginatorComponent がすでにこれを行っています。ソート方向は asc と desc だけを受け付け、フィールドはモデルのフィールドかソートのホワイトリストにあるものだけを受け付けます。

find('first')

find('first', $params) は結果を1行返します。1行だけ取得したい時に使います。以下の例を見てください。

public function some_function()
{
    // ...
    $semiRandomArticle = $this->Article->find('first');
    $lastCreated = $this->Article->find('first', [
        'order' => ['Article.created' => 'desc'],
    ]);
    $specificallyThisOne = $this->Article->find('first', [
        'conditions' => ['Article.id' => 1],
    ]);
    // ...
}

1行目のサンプルは、パラメータを渡していません。すなわち、検索条件の指定もソートの指定もされないということです。 find('first') の戻り値はこのような形式になっています。


[
    [ModelName] => 
        [
            [id] => 83
            [field1] => value1
            [field2] => value2
            [field3] => value3
        ]

    [AssociatedModelName] => 
        [
            [id] => 1
            [field1] => value1
            [field2] => value2
            [field3] => value3
        ]
]

find('count')

find('count', $params) は整数を返します。以下のサンプルを見てください。

public function some_function()
{
    // ...
    $total = $this->Article->find('count');
    $pending = $this->Article->find('count', [
        'conditions' => ['Article.status' => 'pending'],
    ]);
    $authors = $this->Article->User->find('count');
    $publishedAuthors = $this->Article->find('count', [
       'fields' => 'DISTINCT Article.user_id',
       'conditions' => ['Article.status !=' => 'pending'],
    ]);
    // ...
}

NOTE

find('count') には fields キーを配列で渡さないでください。 DISTINCT count に渡されるフィールドだけを指定します。 (それ以外は、conditions で指定された値を元に、常に同じ結果になります。)

find('all')

find('all', $params) は配列で結果を返します。 find('all') は、他のいろいろな find() や、 paginate でも使われています。以下のサンプルを見てください。

public function some_function()
{
    // ...
    $allArticles = $this->Article->find('all');
    $pending = $this->Article->find('all', [
        'conditions' => ['Article.status' => 'pending'],
    ]);
    $allAuthors = $this->Article->User->find('all');
    $allPublishedAuthors = $this->Article->User->find('all', [
        'conditions' => ['Article.status !=' => 'pending'],
    ]);
    // ...
}

NOTE

上記サンプルの $allAuthors は、users テーブルの全ユーザーデータを受け取ります。 find に何もオプションパラメータを渡していないので、検索条件が適用されません。

find('all') を呼び出すと、その戻り値は以下のような形式となります。


[
    [0] => 
        [
            [ModelName] => 
                [
                    [id] => 83
                    [field1] => value1
                    [field2] => value2
                    [field3] => value3
                ]

            [AssociatedModelName] => 
                [
                    [id] => 1
                    [field1] => value1
                    [field2] => value2
                    [field3] => value3
                ]

        ]
]

find('list')

find('list', $params) はインデックス付きの配列を返します。よくあるフォームのセレクトボックスを作るために、リストが欲しい場合などに使うと便利です。以下のサンプルを見てください。

public function some_function()
{
    // ...
    $allArticles = $this->Article->find('list');
    $pending = $this->Article->find('list', [
        'conditions' => ['Article.status' => 'pending'],
    ]);
    $allAuthors = $this->Article->User->find('list');
    $allPublishedAuthors = $this->Article->find('list', [
        'fields' => ['User.id', 'User.name'],
        'conditions' => ['Article.status !=' => 'pending'],
        'recursive' => 0,
    ]);
    // ...
}

NOTE

find('list') を呼び出すと、その戻り値は以下のような形式となります。


[
    //[id] => 'displayValue',
    [1] => 'displayValue1',
    [2] => 'displayValue2',
    [4] => 'displayValue4',
    [5] => 'displayValue5',
    [6] => 'displayValue6',
    [3] => 'displayValue3',
]

fields キーを渡して find('list') 呼び出せば、どのフィールドを検索結果の配列の添字として使うのかを指定でき、必要に応じて結果をグループ化してくれます。デフォルトではモデルのプライマリーキーが検索結果の配列の添字として使われます。また、添字に対する値は value が使われます。(値については、モデルの属性 Model Displayfield で設定できます) 以下に例を示します。

public function some_function()
{
    // ...
    $justusernames = $this->Article->User->find('list', [
        'fields' => ['User.username'],
    ]);
    $usernameMap = $this->Article->User->find('list', [
        'fields' => ['User.username', 'User.first_name'],
    ]);
    $usernameGroups = $this->Article->User->find('list', [
        'fields' => ['User.username', 'User.first_name', 'User.group'],
    ]);
    // ...
}

上記サンプルを実行した結果、それぞれの変数の中身は次のようになっています。

$justusernames = 
[
    //[id] => 'username',
    [213] => 'AD7six',
    [25] => '_psychic_',
    [1] => 'PHPNut',
    [2] => 'gwoo',
    [400] => 'jperras',
]

$usernameMap = 
[
    //[username] => 'firstname',
    ['AD7six'] => 'Andy',
    ['_psychic_'] => 'John',
    ['PHPNut'] => 'Larry',
    ['gwoo'] => 'Gwoo',
    ['jperras'] => 'Joël',
]

$usernameGroups = 
[
    ['User'] => 
    [
        ['PHPNut'] => 'Larry',
        ['gwoo'] => 'Gwoo',
    ]

    ['Admin'] => 
    [
        ['_psychic_'] => 'John',
        ['AD7six'] => 'Andy',
        ['jperras'] => 'Joël',
    ]

]

find('threaded')

find('threaded', $params) は入れ子になった配列を返します。入れ子の構造を表現するために、 parent_id フィールドがある場合に使います。以下のサンプルを見てください。

public function some_function()
{
    // ...
    $allCategories = $this->Category->find('threaded');
    $someCategories = $this->Comment->find('threaded', [
        'conditions' => ['article_id' => 50],
    ]);
    // ...
}

TIP

入れ子のデータを扱うための、もっと良い方法として Tree ビヘイビアがあります。

上記サンプルでは、 $allCategories は全体のカテゴリ構造を表す、入れ子になった配列が格納されています。 find('threaded') を呼び出すと、戻り値は次のような形式となります。


[
    [0] => 
    [
        [ModelName] => 
        [
            [id] => 83
            [parent_id] => null
            [field1] => value1
            [field2] => value2
            [field3] => value3
        ]

        [AssociatedModelName] => 
        [
            [id] => 1
            [field1] => value1
            [field2] => value2
            [field3] => value3
        ]

        [children] => 
        [
            [0] => 
            [
                [ModelName] => 
                [
                    [id] => 42
                    [parent_id] => 83
                    [field1] => value1
                    [field2] => value2
                    [field3] => value3
                ]

                [AssociatedModelName] => 
                [
                    [id] => 2
                    [field1] => value1
                    [field2] => value2
                    [field3] => value3
                ]

                [children] => 
                [
                ]
            ]
            ...
        ]
    ]
]

結果の表示順は、並べ替えることができます。たとえば、 'order' => 'name ASC' が find('threaded') に渡された場合、結果は名前順になります。他のフィールドを指定しても同様です。

WARNING

fields を指定する場合、必ず id と parent_id (もしくは、そのエイリアス) が含まれる必要があります:

public function some_function()
{
    $categories = $this->Category->find('threaded', [
        'fields' => ['id', 'name', 'parent_id'],
    ]);
}

そうしなければ、配列の戻り値は期待通りの入れ子構造にはなりません。

find('neighbors')

find('neighbors', $params) は find の 'first' と似たような動きをします。ただ、それに加えて指定した条件の前後の行も一緒に取得してきます。以下の例を見てください。

public function some_function()
{
    $neighbors = $this->Article->find(
        'neighbors',
        ['field' => 'id', 'value' => 3],
    );
}

このサンプルでは、 $params 配列に field と value の2つの要素を指定しているのがわかります。その他のキーについても、今まで見てきた他のfindと同じように指定できます。 (たとえばモデルが Containable ビヘイビアを利用していれば、 $params に 'contain' を指定できます。) find('neighbors') を呼び出すと、戻り値は以下の様な形式となります。


[
    [prev] => 
    [
        [ModelName] => 
        [
            [id] => 2
            [field1] => value1
            [field2] => value2
            ...
        ]
        [AssociatedModelName] => 
        [
            [id] => 151
            [field1] => value1
            [field2] => value2
            ...
        ]
    ]
    [next] => 
    [
        [ModelName] => 
        [
            [id] => 4
            [field1] => value1
            [field2] => value2
            ...
        ]
        [AssociatedModelName] => 
        [
            [id] => 122
            [field1] => value1
            [field2] => value2
            ...
        ]
    ]
]

NOTE

結果には、常に2つのルート要素 (prev と next) が含まれることになります。この関数はモデルのデフォルトの recursive 値を無視します。 recursive を指定するには関数の各呼び出しにパラメータとして渡さなければなりません。

カスタム find を定義する

find メソッドはカスタム finder を定義することができます。モデルの変数に find 種別を宣言して、モデルのクラスとしてその関数を実装することで実現されます。

モデルの find 種別は、find 操作へのショートカットとなります。例えば、以下の2つのコードは同じ意味です。

$this->User->find('first');
$this->User->find('all', ['limit' => 1]);

コアに含まれる find 種別は以下のものがあります。

first
all
count
list
threaded
neighbors

では、その他の種別はどうでしょうか？データベースの中にある、公開された記事を全て取得する find を作ってみましょう。まず最初にやることは、モデルの Model::$findMethods 変数に find 種別を追加することです。

class Article extends AppModel
{
    public $findMethods = ['available' => true];
}

これは、 find 関数の最初の引数として available を渡せるように CakePHP に教えています。次に _findAvailable 関数を実装します。規約に従って、 myFancySearch という finder を実装したければ、その関数の名前は _findMyFancySearch となります。

class Article extends AppModel
{
    public $findMethods = ['available' => true];

    protected function _findAvailable($state, $query, $results = [])
    {
        if ($state == 'before') {
            $query['conditions']['Article.published'] = true;

            return $query;
        }

        return $results;
    }
}

次のようにして使えます。

class ArticlesController extends AppController
{
    /**
     * 公開されているすべての記事を検索して、createdカラムの順番に並び替える
     */
    public function index()
    {
        $articles = $this->Article->find('available', [
            'order' => ['created' => 'desc'],
        ]);
    }
}

_find[Type] メソッドは上記の例で示したように3つの引数を受け取ります。 1つめはクエリの実行状態を表します。 before または after となります。このメソッドは、クエリが実行される前にそのクエリを修正する、または結果を取得した後にその結果を修正する、といったコールバック関数の一種です。

カスタム find メソッドでまずはじめにチェックすることは、クエリの状態です。 before はクエリを修正、新しいアソシエーションの追加、振る舞いの追加、または find の2つめの引数に渡されるキーの追加、などを行うための状態です。この before の状態の時、関数は $query を返す必要があります (クエリを修正していても、していなくても)。

after はクエリの結果を調べるために良く使われます。たとえば結果に対して新しい行を挿入したり、他のフォーマットに整形して返すための処理をしたり、他にも、取得したデータに対してどんな処理でもすることができます。この after の状態の時、関数は $results 配列を返す必要があります (結果を修正していても、していなくても)。

自分が好きなようにカスタム finder をいくつも作ることができますし、これはアプリケーションのモデル全体で再利用可能なコードとなるので、とても良いことです。

以下のようにして、カスタム find でページネーションをすることも出来ます。

class ArticlesController extends AppController
{
    /**
     * Will paginate all published articles
     */
    public function index()
    {
        $this->paginate = ['findType' => 'available'];
        $articles = $this->paginate();
        $this->set(compact('articles'));
    }
}

上記のように $this->paginate 変数にカスタム find をセットすることで、その結果が available の find 結果になります。

ページネーションのページ数がおかしい時は、次のようなコードを AppModel に追加すると正しいページ数が取得できるでしょう。

class AppModel extends Model
{
    /**
     * Removes 'fields' key from count query on custom finds when it is an array,
     * as it will completely break the Model::_findCount() call
     *
     * @param string $state Either "before" or "after"
     * @param array $query
     * @param array $results
     * @return int The number of records found, or false
     * @access protected
     * @see Model::find()
     */
    protected function _findCount($state, $query, $results = [])
    {
        if ($state === 'before') {
            if (
                isset($query['type']) &&
                isset($this->findMethods[$query['type']])
            ) {
                $query = $this->{
                    '_find' . ucfirst($query['type'])
                }('before', $query);
                if (!empty($query['fields']) && is_array($query['fields'])) {
                    if (!preg_match('/^count/i', current($query['fields']))) {
                        unset($query['fields']);
                    }
                }
            }
        }

        return parent::_findCount($state, $query, $results);
    }
}

Changed in version 2.2

クエリのカウント数を正しく取得するために、_findCount のオーバーライドはしなくてよくなりました。カスタム finder の 'before' では、$query['operation'] = 'count' という値がセットされてもう一度関数が呼び出され、関数から返された $query は _findCount() で使われます。必要であれば 'operation' キーをチェックして、関数から返された $query が違うかどうかを区別できます。

protected function _findAvailable($state, $query, $results = [])
{
    if ($state == 'before') {
        $query['conditions']['Article.published'] = true;
        if (!empty($query['operation']) && $query['operation'] == 'count') {
            return $query;
        }
        $query['joins'] = [
            //array of required joins
        ];

        return $query;
    }

    return $results;
}

マジックメソッド

マジックメソッドはテーブルの特定のフィールドを検索するためのショートカットとして使われます。これから紹介するマジックメソッドの最後にフィールド名をキャメルケースにしたものをくっつけて、最初の引数にそのフィールドの基準となる値を指定して使います。

findAllBy() の戻り値の形式は find('all') と似ていますし、 findBy() の戻り値の形式は find('first') と同じです。

findAllBy

findAllBy<fieldName>(string $value, array $fields, array $order, int $limit, int $page, int $recursive)

findAllBy<x> サンプル	対応するSQL
`$this->Product->findAllByOrderStatus('3');`	`Product.order_status = 3`
`$this->Recipe->findAllByType('Cookie');`	`Recipe.type = 'Cookie'`
`$this->User->findAllByLastName('Anderson');`	`User.last_name = 'Anderson'`
`$this->Cake->findAllById(7);`	`Cake.id = 7`
`$this->User->findAllByEmailOrUsername('jhon');`	`User.email = 'jhon' OR User.username = 'jhon';`
`$this->User->findAllByUsernameAndPassword('jhon', '123');`	`User.username = 'jhon' AND User.password = '123';`
`$this->User->findAllByLastName('psychic', [], array('User.user_name => 'asc'));`	`User.last_name = 'psychic' ORDER BY User.user_name ASC`

この関数の戻り値は find('all') の戻り値と同じ形式です。

カスタムマジック Finder

2.8 では、マジックメソッドインターフェースで任意のカスタム finder メソッドを使用できます。例えば、モデルに published finder を実装した場合、これらの finder はマジック findBy メソッドと共に利用できます。

$results = $this->Article->findPublishedByAuthorId(5);

// 以下と同等です
$this->Article->find('published', [
    'conditions' => ['Article.author_id' => 5],
]);

Added in version 2.8.0

カスタムマジック finder が 2.8.0 で追加されました。

findBy

findBy<fieldName>(string $value);

findBy マジックメソッドも同じようにいくつかオプションのパラメータを受け取ります。

findBy<fieldName>(string $value[, mixed $fields[, mixed $order]]);

findBy<x> サンプル	対応するSQL
`$this->Product->findByOrderStatus('3');`	`Product.order_status = 3`
`$this->Recipe->findByType('Cookie');`	`Recipe.type = 'Cookie'`
`$this->User->findByLastName('Anderson');`	`User.last_name = 'Anderson';`
`$this->User->findByEmailOrUsername('jhon');`	`User.email = 'jhon' OR User.username = 'jhon';`
`$this->User->findByUsernameAndPassword('jhon', '123');`	`User.username = 'jhon' AND User.password = '123';`
`$this->Cake->findById(7);`	`Cake.id = 7`

findBy() の戻り値は find('first') と同じです。

`Model::query()`

query(string $query)

モデルのメソッドを使っては実行できない SQL (こういった SQL は稀ですが) などは、モデルの query() メソッドを使うことができます。

このメソッドを使う場合は、データのサニタイズを確認してください。ユーザーからの入力に対して、XSS や SQL インジェクションの対策が書かれています。

NOTE

query() は本質的に分離された機能のため、$Model->cacheQueries は無視されます。クエリ実行のキャッシュしないようにするには、2つ目の引数に false を指定してください。 query($query, $cachequeries = false)

query() はクエリ中のテーブル名を戻り値の配列のキーとして使います。

$this->Picture->query('SELECT * FROM pictures LIMIT 2;');

これは、以下の様な配列を返します。


[
    [0] => 
    [
        [pictures] => 
        [
            [id] => 1304
            [user_id] => 759
        ]
    ]

    [1] => 
    [
        [pictures] => 
        [
            [id] => 1305
            [user_id] => 759
        ]
    ]
]

find メソッドと同じように、戻り値の配列のキーにモデル名を使うためには、次のようにクエリを書き換えます。

$this->Picture->query('SELECT * FROM pictures AS Picture LIMIT 2;');

すると以下の様な配列となります。


[
    [0] => 
    [
        [Picture] => 
        [
            [id] => 1304
            [user_id] => 759
        ]
    ]

    [1] => 
    [
        [Picture] => 
        [
            [id] => 1305
            [user_id] => 759
        ]
    ]
]

NOTE

この SQL 構文とそれに対応する配列の構造は、MySQL のみで有効です。 CakePHP は手動でクエリを実行した時のデータ抽象化の機能を提供していません。そのため、正確な結果はデータベース毎に違います。

`Model::field()`

field(string $name, array $conditions = null, string $order = null)

$conditions で指定された条件で検索して、 $order で並び替えられた結果の一番最初の行について、 $name で指定したフィールドの値を返します。検索条件を渡さずにモデルに ID がセットされていれば、その ID の結果に対するフィールドの値を返します。マッチする行がなければ false を返します。

$this->Post->id = 22;
echo $this->Post->field('name'); // ID が 22 の行の name フィールドを表示します

// 最新日付のデータの name フィールドを表示します
echo $this->Post->field(
    'name',
    ['created <' => date('Y-m-d H:i:s')],
    'created DESC',
);

`Model::read()`

read($fields, $id)

read() はモデルにデータをセットするのに使われますが、場合によっては、データベースから単一データを取得するのにも使われます。

$fields は取得する対象のフィールドを文字列で1つ渡すか、もしくは配列で複数渡します。特に指定しなければ、全てのフィールドが取得されます。

$id は取得するデータのIDを指定します。デフォルトでは Model::$id に指定される値が使われます。 $id に別の値を渡すと、そのレコードが取得されることになります。

read() は、たとえ単一のフィールドを取得する場合でも、常に配列を返します。単一の値を取得するには field を使ってください。

WARNING

read はモデルに保持されている data と id の値を上書きするので、このメソッドを使う時は気をつけてください。特に beforeValidate や beforeSave などのモデルのコールバック関数で使う場合などは注意が必要です。一般的に find の方が read よりも簡単でより安全にデータを取得することができます。

複雑な検索条件

ほとんどのモデルの find の呼び出しは、検索条件をセットして呼び出されることでしょう。一般的に CakePHP は、SQL の WHERE 句にセットされる検索条件を配列で表現するようになっています。

配列を使うことで可読性があがり、綺麗なコードになります。また、クエリの組み立ても簡単になります。配列を使うことで、クエリの要素 (フィールドや値、演算子) などをクエリ中から取り出すことができますので、CakePHP は可能な限り効率的で、適切な構文でクエリを生成することができ、変数のエスケープもしてくれて、SQL インジェクションなどの対策にもなります。

WARNING

CakePHP は、配列の値部分のみエスケープします。**決して** キーにユーザーデータをセットしないでください。SQL インジェクションの脆弱性になります。

最も良く使われるのは、次のような配列ベースのクエリです。

$conditions = ['Post.title' => 'This is a post', 'Post.author_id' => 1];
// モデルの使い方のサンプル
$this->Post->find('first', ['conditions' => $conditions]);

この書き方は非常にわかりやすいと思います。これは、タイトルが "This is a post" という投稿を取得します。フィールド名については単に "title" とすることもできますが、モデル名も指定するように習慣付けましょう。そうすることで、コードが明確になり、将来もしスキーマの変更があったとしても他テーブルとのフィールド名の衝突を避けられます。

否定や比較などはどうするのでしょうか？とてもシンプルです。 "This is a post" 以外の投稿データを取得したい場合は以下のようにします。

["Post.title !=" => "This is a post"]

フィールド名の前に '!=' があるのがわかると思います。演算子とフィールド名の間にスペース名をいれていれば、 LIKE や BETWEEN 、REGEX 、それに他の有効な SQL の比較演算子を CakePHP が解析してくれます。ただ、例外として IN (...) の場合は違います。 IN を使って、リストから投稿タイトルを検索したい場合は以下のようにします。

[
    "Post.title" => ["First post", "Second post", "Third post"]
]

NOT IN (...) でリストに含まれない投稿タイトルを検索した場合は以下のようにします。

[
    "NOT" => [
        "Post.title" => ["First post", "Second post", "Third post"]
    ]
]

検索条件に新しい条件を追加したければ、キーと値のペアを配列に追加するだけです。

 [
    "Post.title" => ["First post", "Second post", "Third post"],
    "Post.created >" => date('Y-m-d', strtotime("-2 weeks"))
]

データベースの2つのフィールドを比較する条件を指定することもできます。

["Post.created = Post.modified"]

上記サンプルは、作成日と変更日が同じ投稿データ (つまりまだ編集されていない投稿)を返します。

この方法で WHERE 句に指定できないようなものは、文字列で以下のようにして指定できます。

[
    'Model.field & 8 = 1',
    // キーと値のペアでは指定できないような条件
]

デフォルトでは、CakePHP は AND で複数の条件をつなげます。つまりこれは、3つ上のサンプルコードでは、過去2週間の内に作られた投稿で、かつ指定されたリストに含まれるタイトルの投稿だけが取得されます。ただ、どちらかの条件にマッチする投稿を取得したいこともあるでしょう。

["OR" => [
    "Post.title" => ["First post", "Second post", "Third post"],
    "Post.created >" => date('Y-m-d', strtotime("-2 weeks"))
]]

CakePHP は AND 、 OR 、 NOT 、 XOR (大文字、小文字は区別しません)などの、有効な SQL の論理演算子は全て受け取れます。これらの条件は際限なく入れ子にできます。さて、今ここで Posts と Authors で belongsTo アソシエーションを定義しているとしましょう。この時、特定のキーワード "magic" を含むか、もしくは過去2週間の間に投稿されて、かつ Bob が書いた投稿、に制限して取得したい場合、次のようにします。

[
    "Author.name" => "Bob",
    "OR" => [
        "Post.title LIKE" => "%magic%",
        "Post.created >" => date('Y-m-d', strtotime("-2 weeks"))
    ]
]

同じフィールドに対して複数の LIKE 条件を指定したい場合は、同じように以下のように条件を指定します。

['OR' => [
    ['Post.title LIKE' => '%one%'],
    ['Post.title LIKE' => '%two%']
]]

ワイルドカード演算子 ILIKE と RLIKE (RLIKE は 2.6 以降) も利用可能です。

CakePHP は null も受け入れることができます。次のクエリは、投稿のタイトルが NOT NULL である投稿を返します。

["NOT" => [
        "Post.title" => null
    ]
]

BETWEEN は、以下のように出来ます。

['Post.read_count BETWEEN ? AND ?' => [1,10]]

NOTE

CakePHP はデータベースのフィールドの型によって、数値でもクォートで囲みます。

GROUP BY は？

[
    'fields' => [
        'Product.type',
        'MIN(Product.price) as price'
    ],
    'group' => 'Product.type'
]

この時の戻り値の配列は、次のような形式です。

Array
(
    [0] => 
    [
        [Product] => 
        [
            [type] => Clothing
        ]
        [0] => 
        [
            [price] => 32
        ]
    ]
    [1] => Array
    ...

以下は DISTINCT のサンプルです。他にも MIN() や MAX() なども同じように使えます。

[
    'fields' => ['DISTINCT (User.name) AS my_column_name'],
    'order' = >['User.id DESC']
]

とても複雑な検索条件も、複数の配列をネストすることで実現可能です。

[
    'OR' => [
        ['Company.name' => 'Future Holdings'],
        ['Company.city' => 'CA']
    ],
    'AND' => [
        [
            'OR' => [
                ['Company.status' => 'active'],
                'NOT' => [
                    ['Company.status' => ['inactive', 'suspended']]
                ]
            ]
        ]
    ]
]

上記サンプルは次のような SQL を生成します。

SELECT `Company`.`id`, `Company`.`name`,
`Company`.`description`, `Company`.`location`,
`Company`.`created`, `Company`.`status`, `Company`.`size`

FROM
   `companies` AS `Company`
WHERE
   ((`Company`.`name` = 'Future Holdings')
   OR
   (`Company`.`city` = 'CA'))
AND
   ((`Company`.`status` = 'active')
   OR (NOT (`Company`.`status` IN ('inactive', 'suspended'))))

サブクエリ

"id"、"name"、"status"というフィールドを持つ "users" テーブルがあって、 "status" は "A"、"B"、"C" のいずれかの値を取るものとします。ここで、サブクエリを使って、status が "B" 以外のユーザーを取得してみます。

そのためにはまず、モデルのデータソースを取得して、クエリを組み立てます。 find メソッドを呼ぶような感じですが、これは SQL 文字列を返します。その後、expression を呼び出し、その戻り値を conditions 配列に追加します。

$conditionsSubQuery['User2.status'] = 'B';

$db = $this->User->getDataSource();
$subQuery = $db->buildStatement(
    [
        'fields' => ['User2.id'],
        'table' => $db->fullTableName($this->User),
        'alias' => 'User2',
        'limit' => null,
        'offset' => null,
        'joins' => [],
        'conditions' => $conditionsSubQuery,
        'order' => null,
        'group' => null,
    ],
    $this->User,
);
$subQuery = 'User.id NOT IN (' . $subQuery . ') ';
$subQueryExpression = $db->expression($subQuery);

$conditions[] = $subQueryExpression;

$this->User->find('all', compact('conditions'));

このサンプルは以下のような SQL を生成します。

SELECT
    User.id AS "User__id",
    User.name AS "User__name",
    User.status AS "User__status"
FROM
    users AS User
WHERE
    User.id NOT IN (
        SELECT
            User2.id
        FROM
            users AS User2
        WHERE
            "User2.status" = 'B'
    )

また、クエリの一部 (実際の生の SQL) で渡す必要がある場合も、データソースの expressions を使えば、他の find クエリでも同じようにできます。

準備済みステートメント

よりクエリをコントロールするために、準備済みステートメントを使うことができます。これでデータベースドライバと直接やり取りができ、好きなようにクエリを送信することができます。

$db = $this->getDataSource();
$db->fetchAll(
    'SELECT * from users where username = ? AND password = ?',
    ['jhon', '12345'],
);
$db->fetchAll(
    'SELECT * from users where username = :username AND password = :password',
    ['username' => 'jhon','password' => '12345'],
);

データを取得する ​

find ​

並び順 ​

find('first') ​

find('count') ​

find('all') ​

find('list') ​

find('threaded') ​

find('neighbors') ​

カスタム find を定義する ​

マジックメソッド ​

findAllBy ​

カスタムマジック Finder ​

findBy ​

Model::query() ​

Model::field() ​

Model::read() ​

複雑な検索条件 ​

サブクエリ ​

準備済みステートメント ​

データを取得する

find

並び順

find('first')

find('count')

find('all')

find('list')

find('threaded')

find('neighbors')

カスタム find を定義する

マジックメソッド

findAllBy

カスタムマジック Finder

findBy

`Model::query()`

`Model::field()`

`Model::read()`

複雑な検索条件

サブクエリ

準備済みステートメント