Merge pull request #4627 from colemanw/docblocks

[civicrm-core.git] / CRM / Member / BAO / Query.php

diff --git a/CRM/Member/BAO/Query.php b/CRM/Member/BAO/Query.php
index efdd8bd68eb028c50122137aceddc5161dcb007e..52689ebe2e1812348d508474e5c363eb01b9f2fa 100644 (file)
--- a/CRM/Member/BAO/Query.php
+++ b/CRM/Member/BAO/Query.php
@@ -34,6 +34,9 @@
  */
 class CRM_Member_BAO_Query {
 
+  /**
+   * @return array
+   */
   static function &getFields() {
     $fields = CRM_Member_BAO_Membership::exportableFields();
     return $fields;
@@ -42,6 +45,8 @@ class CRM_Member_BAO_Query {
   /**
    * if membership are involved, add the specific membership fields
    *
+   * @param $query
+   *
    * @return void
    * @access public
    */
@@ -126,6 +131,9 @@ class CRM_Member_BAO_Query {
     }
   }
 
+  /**
+   * @param $query
+   */
   static function where(&$query) {
     $grouping = NULL;
     foreach (array_keys($query->_params) as $id) {
@@ -142,6 +150,10 @@ class CRM_Member_BAO_Query {
     }
   }
 
+  /**
+   * @param $values
+   * @param $query
+   */
   static function whereClauseSingle(&$values, &$query) {
     list($name, $op, $value, $grouping, $wildcard) = $values;
     switch ($name) {
@@ -203,7 +215,7 @@ class CRM_Member_BAO_Query {
         }
         else {
           $status = implode(',', array_keys($value));
-          if (count($value) > 1) {
+          if (count($value) > 0) {
             $op = 'IN';
             $status = "({$status})";
           }
@@ -241,11 +253,9 @@ class CRM_Member_BAO_Query {
           $query->_where[$grouping][] = CRM_Contact_BAO_Query::buildClause(
             "ccr.contribution_status_id",
             $op,
-            CRM_Core_DAO::getFieldValue(
-              'CRM_Core_DAO_OptionValue',
-              'Cancelled',
-              'value',
-              'name'
+            array_search(
+              'Cancelled', 
+              CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name')
             ),
             "Integer"
           );
@@ -286,7 +296,7 @@ class CRM_Member_BAO_Query {
         }
         else {
           $mType = implode(',', array_keys($value));
-          if (count($value) > 1) {
+          if (count($value) > 0) {
             $op = 'IN';
             $mType = "({$mType})";
           }
@@ -337,6 +347,13 @@ class CRM_Member_BAO_Query {
     }
   }
 
+  /**
+   * @param $name
+   * @param $mode
+   * @param $side
+   *
+   * @return null|string
+   */
   static function from($name, $mode, $side) {
     $from = NULL;
     switch ($name) {
@@ -370,6 +387,12 @@ class CRM_Member_BAO_Query {
     return $from;
   }
 
+  /**
+   * @param $mode
+   * @param bool $includeCustomFields
+   *
+   * @return array|null
+   */
   static function defaultReturnProperties($mode,
     $includeCustomFields = TRUE
   ) {
@@ -409,6 +432,9 @@ class CRM_Member_BAO_Query {
     return $properties;
   }
 
+  /**
+   * @param CRM_Core_Form $form
+   */
   static function buildSearchForm(&$form) {
     foreach (CRM_Member_PseudoConstant::membershipType() as $id => $Name) {
       $form->_membershipType = &$form->addElement('checkbox', "member_membership_type_id[$id]", NULL, $Name);
@@ -456,8 +482,15 @@ class CRM_Member_BAO_Query {
     $form->setDefaults(array('member_test' => 0));
   }
 
+  /**
+   * @param $row
+   * @param $id
+   */
   static function searchAction(&$row, $id) {}
 
+  /**
+   * @param $tables
+   */
   static function tableNames(&$tables) {
     //add membership table
     if (!empty($tables['civicrm_membership_log']) || !empty($tables['civicrm_membership_status']) || CRM_Utils_Array::value('civicrm_membership_type', $tables)) {