INFRA-132 - Remove extra spaces around '.'
[civicrm-core.git] / CRM / Mailing / BAO / Query.php
index e41adc503d864c0d317b89404a73291a1f5753d3..4cc084c077114ac23c04e45514dd5c6f66baa0a3 100644 (file)
@@ -1,7 +1,7 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
@@ -35,7 +35,10 @@ class CRM_Mailing_BAO_Query {
 
   static $_mailingFields = NULL;
 
-  static function &getFields() {
+  /**
+   * @return array|null
+   */
+  public static function &getFields() {
     if (!self::$_mailingFields) {
       self::$_mailingFields = array();
       $_mailingFields['mailing_id'] = array(
@@ -48,14 +51,13 @@ class CRM_Mailing_BAO_Query {
   }
 
   /**
-   * if mailings are involved, add the specific Mailing fields
+   * If mailings are involved, add the specific Mailing fields
    *
    * @param $query
    *
    * @return void
-   * @access public
    */
-  static function select(&$query) {
+  public static function select(&$query) {
     // if Mailing mode add mailing id
     if ($query->_mode & CRM_Contact_BAO_Query::MODE_MAILING) {
       $query->_select['mailing_id'] = "civicrm_mailing.id as mailing_id";
@@ -122,7 +124,10 @@ class CRM_Mailing_BAO_Query {
     }
   }
 
-  static function where(&$query) {
+  /**
+   * @param $query
+   */
+  public static function where(&$query) {
     $grouping = NULL;
     foreach (array_keys($query->_params) as $id) {
       if (empty($query->_params[$id][0])) {
@@ -138,7 +143,14 @@ class CRM_Mailing_BAO_Query {
     }
   }
 
-  static function from($name, $mode, $side) {
+  /**
+   * @param string $name
+   * @param $mode
+   * @param $side
+   *
+   * @return null|string
+   */
+  public static function from($name, $mode, $side) {
     $from = NULL;
 
     switch ($name) {
@@ -179,7 +191,14 @@ class CRM_Mailing_BAO_Query {
     return $from;
   }
 
-  static function defaultReturnProperties($mode,
+  /**
+   * @param $mode
+   * @param bool $includeCustomFields
+   *
+   * @return array|null
+   */
+  static function defaultReturnProperties(
+    $mode,
     $includeCustomFields = TRUE
   ) {
 
@@ -203,7 +222,11 @@ class CRM_Mailing_BAO_Query {
     return $properties;
   }
 
-  static function whereClauseSingle(&$values, &$query) {
+  /**
+   * @param $values
+   * @param $query
+   */
+  public static function whereClauseSingle(&$values, &$query) {
     list($name, $op, $value, $grouping, $wildcard) = $values;
 
     $fields = array();
@@ -228,8 +251,8 @@ class CRM_Mailing_BAO_Query {
         return;
 
       case 'mailing_name':
-        $value = strtolower( addslashes( $value ) );
-        if ( $wildcard ) {
+        $value = strtolower(addslashes($value));
+        if ($wildcard) {
           $value = "%$value%";
           $op    = 'LIKE';
         }
@@ -352,15 +375,14 @@ class CRM_Mailing_BAO_Query {
   }
 
   /**
-   * add all the elements shared between Mailing search and advnaced search
+   * Add all the elements shared between Mailing search and advnaced search
    *
-   * @access public
    *
-   * @param $form CRM_Core_Form
+   * @param CRM_Core_Form $form
    * @return void
    * @static
    */
-  static function buildSearchForm(&$form) {
+  public static function buildSearchForm(&$form) {
     // mailing selectors
     $mailings = CRM_Mailing_BAO_Mailing::getMailingsList();
 
@@ -402,9 +424,17 @@ class CRM_Mailing_BAO_Query {
     $form->assign('validCiviMailing', TRUE);
   }
 
-  static function searchAction(&$row, $id) {}
+  /**
+   * @param $row
+   * @param int $id
+   */
+  public static function searchAction(&$row, $id) {
+  }
 
-  static function tableNames(&$tables) {
+  /**
+   * @param $tables
+   */
+  public static function tableNames(&$tables) {
   }
 
   /**
@@ -412,15 +442,15 @@ class CRM_Mailing_BAO_Query {
    *
    * @param $query
    * @param $values
-   * @param $tableName
-   * @param $fieldName
+   * @param string $tableName
+   * @param string $fieldName
    * @param $fieldTitle
    *
    * @param $valueTitles
    *
    * @return void
    */
-  static function mailingEventQueryBuilder(&$query, &$values, $tableName, $fieldName, $fieldTitle, &$valueTitles) {
+  public static function mailingEventQueryBuilder(&$query, &$values, $tableName, $fieldName, $fieldTitle, &$valueTitles) {
     list($name, $op, $value, $grouping, $wildcard) = $values;
 
     if (empty($value) || $value == 'A') {
@@ -437,7 +467,7 @@ class CRM_Mailing_BAO_Query {
 
     if (is_array($value)) {
       $query->_where[$grouping][] = "$tableName.$fieldName $op (" . implode(',', $value) . ")";
-      $query->_qill[$grouping][] = "$fieldTitle $op ". implode(', ', array_intersect_key($valueTitles, array_flip($value)));
+      $query->_qill[$grouping][] = "$fieldTitle $op " . implode(', ', array_intersect_key($valueTitles, array_flip($value)));
     }
     else {
       $query->_qill[$grouping][] = $fieldTitle . ' - ' . $valueTitles[$value];
@@ -450,4 +480,3 @@ class CRM_Mailing_BAO_Query {
     $query->_tables[$tableName] = $query->_whereTables[$tableName] = 1;
   }
 }
-