From dcf562005c012f12caaceafd91f549862c4616f8 Mon Sep 17 00:00:00 2001
From: Tim Otten <totten@civicrm.org>
Date: Thu, 16 Jan 2014 18:10:21 -0800
Subject: [PATCH] CRM-13889 - api/v3/DashboardContact - Remove exemption for
 SyntaxConformanceTest. Fix bugs.

---
 CRM/Contact/BAO/DashboardContact.php          | 36 +++++++++++++++++
 CRM/Core/BAO/Dashboard.php                    |  6 ++-
 api/v3/DashboardContact.php                   | 39 +++++++++----------
 tests/phpunit/api/v3/DashboardContactTest.php |  2 +-
 .../phpunit/api/v3/SyntaxConformanceTest.php  | 18 ++++++---
 5 files changed, 73 insertions(+), 28 deletions(-)
 create mode 100644 CRM/Contact/BAO/DashboardContact.php

diff --git a/CRM/Contact/BAO/DashboardContact.php b/CRM/Contact/BAO/DashboardContact.php
new file mode 100644
index 0000000000..5862b04b5d
--- /dev/null
+++ b/CRM/Contact/BAO/DashboardContact.php
@@ -0,0 +1,36 @@
+<?php
+  /*
+   +--------------------------------------------------------------------+
+   | CiviCRM version 4.4                                                |
+   +--------------------------------------------------------------------+
+   | Copyright CiviCRM LLC (c) 2004-2013                                |
+   +--------------------------------------------------------------------+
+   | This file is a part of CiviCRM.                                    |
+   |                                                                    |
+   | CiviCRM is free software; you can copy, modify, and distribute it  |
+   | under the terms of the GNU Affero General Public License           |
+   | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
+   |                                                                    |
+   | CiviCRM is distributed in the hope that it will be useful, but     |
+   | WITHOUT ANY WARRANTY; without even the implied warranty of         |
+   | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
+   | See the GNU Affero General Public License for more details.        |
+   |                                                                    |
+   | You should have received a copy of the GNU Affero General Public   |
+   | License and the CiviCRM Licensing Exception along                  |
+   | with this program; if not, contact CiviCRM LLC                     |
+   | at info[AT]civicrm[DOT]org. If you have questions about the        |
+   | GNU Affero General Public License or the licensing of CiviCRM,     |
+   | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
+   +--------------------------------------------------------------------+
+  */
+
+  /**
+   *
+   * @package CRM
+   * @copyright CiviCRM LLC (c) 2004-2013
+   * $Id$
+   *
+   */
+class CRM_Contact_BAO_DashboardContact extends CRM_Contact_DAO_DashboardContact {
+}
\ No newline at end of file
diff --git a/CRM/Core/BAO/Dashboard.php b/CRM/Core/BAO/Dashboard.php
index 62e71391ba..0f5dcca112 100644
--- a/CRM/Core/BAO/Dashboard.php
+++ b/CRM/Core/BAO/Dashboard.php
@@ -312,7 +312,7 @@ class CRM_Core_BAO_Dashboard extends CRM_Core_DAO_Dashboard {
       throw new RuntimeException("Failed to determine contact ID");
     }
 
-    //we need to get existing dashletes, so we know when to update or insert
+    //we need to get existing dashlets, so we know when to update or insert
     $contactDashlets = self::getContactDashlets(TRUE, $contactID);
 
     $dashletIDs = array();
@@ -469,6 +469,10 @@ class CRM_Core_BAO_Dashboard extends CRM_Core_DAO_Dashboard {
     }
   }
 
