From 2158332a5db99597790ba3f845f4abd361f6ad3c Mon Sep 17 00:00:00 2001
From: Coleman Watts <coleman@civicrm.org>
Date: Fri, 3 May 2013 18:43:12 -0700
Subject: [PATCH] Remove PCP pseudoconstant CRM-12464

----------------------------------------
* CRM-12464:
  http://issues.civicrm.org/jira/browse/CRM-12464
---
 CRM/Core/DAO.php                              |   3 +-
 CRM/Core/PseudoConstant.php                   |   5 +-
 CRM/PCP/BAO/PCP.php                           |   6 +-
 CRM/PCP/Form/PCP.php                          |   8 +-
 CRM/PCP/Page/PCPInfo.php                      |   2 +-
 CRM/PCP/PseudoConstant.php                    | 109 ------------------
 tests/phpunit/CRM/Core/FieldOptionsTest.php   |   2 +-
 tests/phpunit/CRM/Core/PseudoConstantTest.php |  24 +++-
 xml/schema/Event/Event.xml                    |   2 -
 xml/schema/Event/Participant.xml              |   6 +-
 xml/schema/PCP/PCP.xml                        |   5 +-
 11 files changed, 45 insertions(+), 127 deletions(-)
 delete mode 100644 CRM/PCP/PseudoConstant.php

diff --git a/CRM/Core/DAO.php b/CRM/Core/DAO.php
index 23b47be3a5..ecf28df3fc 100644
--- a/CRM/Core/DAO.php
+++ b/CRM/Core/DAO.php
@@ -1771,13 +1771,14 @@ EOS;
   /**
    * Get options for the called BAO object's field.
    * This function can be overridden by each BAO to add more logic related to context.
+   * The overriding function will generally call the lower-level CRM_Core_PseudoConstant::get
    *
    * @param String $fieldName
    * @param String $context: e.g. "search" "edit" "create" "view"
    * @param Array  $props: whatever is known about this bao object
    */
   public static function buildOptions($fieldName, $context = NULL, $props = array()) {
-    // If a given bao does not override this function, it can still be called on that bao
+    // If a given bao does not override this function
     $baoName = get_called_class();
     return CRM_Core_PseudoConstant::get($baoName, $fieldName);
   }
