From c4dcc9cf28e554530862fbc4b374e33f8a4ef4ad Mon Sep 17 00:00:00 2001 From: Tim Otten Date: Wed, 19 Jul 2017 17:34:15 -0700 Subject: [PATCH] CRM_Utils_SQL_Select::execute() - Improve docblock --- CRM/Utils/SQL/Select.php | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/CRM/Utils/SQL/Select.php b/CRM/Utils/SQL/Select.php index eccdbadb15..fc6b762f8d 100644 --- a/CRM/Utils/SQL/Select.php +++ b/CRM/Utils/SQL/Select.php @@ -594,7 +594,20 @@ class CRM_Utils_SQL_Select implements ArrayAccess { } /** + * Execute the query. + * + * To examine the results, use a function like `fetch()`, `fetchAll()`, + * `fetchValue()`, or `fetchMap()`. + * + * @param string|NULL $daoName + * The return object should be an instance of this class. + * Ex: 'CRM_Contact_BAO_Contact'. + * @param bool $i18nRewrite + * If the system has multilingual features, should the field/table + * names be rewritten? * @return CRM_Core_DAO + * @see CRM_Core_DAO::executeQuery + * @see CRM_Core_I18n_Schema::rewriteQuery */ public function execute($daoName = NULL, $i18nRewrite = TRUE) { // Don't pass through $params. toSQL() handles interpolation. -- 2.25.1