CRM/Case/XMLProcessor.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2019
  32  */
  33 class CRM_Case_XMLProcessor {
  34
  35   /**
  36    * FIXME: This does *NOT* belong in a static property, but we're too late in
  37    * the 4.5-cycle to do the necessary cleanup.
  38    *
  39    * Format is [int $id => string $relTypeCname].
  40    *
  41    * @var array|null
  42    */
  43   public static $activityTypes = NULL;
  44
  45   /**
  46    * @param $caseType
  47    *
  48    * @return FALSE|SimpleXMLElement
  49    */
  50   public function retrieve($caseType) {
  51     return CRM_Case_XMLRepository::singleton()->retrieve($caseType);
  52   }
  53
  54   /**
  55    * This function was previously used to convert a case-type's
  56    * machine-name to a file-name. However, it's mind-boggling
  57    * that the file-name might be a munged version of the
  58    * machine-name (which is itself a munged version of the
  59    * display-name), and naming is now a more visible issue (since
  60    * the overhaul of CaseType admin UI).
  61    *
  62    * Usage note: This is called externally by civix stubs as a
  63    * sort of side-ways validation of the case-type's name
  64    * (validation which was needed because of the unintuitive
  65    * double-munge). We should update civix templates and then
  66    * remove this function in Civi 4.6 or 5.0.
  67    *
  68    * @param string $caseType
  69    * @return string
  70    * @deprecated
  71    * @see CRM_Case_BAO_CaseType::isValidName
  72    */
  73   public static function mungeCaseType($caseType) {
  74     // trim all spaces from $caseType
  75     $caseType = str_replace('_', ' ', $caseType);
  76     $caseType = CRM_Utils_String::munge(ucwords($caseType), '', 0);
  77     return $caseType;
  78   }
  79
  80   /**
  81    * @param bool $indexName
  82    * @param bool $all
  83    *
  84    * @return array
  85    */
  86   public function &allActivityTypes($indexName = TRUE, $all = FALSE) {
  87     if (self::$activityTypes === NULL) {
  88       self::$activityTypes = CRM_Case_PseudoConstant::caseActivityType($indexName, $all);
  89     }
  90     return self::$activityTypes;
  91   }
  92
  93   /**
  94    * Get all relationship type display labels (not machine names)
  95    *
  96    * @param bool $fromXML
  97    *   TODO: This parameter is always FALSE now so no longer needed.
  98    *   Is this to be used for lookup of values from XML?
  99    *   Relationships are recorded in XML from the perspective of the non-client
 100    *   while relationships in the UI and everywhere else are from the
 101    *   perspective of the client.  Since the XML can't be expected to be
 102    *   switched, the direction needs to be translated.
 103    * @return array
 104    */
 105   public function &allRelationshipTypes($fromXML = FALSE) {
 106     if (!isset(Civi::$statics[__CLASS__]['reltypes'][$fromXML])) {
 107       // Note this now includes disabled types too. The only place this
 108       // function is being used is for comparison against a list, not
 109       // displaying a dropdown list or something like that, so we need
 110       // to include disabled.
 111       $relationshipInfo = civicrm_api3('RelationshipType', 'get', [
 112         'options' => ['limit' => 0],
 113       ]);
 114
 115       Civi::$statics[__CLASS__]['reltypes'][$fromXML] = [];
 116       foreach ($relationshipInfo['values'] as $id => $info) {
 117         Civi::$statics[__CLASS__]['reltypes'][$fromXML][$id . '_b_a'] = ($fromXML) ? $info['label_a_b'] : $info['label_b_a'];
 118         /**
 119          * Exclude if bidirectional
 120          * (Why? I'm thinking this was for consistency with the dropdown
 121          * in ang/crmCaseType.js where it would be needed to avoid seeing
 122          * duplicates in the dropdown. Not sure if needed here but keeping
 123          * as-is.)
 124          */
 125         if ($info['label_b_a'] !== $info['label_a_b']) {
 126           Civi::$statics[__CLASS__]['reltypes'][$fromXML][$id . '_a_b'] = ($fromXML) ? $info['label_b_a'] : $info['label_a_b'];
 127         }
 128       }
 129     }
 130
 131     return Civi::$statics[__CLASS__]['reltypes'][$fromXML];
 132   }
 133
 134   /**
 135    * FIXME: This should not exist
 136    */
 137   public static function flushStaticCaches() {
 138     self::$activityTypes = NULL;
 139     unset(Civi::$statics[__CLASS__]['reltypes']);
 140   }
 141
 142 }