diff --git a/CRM/Core/PseudoConstant.php b/CRM/Core/PseudoConstant.php
index e795035c22..b9552da6ef 100644
--- a/CRM/Core/PseudoConstant.php
+++ b/CRM/Core/PseudoConstant.php
@@ -277,8 +277,11 @@ class CRM_Core_PseudoConstant {
           $output = self::$cache[$cacheKey];
         }
         else {
-          // Get list of fields for the option table
           $daoName = CRM_Core_AllCoreTables::getClassForTable($pseudoconstant['table']);
+          if (!class_exists($daoName)) {
+            return FALSE;
+          }
+          // Get list of fields for the option table
           $dao = new $daoName;
           $availableFields = array_keys($dao->fieldKeys());
           if (in_array('is_active', $availableFields)) {
diff --git a/CRM/PCP/BAO/PCP.php b/CRM/PCP/BAO/PCP.php
index edc94d6323..87056f815b 100644
--- a/CRM/PCP/BAO/PCP.php
+++ b/CRM/PCP/BAO/PCP.php
@@ -452,7 +452,7 @@ WHERE pcp.id = %1 AND cc.contribution_status_id =1 AND cc.is_test = 0";
 
     $approvedId = CRM_Core_OptionGroup::getValue('pcp_status', 'Approved', 'name');
 
-    $pcpStatus = CRM_PCP_PseudoConstant::pcpStatus();
+    $pcpStatus = CRM_Core_OptionGroup::values("pcp_status");
 
     $params = array('id' => $pcpId);
     CRM_Core_DAO::commonRetrieve('CRM_PCP_DAO_PCP', $params, $pcpInfo);
@@ -564,7 +564,7 @@ WHERE pcp.id = %1 AND cc.contribution_status_id =1 AND cc.is_test = 0";
     $pcpTitle  = CRM_Core_DAO::getFieldValue('CRM_PCP_DAO_PCP', $id, 'title');
     $pcpPageType = CRM_Core_DAO::getFieldValue( 'CRM_PCP_DAO_PCP', $id, 'page_type' );
 
-    $pcpStatus = CRM_PCP_PseudoConstant::pcpStatus();
+    $pcpStatus = CRM_Core_OptionGroup::values("pcp_status");
     $pcpStatus = $pcpStatus[$is_active];
 
     CRM_Core_Session::setStatus(ts("%1 status has been updated to %2.", array(1 => $pcpTitle, 2 => $pcpStatus)), 'Status Updated', 'success');
@@ -592,7 +592,7 @@ WHERE pcp.id = %1 AND cc.contribution_status_id =1 AND cc.is_test = 0";
    *
    */
   static function sendStatusUpdate($pcpId, $newStatus, $isInitial = FALSE, $component = 'contribute') {
-    $pcpStatus = CRM_PCP_PseudoConstant::pcpStatus();
+    $pcpStatus = CRM_Core_OptionGroup::values("pcp_status");
     $config = CRM_Core_Config::singleton();
 
     if (!isset($pcpStatus[$newStatus])) {
diff --git a/CRM/PCP/Form/PCP.php b/CRM/PCP/Form/PCP.php
index 62e45cd366..a0b2e905d2 100644
--- a/CRM/PCP/Form/PCP.php
+++ b/CRM/PCP/Form/PCP.php
@@ -163,8 +163,12 @@ class CRM_PCP_Form_PCP extends CRM_Core_Form {
     }
     else {
 
-      $status       = array('' => ts('- select -')) + CRM_PCP_PseudoConstant::pcpStatus();
-      $types        = array('' => ts('- select -')) + CRM_PCP_PseudoConstant::pcpType();
+      $status = array('' => ts('- select -')) + CRM_Core_OptionGroup::values("pcp_status");
+      $types = array(
+        '' => ts('- select -'),
+        'contribute' => ts('Contribution'),
+        'event' => ts('Event'),
+      );
       $contribPages = array('' => ts('- select -')) + CRM_Contribute_PseudoConstant::contributionPage();
       $eventPages   = array('' => ts('- select -')) + CRM_Event_PseudoConstant::event(NULL, FALSE, "( is_template IS NULL OR is_template != 1 )");
 
diff --git a/CRM/PCP/Page/PCPInfo.php b/CRM/PCP/Page/PCPInfo.php
index 697140e37b..7c7095363b 100644
--- a/CRM/PCP/Page/PCPInfo.php
+++ b/CRM/PCP/Page/PCPInfo.php
@@ -78,7 +78,7 @@ class CRM_PCP_Page_PCPInfo extends CRM_Core_Page {
     CRM_Utils_System::setTitle($pcpInfo['title']);
     $this->assign('pcp', $pcpInfo);
 
-    $pcpStatus = CRM_PCP_PseudoConstant::pcpStatus();
+    $pcpStatus = CRM_Core_OptionGroup::values("pcp_status");
     $approvedId = CRM_Core_OptionGroup::getValue('pcp_status', 'Approved', 'name');
 
     // check if PCP is created by anonymous user
diff --git a/CRM/PCP/PseudoConstant.php b/CRM/PCP/PseudoConstant.php
deleted file mode 100644
index 80ac08f512..0000000000
--- a/CRM/PCP/PseudoConstant.php
+++ /dev/null
@@ -1,109 +0,0 @@
-<?php
-/*
- +--------------------------------------------------------------------+
- | CiviCRM version 4.3                                                |
- +--------------------------------------------------------------------+
- | 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$
- *
- */
-
-/**
- * This class holds all the Pseudo constants that are specific to PCP. This avoids
- * polluting the core class and isolates the Event
- */
-class CRM_PCP_PseudoConstant extends CRM_Core_PseudoConstant {
-
-  /**
-   * pcp types
-   *
-   * @var array
-   * @static
-   */
-  private static $pcpType;
-
-  /**
-   * pcp status
-   *
-   * @var array
-   * @static
-   */
-  private static $pcpStatus;
-
-  /**
-   * Get all the PCP types
-   *
-   * @access public
-   *
-   * @return array - array reference of all PCP types
-   * @static
-   */
-  public static function &pcpType() {
-    self::$pcpType = array();
-    if (!self::$pcpType) {
-      self::$pcpType = array(
-        'contribute' => 'Contribution',
-        'event' => 'Event',
-      );
-    }
-    return self::$pcpType;
-  }
-
-  /**
-   * Get all the PCP status
-   *
-   * @access public
-   *
-   * @return array - array reference of all PCP status
-   * @static
-   */
-  public static function &pcpStatus() {
-    self::$pcpStatus = array();
-    if (!self::$pcpStatus) {
-      self::$pcpStatus = CRM_Core_OptionGroup::values("pcp_status");
-    }
-    return self::$pcpStatus;
-  }
-
-  /**
-   * Flush given pseudoconstant so it can be reread from db
-   * nex time it's requested.
-   *
-   * @access public
-   * @static
-   *
-   * @param boolean $name pseudoconstant to be flushed
-   *
-   */
-  public static function flush($name) {
-   if (isset(self::$$name)) {
-      self::$$name = NULL;
-    }
-  }
-}
-
diff --git a/tests/phpunit/CRM/Core/FieldOptionsTest.php b/tests/phpunit/CRM/Core/FieldOptionsTest.php
index 302947d595..d3441a1443 100644
--- a/tests/phpunit/CRM/Core/FieldOptionsTest.php
+++ b/tests/phpunit/CRM/Core/FieldOptionsTest.php
@@ -28,7 +28,7 @@
 require_once 'CiviTest/CiviUnitTestCase.php';
 
 /**
- * Tests for linking to resource files
+ * Tests for field options
  */
 class CRM_Core_FieldOptionsTest extends CiviUnitTestCase {
   function get_info() {
diff --git a/tests/phpunit/CRM/Core/PseudoConstantTest.php b/tests/phpunit/CRM/Core/PseudoConstantTest.php
index 26360f86e4..695191f393 100644
--- a/tests/phpunit/CRM/Core/PseudoConstantTest.php
+++ b/tests/phpunit/CRM/Core/PseudoConstantTest.php
@@ -28,7 +28,7 @@
 require_once 'CiviTest/CiviUnitTestCase.php';
 
 /**
- * Tests for linking to resource files
+ * Tests for pseudoconstant retrieval
  */
 class CRM_Core_PseudoConstantTest extends CiviUnitTestCase {
   function get_info() {
@@ -397,6 +397,28 @@ class CRM_Core_PseudoConstantTest extends CiviUnitTestCase {
           'sample' => 'Yahoo',
         ),
       ),
+      'CRM_Event_DAO_Participant' => array(
+        array(
+          'fieldName' => 'status_id',
+          'sample' => 'Registered',
+        ),
+        array(
+          'fieldName' => 'role_id',
+          'sample' => 'Speaker',
+        ),
+      ),
+      'CRM_Event_DAO_Event' => array(
+        array(
+          'fieldName' => 'event_type_id',
+          'sample' => 'Fundraiser',
+        ),
+      ),
+      'CRM_PCP_DAO_PCP' => array(
+        array(
+          'fieldName' => 'status_id',
+          'sample' => 'Approved',
+        ),
+      ),
     );
 
     foreach ($fields as $daoName => $daoFields) {
diff --git a/xml/schema/Event/Event.xml b/xml/schema/Event/Event.xml
index 2e3f4aa9a5..3a7f88801c 100644
--- a/xml/schema/Event/Event.xml
+++ b/xml/schema/Event/Event.xml
@@ -60,9 +60,7 @@
     <title>Event Type ID</title>
     <default>0</default>
     <pseudoconstant>
-      <name>eventType</name>
       <optionGroupName>event_type</optionGroupName>
-      <class>CRM_Event_PseudoConstant</class>
     </pseudoconstant>
     <comment>Event Type ID.Implicit FK to civicrm_option_value where option_group = event_type.</comment> 
     <add>1.7</add> 
diff --git a/xml/schema/Event/Participant.xml b/xml/schema/Event/Participant.xml
index 1d5a9a3b6e..1d6f07bf0a 100644
--- a/xml/schema/Event/Participant.xml
+++ b/xml/schema/Event/Participant.xml
@@ -67,11 +67,9 @@
       <comment>Participant status ID. FK to civicrm_participant_status_type. Default of 1 should map to status = Registered.</comment>
       <add>1.7</add> 
       <pseudoconstant>
-        <name>participantStatus</name>
-        <table>civicrm_participant_status</table>
+        <table>civicrm_participant_status_type</table>
         <keyColumn>id</keyColumn>
         <labelColumn>name</labelColumn>
-        <class>CRM_Event_PseudoConstant</class>
       </pseudoconstant>
   </field>
   <foreignKey>
@@ -90,9 +88,7 @@
       <uniqueName>participant_role_id</uniqueName>
       <title>Participant Role Id</title>
       <pseudoconstant>
-        <name>participantRole</name>
         <optionGroupName>participant_role</optionGroupName>
-        <class>CRM_Event_PseudoConstant</class>
       </pseudoconstant>
       <headerPattern>/(participant.)?(role)$/i</headerPattern>
       <import>true</import>
diff --git a/xml/schema/PCP/PCP.xml b/xml/schema/PCP/PCP.xml
index 5cde13f68b..b009a5e4d7 100644
--- a/xml/schema/PCP/PCP.xml
+++ b/xml/schema/PCP/PCP.xml
@@ -41,6 +41,9 @@
       <required>true</required>
       <type>int unsigned</type>
       <add>2.2</add>
+      <pseudoconstant>
+        <optionGroupName>pcp_status</optionGroupName>
+      </pseudoconstant>
   </field>
   <field>      
       <name>title</name>
@@ -97,7 +100,7 @@
       <type>varchar</type>   
       <length>64</length>
       <default>'contribute'</default>
-      <add>2.2</add>   
+      <add>2.2</add>
   </field> 
   <field>      
       <name>pcp_block_id</name>
-- 
2.25.1