| 1 | <?php |
| 2 | |
| 3 | /** |
| 4 | * Class CRM_Case_ManagedEntities |
| 5 | */ |
| 6 | class CRM_Case_ManagedEntities { |
| 7 | |
| 8 | /** |
| 9 | * Get a list of managed-entities representing auto-generated case-types |
| 10 | * using hook_civicrm_caseTypes. |
| 11 | * |
| 12 | * @return array |
| 13 | * @see CRM_Utils_Hook::managed |
| 14 | * @throws CRM_Core_Exception |
| 15 | */ |
| 16 | public static function createManagedCaseTypes() { |
| 17 | $entities = []; |
| 18 | |
| 19 | // Use hook_civicrm_caseTypes to build a list of OptionValues |
| 20 | // In the long run, we may want more specialized logic for this, but |
| 21 | // this design is fairly convenient and will allow us to replace it |
| 22 | // without changing the hook_civicrm_caseTypes interface. |
| 23 | |
| 24 | $caseTypes = []; |
| 25 | CRM_Utils_Hook::caseTypes($caseTypes); |
| 26 | |
| 27 | $proc = new CRM_Case_XMLProcessor(); |
| 28 | foreach ($caseTypes as $name => $caseType) { |
| 29 | $xml = $proc->retrieve($name); |
| 30 | if (!$xml) { |
| 31 | throw new CRM_Core_Exception("Failed to load XML for case type (" . $name . ")"); |
| 32 | } |
| 33 | |
| 34 | if (isset($caseType['module'], $caseType['name'], $caseType['file'])) { |
| 35 | $entities[] = [ |
| 36 | 'module' => $caseType['module'], |
| 37 | 'name' => $caseType['name'], |
| 38 | 'entity' => 'CaseType', |
| 39 | 'params' => [ |
| 40 | 'version' => 3, |
| 41 | 'name' => $caseType['name'], |
| 42 | 'title' => (string) $xml->name, |
| 43 | 'description' => (string) $xml->description, |
| 44 | 'is_reserved' => 1, |
| 45 | 'is_active' => 1, |
| 46 | 'weight' => $xml->weight ? $xml->weight : 1, |
| 47 | ], |
| 48 | ]; |
| 49 | } |
| 50 | else { |
| 51 | throw new CRM_Core_Exception("Invalid case type"); |
| 52 | } |
| 53 | } |
| 54 | return $entities; |
| 55 | } |
| 56 | |
| 57 | /** |
| 58 | * Get a list of managed activity-types by searching CiviCase XML files. |
| 59 | * |
| 60 | * @param \CRM_Case_XMLRepository $xmlRepo |
| 61 | * @param \CRM_Core_ManagedEntities $me |
| 62 | * |
| 63 | * @return array |
| 64 | * @see CRM_Utils_Hook::managed |
| 65 | */ |
| 66 | public static function createManagedActivityTypes(CRM_Case_XMLRepository $xmlRepo, CRM_Core_ManagedEntities $me) { |
| 67 | $result = []; |
| 68 | $validActTypes = CRM_Core_PseudoConstant::activityType(TRUE, TRUE, TRUE, 'name'); |
| 69 | |
| 70 | $actTypes = $xmlRepo->getAllDeclaredActivityTypes(); |
| 71 | foreach ($actTypes as $actType) { |
| 72 | $managed = [ |
| 73 | 'module' => 'civicrm', |
| 74 | 'name' => "civicase:act:$actType", |
| 75 | 'entity' => 'OptionValue', |
| 76 | 'update' => 'never', |
| 77 | 'cleanup' => 'unused', |
| 78 | 'params' => [ |
| 79 | 'version' => 3, |
| 80 | 'option_group_id' => 'activity_type', |
| 81 | 'label' => $actType, |
| 82 | 'name' => $actType, |
| 83 | 'description' => $actType, |
| 84 | 'component_id' => 'CiviCase', |
| 85 | ], |
| 86 | ]; |
| 87 | |
| 88 | // We'll create managed-entity if this record doesn't exist yet |
| 89 | // or if we previously decided to manage this record. |
| 90 | if (!in_array($actType, $validActTypes)) { |
| 91 | $result[] = $managed; |
| 92 | } |
| 93 | elseif ($me->get($managed['module'], $managed['name'])) { |
| 94 | $result[] = $managed; |
| 95 | } |
| 96 | } |
| 97 | |
| 98 | return $result; |
| 99 | } |
| 100 | |
| 101 | /** |
| 102 | * Get a list of managed relationship-types by searching CiviCase XML files. |
| 103 | * |
| 104 | * @param \CRM_Case_XMLRepository $xmlRepo |
| 105 | * @param \CRM_Core_ManagedEntities $me |
| 106 | * |
| 107 | * @return array |
| 108 | * @see CRM_Utils_Hook::managed |
| 109 | */ |
| 110 | public static function createManagedRelationshipTypes(CRM_Case_XMLRepository $xmlRepo, CRM_Core_ManagedEntities $me) { |
| 111 | $result = []; |
| 112 | |
| 113 | if (!isset(Civi::$statics[__CLASS__]['reltypes'])) { |
| 114 | $relationshipInfo = CRM_Core_PseudoConstant::relationshipType('name', TRUE, NULL); |
| 115 | foreach ($relationshipInfo as $id => $relTypeDetails) { |
| 116 | Civi::$statics[__CLASS__]['reltypes']["{$id}_a_b"] = $relTypeDetails['name_a_b']; |
| 117 | if ($relTypeDetails['name_a_b'] != $relTypeDetails['name_b_a']) { |
| 118 | Civi::$statics[__CLASS__]['reltypes']["{$id}_b_a"] = $relTypeDetails['name_b_a']; |
| 119 | } |
| 120 | } |
| 121 | } |
| 122 | $validRelTypes = Civi::$statics[__CLASS__]['reltypes']; |
| 123 | |
| 124 | $relTypes = $xmlRepo->getAllDeclaredRelationshipTypes(); |
| 125 | foreach ($relTypes as $relType) { |
| 126 | // Making assumption that client is the A side of the relationship. |
| 127 | // Relationship label coming from XML, meaning from perspective of |
| 128 | // non-client. |
| 129 | |
| 130 | // These assumptions only apply if a case type is introduced without the |
| 131 | // relationship types already existing. |
| 132 | $managed = [ |
| 133 | 'module' => 'civicrm', |
| 134 | 'name' => "civicase:rel:$relType", |
| 135 | 'entity' => 'RelationshipType', |
| 136 | 'update' => 'never', |
| 137 | 'cleanup' => 'unused', |
| 138 | 'params' => [ |
| 139 | 'version' => 3, |
| 140 | 'name_a_b' => "$relType is", |
| 141 | 'name_b_a' => $relType, |
| 142 | 'label_a_b' => "$relType is", |
| 143 | 'label_b_a' => $relType, |
| 144 | 'description' => $relType, |
| 145 | 'contact_type_a' => NULL, |
| 146 | 'contact_type_b' => NULL, |
| 147 | 'contact_sub_type_a' => NULL, |
| 148 | 'contact_sub_type_b' => NULL, |
| 149 | ], |
| 150 | ]; |
| 151 | |
| 152 | // We'll create managed-entity if this record doesn't exist yet |
| 153 | // or if we previously decided to manage this record. |
| 154 | if (!in_array($relType, $validRelTypes)) { |
| 155 | $result[] = $managed; |
| 156 | } |
| 157 | elseif ($me->get($managed['module'], $managed['name'])) { |
| 158 | $result[] = $managed; |
| 159 | } |
| 160 | } |
| 161 | |
| 162 | return $result; |
| 163 | } |
| 164 | |
| 165 | } |