+  /**
+   * @param array $params each item is a spec for a dashlet on the contact's dashboard
+   * @return bool
+   */
   static function addContactDashletToDashboard(&$params) {
     $valuesString = NULL;
     $columns = array();
diff --git a/api/v3/DashboardContact.php b/api/v3/DashboardContact.php
index fd8337a652..f7f7ba6c1d 100644
--- a/api/v3/DashboardContact.php
+++ b/api/v3/DashboardContact.php
@@ -45,16 +45,19 @@
  *
  */
 function civicrm_api3_dashboard_contact_create($params) {
-  civicrm_api3_verify_one_mandatory($params,
-    NULL,
-    array(
-      'dashboard_id',
-    )
-  );
+  if (empty($params['id'])) {
+    civicrm_api3_verify_one_mandatory($params,
+      NULL,
+      array(
+        'dashboard_id',
+      )
+    );
+  }
   $errors = _civicrm_api3_dashboard_contact_check_params($params);
-  $dashboard[] = $params;
-  $dashbordContact = CRM_Core_BAO_Dashboard::addContactDashletToDashboard($dashboard);
-  return civicrm_api3_create_success(TRUE);
+  if ($errors !== NULL) {
+    return $errors;
+  }
+  return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
 
 /**
@@ -67,15 +70,7 @@ function civicrm_api3_dashboard_contact_create($params) {
  *
  */
 function civicrm_api3_dashboard_contact_get($params) {
-  civicrm_api3_verify_one_mandatory($params,
-    NULL,
-    array(
-      'contact_id',
-    )
-  );
-  $bao = new CRM_Core_BAO_Dashboard();
-  $dashboardContact = CRM_Core_BAO_Dashboard::getContactDashlets(TRUE, CRM_Utils_Array::value('contact_id', $params));
-  return civicrm_api3_create_success($dashboardContact, $params, 'dashboard_contact', 'get');
+  return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
 
 /**
@@ -90,9 +85,11 @@ function _civicrm_api3_dashboard_contact_create_spec(&$params) {
 
 function _civicrm_api3_dashboard_contact_check_params(&$params) {
   $dashboard_id = CRM_Utils_Array::value('dashboard_id', $params);
-  $allDashlets = CRM_Core_BAO_Dashboard::getDashlets();
-  if (!in_array($dashboard_id, $allDashlets)) {
-    return civicrm_api3_create_error('Invalid Dashboard ID');
+  if ($dashboard_id) {
+    $allDashlets = CRM_Core_BAO_Dashboard::getDashlets();
+    if (!isset($allDashlets[$dashboard_id])) {
+      return civicrm_api3_create_error('Invalid Dashboard ID');
+    }
   }
   return NULL;
 }
\ No newline at end of file
diff --git a/tests/phpunit/api/v3/DashboardContactTest.php b/tests/phpunit/api/v3/DashboardContactTest.php
index f4a27a3c8c..32e31b68d4 100644
--- a/tests/phpunit/api/v3/DashboardContactTest.php
+++ b/tests/phpunit/api/v3/DashboardContactTest.php
@@ -34,7 +34,7 @@ require_once 'CiviTest/CiviUnitTestCase.php';
 class api_v3_DashboardContactTest extends CiviUnitTestCase {
   protected $_params;
   protected $_params2;
-  protected $_entity = 'dashborad_contact';
+  protected $_entity = 'dashboard_contact';
   protected $_apiversion = 3;
 
   public $_eNoticeCompliant = TRUE;
diff --git a/tests/phpunit/api/v3/SyntaxConformanceTest.php b/tests/phpunit/api/v3/SyntaxConformanceTest.php
index c3bff44ee9..20b2759d29 100644
--- a/tests/phpunit/api/v3/SyntaxConformanceTest.php
+++ b/tests/phpunit/api/v3/SyntaxConformanceTest.php
@@ -72,10 +72,19 @@ class api_v3_SyntaxConformanceTest extends CiviUnitTestCase {
     }
   }
 
-
   public static function entities($skip = NULL) {
-    // uncomment to make a quicker run when adding a test
+    // To only test specific entities, call phpunit with SYNTAX_CONFORMANCE_ENTITIES="TheEntityName"
+    // or uncomment this line:
     //return array(array ('Tag'), array ('Activity')  );
+
+    if (getenv('SYNTAX_CONFORMANCE_ENTITIES')) {
+      $result = array();
+      foreach (explode(' ', getenv('SYNTAX_CONFORMANCE_ENTITIES')) as $entity) {
+        $result[] = array($entity);
+      }
+      return $result;
+    }
+
     $tmp = civicrm_api('Entity', 'Get', array('version' => 3));
     if (!is_array($skip)) {
       $skip = array();
@@ -156,7 +165,7 @@ class api_v3_SyntaxConformanceTest extends CiviUnitTestCase {
  * @return multitype:string |multitype:multitype:string
  */
   public static function toBeSkipped_automock($sequential = FALSE) {
-    $entitiesWithoutGet = array('MailingContact', 'EntityTag', 'Participant', 'ParticipantPayment', 'Setting', 'SurveyRespondant', 'MailingRecipients',  'CustomSearch', 'Extension', 'ReportTemplate', 'System', 'DashboardContact');
+    $entitiesWithoutGet = array('MailingContact', 'EntityTag', 'Participant', 'ParticipantPayment', 'Setting', 'SurveyRespondant', 'MailingRecipients',  'CustomSearch', 'Extension', 'ReportTemplate', 'System');
     if ($sequential === TRUE) {
       return $entitiesWithoutGet;
     }
@@ -235,7 +244,6 @@ class api_v3_SyntaxConformanceTest extends CiviUnitTestCase {
       'MailSettings',
       'Setting',
       'MailingContact',
-      'DashboardContact',
     );
     if ($sequential === TRUE) {
       return $entitiesWithout;
@@ -741,7 +749,7 @@ class api_v3_SyntaxConformanceTest extends CiviUnitTestCase {
       );
 
       $checkEntity = $this->callAPISuccess($entityName, 'getsingle', $checkParams);
-      $this->assertAPIArrayComparison($entity, $checkEntity, array(), "changing field $fieldName\n" . print_r(array('update-params' => $updateParams, 'update-result' => $update, 'getsingle-params' => $checkParams, 'getsingle-result' => $checkEntity, 'expected entity' => $entity), TRUE));
+      $this->assertAPIArrayComparison($entity, $checkEntity, array(), "checking if $fieldName was correctly updaetd\n" . print_r(array('update-params' => $updateParams, 'update-result' => $update, 'getsingle-params' => $checkParams, 'getsingle-result' => $checkEntity, 'expected entity' => $entity), TRUE));
     }
     $baoObj->deleteTestObjects($baoString);
     $baoObj->free();
-- 
2.25.1