133 lines
4.7 KiB
PHP
133 lines
4.7 KiB
PHP
<?php
|
|
/*
|
|
+--------------------------------------------------------------------+
|
|
| CiviCRM version 4.7 |
|
|
+--------------------------------------------------------------------+
|
|
| Copyright CiviCRM LLC (c) 2004-2017 |
|
|
+--------------------------------------------------------------------+
|
|
| 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-2017
|
|
*/
|
|
class CRM_Case_XMLProcessor {
|
|
|
|
/**
|
|
* FIXME: This does *NOT* belong in a static property, but we're too late in
|
|
* the 4.5-cycle to do the necessary cleanup.
|
|
*
|
|
* @var array|null array(int $id => string $relTypeCname)
|
|
*/
|
|
public static $activityTypes = NULL;
|
|
|
|
/**
|
|
* FIXME: This does *NOT* belong in a static property, but we're too late in
|
|
* the 4.5-cycle to do the necessary cleanup.
|
|
*
|
|
* @var array|null array(int $id => string $relTypeCname)
|
|
*/
|
|
public static $relationshipTypes = NULL;
|
|
|
|
/**
|
|
* Relationship-types have four name fields (name_a_b, name_b_a, label_a_b,
|
|
* label_b_a), but CiviCase XML refers to reltypes by a single name.
|
|
* REL_TYPE_CNAME identifies the canonical name field as used by CiviCase XML.
|
|
*
|
|
* This appears to be "label_b_a", but IMHO "name_b_a" would be more
|
|
* sensible.
|
|
*/
|
|
const REL_TYPE_CNAME = 'label_b_a';
|
|
|
|
/**
|
|
* @param $caseType
|
|
*
|
|
* @return FALSE|SimpleXMLElement
|
|
*/
|
|
public function retrieve($caseType) {
|
|
return CRM_Case_XMLRepository::singleton()->retrieve($caseType);
|
|
}
|
|
|
|
/**
|
|
* This function was previously used to convert a case-type's
|
|
* machine-name to a file-name. However, it's mind-boggling
|
|
* that the file-name might be a munged version of the
|
|
* machine-name (which is itself a munged version of the
|
|
* display-name), and naming is now a more visible issue (since
|
|
* the overhaul of CaseType admin UI).
|
|
*
|
|
* Usage note: This is called externally by civix stubs as a
|
|
* sort of side-ways validation of the case-type's name
|
|
* (validation which was needed because of the unintuitive
|
|
* double-munge). We should update civix templates and then
|
|
* remove this function in Civi 4.6 or 5.0.
|
|
*
|
|
* @param string $caseType
|
|
* @return string
|
|
* @deprecated
|
|
* @see CRM_Case_BAO_CaseType::isValidName
|
|
*/
|
|
public static function mungeCaseType($caseType) {
|
|
// trim all spaces from $caseType
|
|
$caseType = str_replace('_', ' ', $caseType);
|
|
$caseType = CRM_Utils_String::munge(ucwords($caseType), '', 0);
|
|
return $caseType;
|
|
}
|
|
|
|
/**
|
|
* @param bool $indexName
|
|
* @param bool $all
|
|
*
|
|
* @return array
|
|
*/
|
|
public function &allActivityTypes($indexName = TRUE, $all = FALSE) {
|
|
if (self::$activityTypes === NULL) {
|
|
self::$activityTypes = CRM_Case_PseudoConstant::caseActivityType($indexName, $all);
|
|
}
|
|
return self::$activityTypes;
|
|
}
|
|
|
|
/**
|
|
* @return array
|
|
*/
|
|
public function &allRelationshipTypes() {
|
|
if (self::$relationshipTypes === NULL) {
|
|
$relationshipInfo = CRM_Core_PseudoConstant::relationshipType('label', TRUE);
|
|
|
|
self::$relationshipTypes = array();
|
|
foreach ($relationshipInfo as $id => $info) {
|
|
self::$relationshipTypes[$id] = $info[CRM_Case_XMLProcessor::REL_TYPE_CNAME];
|
|
}
|
|
}
|
|
|
|
return self::$relationshipTypes;
|
|
}
|
|
|
|
/**
|
|
* FIXME: This should not exist
|
|
*/
|
|
public static function flushStaticCaches() {
|
|
self::$activityTypes = NULL;
|
|
self::$relationshipTypes = NULL;
|
|
}
|
|
|
|
}
|