Merge branch 4.5 into master

[civicrm-core.git] / CRM / Report / Utils / Report.php

diff --git a/CRM/Report/Utils/Report.php b/CRM/Report/Utils/Report.php
index 5cbf13d54f6e4ff1f7f0eea2e24459dabb79ea6a..94667f7daea9d5a5743914099b2a67a3d2f98ab7 100644 (file)
--- a/CRM/Report/Utils/Report.php
+++ b/CRM/Report/Utils/Report.php
@@ -1,5 +1,4 @@
 <?php
-
 /*
  +--------------------------------------------------------------------+
  | CiviCRM version 4.6                                                |
@@ -24,7 +23,7 @@
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
  *
@@ -155,14 +154,15 @@ WHERE  TRIM(BOTH '/' FROM CONCAT(report_id, '/', name)) = %1";
     }
   }
 
-  // get instance count for a template
   /**
+   * get instance count for a template.
    * @param $optionVal
    *
    * @return int|null|string
    */
   public static function getInstanceCount($optionVal) {
-    if (empty($optionVal)) { return 0;
+    if (empty($optionVal)) {
+      return 0;
     }
 
     $sql = "
@@ -190,7 +190,7 @@ WHERE  inst.report_id = %1";
 
     list($domainEmailName,
       $domainEmailAddress
-    ) = CRM_Core_BAO_Domain::getNameAndEmail();
+      ) = CRM_Core_BAO_Domain::getNameAndEmail();
 
     $params = array('id' => $instanceID);
     $instanceInfo = array();
@@ -199,13 +199,13 @@ WHERE  inst.report_id = %1";
       $instanceInfo
     );
 
-    $params              = array();
+    $params = array();
     $params['groupName'] = 'Report Email Sender';
-    $params['from']      = '"' . $domainEmailName . '" <' . $domainEmailAddress . '>';
+    $params['from'] = '"' . $domainEmailName . '" <' . $domainEmailAddress . '>';
     //$domainEmailName;
-    $params['toName']  = "";
+    $params['toName'] = "";
     $params['toEmail'] = CRM_Utils_Array::value('email_to', $instanceInfo);
-    $params['cc']      = CRM_Utils_Array::value('email_cc', $instanceInfo);
+    $params['cc'] = CRM_Utils_Array::value('email_cc', $instanceInfo);
     $params['subject'] = CRM_Utils_Array::value('email_subject', $instanceInfo);
     if (empty($instanceInfo['attachments'])) {
       $instanceInfo['attachments'] = array();
@@ -251,8 +251,8 @@ WHERE  inst.report_id = %1";
     }
     // Add the headers.
     $csv .= implode($config->fieldSeparator,
-      $headers
-    ) . "\r\n";
+        $headers
+      ) . "\r\n";
 
     $displayRows = array();
     $value = NULL;
@@ -287,8 +287,8 @@ WHERE  inst.report_id = %1";
       }
       // Add the data row.
       $csv .= implode($config->fieldSeparator,
-        $displayRows
-      ) . "\r\n";
+          $displayRows
+        ) . "\r\n";
     }
 
     return $csv;
@@ -346,8 +346,8 @@ WHERE  inst.report_id = %1";
 
     if (!empty($instanceValues['permission']) &&
       (!(CRM_Core_Permission::check($instanceValues['permission']) ||
-          CRM_Core_Permission::check('administer Reports')
-        ))
+        CRM_Core_Permission::check('administer Reports')
+      ))
     ) {
       return FALSE;
     }
@@ -362,8 +362,8 @@ WHERE  inst.report_id = %1";
    *
    * @param int $instanceId
    *
-   * @return boolean true if yes, else false
-   * @static
+   * @return bool
+   *   true if yes, else false
    */
   public static function isInstanceGroupRoleAllowed($instanceId) {
     if (!$instanceId) {
@@ -410,8 +410,8 @@ WHERE  inst.report_id = %1";
     $messages = array("Report Mail Triggered...");
 
     $templateInfo = CRM_Core_OptionGroup::getRowValues('report_template', $optionVal, 'value');
-    $obj          = new CRM_Report_Page_Instance();
-    $is_error     = 0;
+    $obj = new CRM_Report_Page_Instance();
+    $is_error = 0;
     if (strstr(CRM_Utils_Array::value('name', $templateInfo), '_Form')) {
       $instanceInfo = array();
       CRM_Report_BAO_ReportInstance::retrieve(array('id' => $instanceId), $instanceInfo);
@@ -433,7 +433,7 @@ WHERE  inst.report_id = %1";
             'default' => 'null',
           ),
         ),
-        'ignoreKey' => TRUE
+        'ignoreKey' => TRUE,
       );
       $messages[] = $wrapper->run($templateInfo['name'], NULL, $arguments);
     }
@@ -464,7 +464,8 @@ WHERE  inst.report_id = %1";
    * @param array $params
    *   All effective report criteria, as in CRM_Report_Form::_params.
    *
-   * @return string URL query string
+   * @return string
+   *   URL query string
    */
   public static function getPreviewCriteriaQueryParams($defaults = array(), $params = array()) {
     static $query_string;
@@ -486,8 +487,8 @@ WHERE  inst.report_id = %1";
         // (in other words, there's no point in propagating blank filters).
         foreach ($process_params as $field_name => $field_value) {
           $suffix_position = strrpos($field_name, '_');
-          $suffix          = substr($field_name, $suffix_position);
-          $basename        = substr($field_name, 0, $suffix_position);
+          $suffix = substr($field_name, $suffix_position);
+          $basename = substr($field_name, 0, $suffix_position);
           if ($suffix == '_min' || $suffix == '_max' ||
             $suffix == '_from' || $suffix == '_to' ||
             $suffix == '_relative'
@@ -543,7 +544,7 @@ WHERE  inst.report_id = %1";
   public static function getInstanceList($reportUrl) {
     static $instanceDetails = array();
 
-    if (!array_key_exists($reportUrl, $instanceDetails )) {
+    if (!array_key_exists($reportUrl, $instanceDetails)) {
       $instanceDetails[$reportUrl] = array();
 
       $sql = "
@@ -557,4 +558,5 @@ WHERE  report_id = %1";
     }
     return $instanceDetails[$reportUrl];
   }
+
 }