Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
fee14197 | 4 | | CiviCRM version 5 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
6b83d5bd | 6 | | Copyright CiviCRM LLC (c) 2004-2019 | |
6a488035 TO |
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 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
6a488035 TO |
27 | |
28 | /** | |
29 | * | |
30 | * @package CRM | |
6b83d5bd | 31 | * @copyright CiviCRM LLC (c) 2004-2019 |
6a488035 TO |
32 | */ |
33 | class CRM_Case_XMLProcessor { | |
34 | ||
4bc6c777 TO |
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 | * | |
041ecc95 | 39 | * Format is [int $id => string $relTypeCname]. |
40 | * | |
41 | * @var array|null | |
4bc6c777 TO |
42 | */ |
43 | public static $activityTypes = NULL; | |
44 | ||
45 | /** | |
46 | * FIXME: This does *NOT* belong in a static property, but we're too late in | |
47 | * the 4.5-cycle to do the necessary cleanup. | |
48 | * | |
041ecc95 | 49 | * Format is array(int $id => string $relTypeCname). |
50 | * | |
51 | * @var array|null | |
4bc6c777 TO |
52 | */ |
53 | public static $relationshipTypes = NULL; | |
54 | ||
168f458e TO |
55 | /** |
56 | * Relationship-types have four name fields (name_a_b, name_b_a, label_a_b, | |
57 | * label_b_a), but CiviCase XML refers to reltypes by a single name. | |
58 | * REL_TYPE_CNAME identifies the canonical name field as used by CiviCase XML. | |
59 | * | |
60 | * This appears to be "label_b_a", but IMHO "name_b_a" would be more | |
61 | * sensible. | |
62 | */ | |
63 | const REL_TYPE_CNAME = 'label_b_a'; | |
64 | ||
4c6ce474 EM |
65 | /** |
66 | * @param $caseType | |
67 | * | |
68 | * @return FALSE|SimpleXMLElement | |
69 | */ | |
fa1c763d TO |
70 | public function retrieve($caseType) { |
71 | return CRM_Case_XMLRepository::singleton()->retrieve($caseType); | |
6a488035 TO |
72 | } |
73 | ||
4c6ce474 | 74 | /** |
076f81b6 | 75 | * This function was previously used to convert a case-type's |
76 | * machine-name to a file-name. However, it's mind-boggling | |
77 | * that the file-name might be a munged version of the | |
78 | * machine-name (which is itself a munged version of the | |
79 | * display-name), and naming is now a more visible issue (since | |
80 | * the overhaul of CaseType admin UI). | |
81 | * | |
82 | * Usage note: This is called externally by civix stubs as a | |
83 | * sort of side-ways validation of the case-type's name | |
84 | * (validation which was needed because of the unintuitive | |
85 | * double-munge). We should update civix templates and then | |
86 | * remove this function in Civi 4.6 or 5.0. | |
4c6ce474 | 87 | * |
076f81b6 | 88 | * @param string $caseType |
89 | * @return string | |
90 | * @deprecated | |
91 | * @see CRM_Case_BAO_CaseType::isValidName | |
4c6ce474 | 92 | */ |
6b86870e TO |
93 | public static function mungeCaseType($caseType) { |
94 | // trim all spaces from $caseType | |
95 | $caseType = str_replace('_', ' ', $caseType); | |
96 | $caseType = CRM_Utils_String::munge(ucwords($caseType), '', 0); | |
97 | return $caseType; | |
98 | } | |
99 | ||
4c6ce474 EM |
100 | /** |
101 | * @param bool $indexName | |
102 | * @param bool $all | |
103 | * | |
104 | * @return array | |
105 | */ | |
00be9182 | 106 | public function &allActivityTypes($indexName = TRUE, $all = FALSE) { |
4bc6c777 TO |
107 | if (self::$activityTypes === NULL) { |
108 | self::$activityTypes = CRM_Case_PseudoConstant::caseActivityType($indexName, $all); | |
6a488035 | 109 | } |
4bc6c777 | 110 | return self::$activityTypes; |
6a488035 TO |
111 | } |
112 | ||
4c6ce474 EM |
113 | /** |
114 | * @return array | |
115 | */ | |
00be9182 | 116 | public function &allRelationshipTypes() { |
4bc6c777 TO |
117 | if (self::$relationshipTypes === NULL) { |
118 | $relationshipInfo = CRM_Core_PseudoConstant::relationshipType('label', TRUE); | |
6a488035 | 119 | |
be2fb01f | 120 | self::$relationshipTypes = []; |
6a488035 | 121 | foreach ($relationshipInfo as $id => $info) { |
4bc6c777 | 122 | self::$relationshipTypes[$id] = $info[CRM_Case_XMLProcessor::REL_TYPE_CNAME]; |
6a488035 TO |
123 | } |
124 | } | |
125 | ||
4bc6c777 TO |
126 | return self::$relationshipTypes; |
127 | } | |
128 | ||
129 | /** | |
130 | * FIXME: This should not exist | |
131 | */ | |
132 | public static function flushStaticCaches() { | |
133 | self::$activityTypes = NULL; | |
134 | self::$relationshipTypes = NULL; | |
6a488035 | 135 | } |
96025800 | 136 | |
6a488035 | 137 | } |