Skip to content

Commit

Permalink
typos and format fixes for API
Browse files Browse the repository at this point in the history
  • Loading branch information
antograssiot committed Aug 1, 2014
1 parent b7e6cc4 commit 2412e53
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 19 deletions.
35 changes: 17 additions & 18 deletions src/ORM/Query.php
Expand Up @@ -262,7 +262,7 @@ public function contain($associations = null, $override = false) {
* Adds filtering conditions to this query to only bring rows that have a relation
* to another from an associated table, based on conditions in the associated table.
*
* This function will add entries in the ``contain`` graph.
* This function will add entries in the `contain` graph.
*
* ### Example:
*
Expand All @@ -284,8 +284,8 @@ public function contain($associations = null, $override = false) {
* );
* }}}
*
* As this function will create ``INNER JOIN``, you might want to consider
* calling ``distinct`` on this query as you might get duplicate rows if
* As this function will create `INNER JOIN`, you might want to consider
* calling `distinct` on this query as you might get duplicate rows if
* your conditions don't filter them already. This might be the case, for example,
* of the same user commenting more than once in the same article.
*
Expand All @@ -300,7 +300,7 @@ public function contain($associations = null, $override = false) {
* }}}
*
* Please note that the query passed to the closure will only accept calling
* ``select``, ``where``, ``andWhere`` and ``orWhere`` on it. If you wish to
* `select`, `where`, `andWhere` and `orWhere` on it. If you wish to
* add more complex clauses you can do it directly in the main query.
*
* @param string $assoc The association to filter by
Expand Down Expand Up @@ -395,7 +395,18 @@ public function aliasFields($fields, $defaultAlias = null) {

/**
* Populates or adds parts to current query clauses using an array.
* This is handy for passing all query clauses at once.
* This is handy for passing all query clauses at once. The option array accepts:
*
* - fields: Maps to the select method
* - conditions: Maps to the where method
* - limit: Maps to the limit method
* - order: Maps to the order method
* - offset: Maps to the offset method
* - group: Maps to the group method
* - having: Maps to the having method
* - contain: Maps to the contain options for eager loading
* - join: Maps to the join method
* - page: Maps to the page method
*
* ## Example:
*
Expand All @@ -418,19 +429,7 @@ public function aliasFields($fields, $defaultAlias = null) {
* ->limit(10)
* }}}
*
* @param array $options list of query clauses to apply new parts to. Accepts:
*
* - fields: Maps to the select method
* - conditions: Maps to the where method
* - limit: Maps to the limit method
* - order: Maps to the order method
* - offset: Maps to the offset method
* - group: Maps to the group method
* - having: Maps to the having method
* - contain: Maps to the contain options for eager loading
* - join: Maps to the join method
* - page: Maps to the page method
*
* @param array $options list of query clauses to apply new parts to.
* @return $this
*/
public function applyOptions(array $options) {
Expand Down
2 changes: 1 addition & 1 deletion src/View/Helper/FlashHelper.php
Expand Up @@ -44,7 +44,7 @@ class FlashHelper extends Helper {
* custom elements allows you to fully customize how flash messages are generated.
*
* {{{
* echo $this->Flash->render('flash', [element' => 'my_custom_element']);
* echo $this->Flash->render('flash', ['element' => 'my_custom_element']);
* }}}
*
* If you want to use an element from a plugin for rendering your flash message
Expand Down

0 comments on commit 2412e53

Please sign in to comment.