CRM_Utils_SQL_Select::execute() - Improve docblock

civicrm · Jul 20, 2017 · c4dcc9c · c4dcc9c
1 parent 77e74ae
commit c4dcc9c
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/CRM/Utils/SQL/Select.php b/CRM/Utils/SQL/Select.php
@@ -594,7 +594,20 @@ public function toSQL() {
   }
 
   /**
+   * 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.