From de8aed534f0b60b20159ccd9844ebaa38c468756 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc=20W=C3=BCrth?= Date: Thu, 8 Oct 2015 16:31:01 +0200 Subject: [PATCH] Add false as return value of field() + improve DocBlocks --- lib/Cake/Model/Datasource/DboSource.php | 6 +++--- lib/Cake/Model/Model.php | 12 ++++++------ 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/lib/Cake/Model/Datasource/DboSource.php b/lib/Cake/Model/Datasource/DboSource.php index a01cee654..3153e851c 100644 --- a/lib/Cake/Model/Datasource/DboSource.php +++ b/lib/Cake/Model/Datasource/DboSource.php @@ -739,9 +739,9 @@ class DboSource extends DataSource { /** * Returns a single field of the first of query results for a given SQL query, or false if empty. * - * @param string $name Name of the field - * @param string $sql SQL query - * @return mixed Value of field read. + * @param string $name The name of the field to get. + * @param string $sql The SQL query. + * @return mixed Value of field read, or false if not found. */ public function field($name, $sql) { $data = $this->fetchRow($sql); diff --git a/lib/Cake/Model/Model.php b/lib/Cake/Model/Model.php index 23f39d7cc..685332b49 100644 --- a/lib/Cake/Model/Model.php +++ b/lib/Cake/Model/Model.php @@ -1636,13 +1636,13 @@ class Model extends Object implements CakeEventListener { } /** - * Returns the contents of a single field given the supplied conditions, in the - * supplied order. + * Returns the content of a single field given the supplied conditions, + * of the first record in the supplied order. * - * @param string $name Name of field to get - * @param array $conditions SQL conditions (defaults to NULL) - * @param string $order SQL ORDER BY fragment - * @return string field contents, or false if not found + * @param string $name The name of the field to get. + * @param array $conditions SQL conditions (defaults to NULL). + * @param string $order SQL ORDER BY fragment. + * @return string|false Field content, or false if not found. * @link http://book.cakephp.org/2.0/en/models/retrieving-your-data.html#model-field */ public function field($name, $conditions = null, $order = null) {