CRM-14137 report_template api - add ability to retrieve related metadata

----------------------------------------
* CRM-14137: Report_template.getrows api - allow retrieval of metadata at the top level
  http://issues.civicrm.org/jira/browse/CRM-14137

diff --git a/CRM/Report/Form.php b/CRM/Report/Form.php
index aa92d7b85b6b6e337cc3e5d0f1b99eddfa26ad85..c8db44a89d3a005b88b1f0d0a4a4488e1df5c909 100644 (file)
--- a/CRM/Report/Form.php
+++ b/CRM/Report/Form.php
@@ -378,7 +378,7 @@ class CRM_Report_Form extends CRM_Core_Form {
       if (empty($this->_instanceValues)) {
         CRM_Core_Error::fatal("Report could not be loaded.");
       }
-
+      $this->_title = $this->_instanceValues['title'];
       if (!empty($this->_instanceValues['permission']) &&
         (!(CRM_Core_Permission::check($this->_instanceValues['permission']) ||
           CRM_Core_Permission::check('administer Reports')
@@ -812,6 +812,13 @@ class CRM_Report_Form extends CRM_Core_Form {
   function getDefaultValues() {
     return $this->_defaults;
   }
+  /**
+   * Getter for $_title
+   * @return string $_title
+   */
+  function getTitle() {
+    return $this->_title;
+  }
 
   function addColumns() {
     $options = array();

diff --git a/api/v3/ReportTemplate.php b/api/v3/ReportTemplate.php
index b52cefa15fe461d2c70c576992cfa097aa6e9533..782190bd2d5199abb9116d445365039bf42450f9 100644 (file)
--- a/api/v3/ReportTemplate.php
+++ b/api/v3/ReportTemplate.php
@@ -87,8 +87,8 @@ function civicrm_api3_report_template_delete($params) {
  * @access public
  */
 function civicrm_api3_report_template_getrows($params) {
-  list($rows, $instance) = _civicrm_api3_report_template_getrows($params);
-  return civicrm_api3_create_success($rows, $params, 'report_template');
+  list($rows, $instance, $labels) = _civicrm_api3_report_template_getrows($params);
+  return civicrm_api3_create_success($rows, $params, 'report_template', 'getrows', CRM_Core_DAO::$_nullObject, $labels);
 }
 
 function _civicrm_api3_report_template_getrows($params) {
@@ -113,13 +113,19 @@ function _civicrm_api3_report_template_getrows($params) {
   $reportInstance->setOffsetValue($options['offset']);
   $reportInstance->beginPostProcessCommon();
   $sql = $reportInstance->buildQuery();
-  $rows = array();
+  $rows = $metadata = array();
   $reportInstance->buildRows($sql, $rows);
-  return array($rows, $reportInstance);
+  $metadata['title'] = $reportInstance->getTitle();
+  foreach ($reportInstance->_columnHeaders as $key => $header) {
+    //would be better just to expect reports to provide titles but reports are not consistent
+    //NB I think these are already translated
+    $metadata['labels'][$key] = !empty($header['title']) ? $header['title'] : '';
+  }
+  return array($rows, $reportInstance, $metadata);
 }
 
 function civicrm_api3_report_template_getstatistics($params) {
-  list($rows, $reportInstance) = _civicrm_api3_report_template_getrows($params);
+  list($rows, $reportInstance, $labels) = _civicrm_api3_report_template_getrows($params);
   $stats = $reportInstance->statistics($rows);
   return civicrm_api3_create_success($stats, $params, 'report_template');
 }

diff --git a/api/v3/examples/ReportTemplate/Getrows.php b/api/v3/examples/ReportTemplate/Getrows.php
index 6b29966390e8a821a74875009fc87c335e8e6c8e..9b2fe93fff322936bb26f70f6148a161cfc1d95f 100644 (file)
--- a/api/v3/examples/ReportTemplate/Getrows.php
+++ b/api/v3/examples/ReportTemplate/Getrows.php
@@ -47,6 +47,14 @@ function report_template_getrows_expectedresult(){
           'civicrm_country_name' => 'United States',
         ),
     ),
+  'title' => '',
+  'labels' => array(
+      'civicrm_contact_sort_name' => 'Contact Name',
+      'civicrm_contact_id' => 'Internal Contact ID',
+      'civicrm_address_street_address' => 'Street Address',
+      'civicrm_address_city' => 'City',
+      'civicrm_country_name' => 'Country',
+    ),
 );
 
   return $expectedResult;

diff --git a/tests/phpunit/api/v3/ReportTemplateTest.php b/tests/phpunit/api/v3/ReportTemplateTest.php
index cc25e90dce8e5e2266a5d49b130431ff32751656..495edee3121d963d01d5e4e0e0b56c80491dd103 100644 (file)
--- a/tests/phpunit/api/v3/ReportTemplateTest.php
+++ b/tests/phpunit/api/v3/ReportTemplateTest.php
@@ -118,6 +118,7 @@ class api_v3_ReportTemplateTest extends CiviUnitTestCase {
     $result = $this->callAPIAndDocument('report_template', 'getrows', array(
       'report_id' => 'contact/summary',
     ), __FUNCTION__, __FILE__, $description, 'Getrows', 'getrows');
+    $this->assertEquals('Contact Name', $result['labels']['civicrm_contact_sort_name']);
 
     //the second part of this test has been commented out because it relied on the db being reset to
     // it's base state