INFRA-132 - CRM/Report - phpcbf
[civicrm-core.git] / CRM / Report / Utils / Report.php
index 42ad6bde97794b3766701f255878f85ac55e13f9..7d8f6cb09da11d3df64b9310ce42995e0470f13a 100644 (file)
@@ -2,7 +2,7 @@
 
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
@@ -40,7 +40,7 @@ class CRM_Report_Utils_Report {
    *
    * @return null|string
    */
-  static function getValueFromUrl($instanceID = NULL) {
+  public static function getValueFromUrl($instanceID = NULL) {
     if ($instanceID) {
       $optionVal = CRM_Core_DAO::getFieldValue('CRM_Report_DAO_ReportInstance',
         $instanceID,
@@ -67,7 +67,7 @@ class CRM_Report_Utils_Report {
    *
    * @return array|bool
    */
-  static function getValueIDFromUrl($instanceID = NULL) {
+  public static function getValueIDFromUrl($instanceID = NULL) {
     $optionVal = self::getValueFromUrl($instanceID);
 
     if ($optionVal) {
@@ -83,7 +83,7 @@ class CRM_Report_Utils_Report {
    *
    * @return mixed
    */
-  static function getInstanceIDForValue($optionVal) {
+  public static function getInstanceIDForValue($optionVal) {
     static $valId = array();
 
     if (!array_key_exists($optionVal, $valId)) {
@@ -102,7 +102,7 @@ WHERE  report_id = %1";
    *
    * @return mixed
    */
-  static function getInstanceIDForPath($path = NULL) {
+  public static function getInstanceIDForPath($path = NULL) {
     static $valId = array();
 
     // if $path is null, try to get it from url
@@ -128,14 +128,16 @@ WHERE  TRIM(BOTH '/' FROM CONCAT(report_id, '/', name)) = %1";
    *
    * @return bool|string
    */
-  static function getNextUrl($urlValue, $query = 'reset=1', $absolute = FALSE, $instanceID = NULL, $drilldownReport = array()) {
+  public static function getNextUrl($urlValue, $query = 'reset=1', $absolute = FALSE, $instanceID = NULL, $drilldownReport = array()) {
     if ($instanceID) {
-      $drilldownInstanceID = false;
-      if (array_key_exists($urlValue, $drilldownReport))
+      $drilldownInstanceID = FALSE;
+      if (array_key_exists($urlValue, $drilldownReport)) {
         $drilldownInstanceID = CRM_Core_DAO::getFieldValue('CRM_Report_DAO_ReportInstance', $instanceID, 'drilldown_id', 'id');
+      }
 
-      if (!$drilldownInstanceID)
+      if (!$drilldownInstanceID) {
         $drilldownInstanceID = self::getInstanceIDForValue($urlValue);
+      }
 
       if ($drilldownInstanceID) {
         return CRM_Utils_System::url("civicrm/report/instance/{$drilldownInstanceID}",
@@ -159,8 +161,9 @@ WHERE  TRIM(BOTH '/' FROM CONCAT(report_id, '/', name)) = %1";
    *
    * @return int|null|string
    */
-  static function getInstanceCount($optionVal) {
-    if (empty($optionVal)) return 0;
+  public static function getInstanceCount($optionVal) {
+    if (empty($optionVal)) { return 0;
+    }
 
     $sql = "
 SELECT count(inst.id)
@@ -180,7 +183,7 @@ WHERE  inst.report_id = %1";
    *
    * @return bool
    */
-  static function mailReport($fileContent, $instanceID = NULL, $outputMode = 'html', $attachments = array()) {
+  public static function mailReport($fileContent, $instanceID = NULL, $outputMode = 'html', $attachments = array()) {
     if (!$instanceID) {
       return FALSE;
     }
@@ -218,7 +221,7 @@ WHERE  inst.report_id = %1";
    * @param CRM_Core_Form $form
    * @param $rows
    */
-  static function export2csv(&$form, &$rows) {
+  public static function export2csv(&$form, &$rows) {
     //Mark as a CSV file.
     header('Content-Type: text/csv');
 
@@ -233,7 +236,7 @@ WHERE  inst.report_id = %1";
    * Utility function for export2csv and CRM_Report_Form::endPostProcess
    * - make CSV file content and return as string.
    */
-  static function makeCsv(&$form, &$rows) {
+  public static function makeCsv(&$form, &$rows) {
     $config = CRM_Core_Config::singleton();
     $csv = '';
 
@@ -294,7 +297,7 @@ WHERE  inst.report_id = %1";
   /**
    * @return mixed
    */
-  static function getInstanceID() {
+  public static function getInstanceID() {
 
     $config = CRM_Core_Config::singleton();
     $arg = explode('/', $_GET[$config->userFrameworkURLVar]);
@@ -311,7 +314,7 @@ WHERE  inst.report_id = %1";
   /**
    * @return string
    */
-  static function getInstancePath() {
+  public static function getInstancePath() {
     $config = CRM_Core_Config::singleton();
     $arg = explode('/', $_GET[$config->userFrameworkURLVar]);
 
@@ -329,7 +332,7 @@ WHERE  inst.report_id = %1";
    *
    * @return bool
    */
-  static function isInstancePermissioned($instanceId) {
+  public static function isInstancePermissioned($instanceId) {
     if (!$instanceId) {
       return TRUE;
     }
@@ -361,9 +364,8 @@ WHERE  inst.report_id = %1";
    *
    * @return boolean true if yes, else false
    * @static
-   * @access public
    */
-  static function isInstanceGroupRoleAllowed($instanceId) {
+  public static function isInstanceGroupRoleAllowed($instanceId) {
     if (!$instanceId) {
       return TRUE;
     }
@@ -393,7 +395,7 @@ WHERE  inst.report_id = %1";
    *
    * @return array
    */
-  static function processReport($params) {
+  public static function processReport($params) {
     $instanceId = CRM_Utils_Array::value('instanceId', $params);
 
     // hack for now, CRM-8358
@@ -457,12 +459,14 @@ WHERE  inst.report_id = %1";
    * stipulated in $_GET or in a report Preview, but which haven't yet been
    * saved in the report instance.
    *
-   * @param array $defaults The report criteria that aren't coming in as submitted form values, as in CRM_Report_Form::_defaults
-   * @param array $params All effective report criteria, as in CRM_Report_Form::_params
+   * @param array $defaults
+   *   The report criteria that aren't coming in as submitted form values, as in CRM_Report_Form::_defaults.
+   * @param array $params
+   *   All effective report criteria, as in CRM_Report_Form::_params.
    *
    * @return string URL query string
    */
-  static function getPreviewCriteriaQueryParams($defaults = array(), $params = array()) {
+  public static function getPreviewCriteriaQueryParams($defaults = array(), $params = array()) {
     static $query_string;
     if (!isset($query_string)) {
       if (!empty($params)) {
@@ -536,7 +540,7 @@ WHERE  inst.report_id = %1";
    *
    * @return mixed
    */
-  static function getInstanceList($reportUrl) {
+  public static function getInstanceList($reportUrl) {
     static $instanceDetails = array();
 
     if (!array_key_exists($reportUrl, $instanceDetails )) {