| 1 | <?php |
| 2 | |
| 3 | // AUTO-GENERATED FILE -- Civix may overwrite any changes made to this file |
| 4 | |
| 5 | /** |
| 6 | * The ExtensionUtil class provides small stubs for accessing resources of this |
| 7 | * extension. |
| 8 | */ |
| 9 | class CRM_Contributioncancelactions_ExtensionUtil { |
| 10 | const SHORT_NAME = "contributioncancelactions"; |
| 11 | const LONG_NAME = "contributioncancelactions"; |
| 12 | const CLASS_PREFIX = "CRM_Contributioncancelactions"; |
| 13 | |
| 14 | /** |
| 15 | * Translate a string using the extension's domain. |
| 16 | * |
| 17 | * If the extension doesn't have a specific translation |
| 18 | * for the string, fallback to the default translations. |
| 19 | * |
| 20 | * @param string $text |
| 21 | * Canonical message text (generally en_US). |
| 22 | * @param array $params |
| 23 | * @return string |
| 24 | * Translated text. |
| 25 | * @see ts |
| 26 | */ |
| 27 | public static function ts($text, $params = []) { |
| 28 | if (!array_key_exists('domain', $params)) { |
| 29 | $params['domain'] = [self::LONG_NAME, NULL]; |
| 30 | } |
| 31 | return ts($text, $params); |
| 32 | } |
| 33 | |
| 34 | /** |
| 35 | * Get the URL of a resource file (in this extension). |
| 36 | * |
| 37 | * @param string|NULL $file |
| 38 | * Ex: NULL. |
| 39 | * Ex: 'css/foo.css'. |
| 40 | * @return string |
| 41 | * Ex: 'http://example.org/sites/default/ext/org.example.foo'. |
| 42 | * Ex: 'http://example.org/sites/default/ext/org.example.foo/css/foo.css'. |
| 43 | */ |
| 44 | public static function url($file = NULL) { |
| 45 | if ($file === NULL) { |
| 46 | return rtrim(CRM_Core_Resources::singleton()->getUrl(self::LONG_NAME), '/'); |
| 47 | } |
| 48 | return CRM_Core_Resources::singleton()->getUrl(self::LONG_NAME, $file); |
| 49 | } |
| 50 | |
| 51 | /** |
| 52 | * Get the path of a resource file (in this extension). |
| 53 | * |
| 54 | * @param string|NULL $file |
| 55 | * Ex: NULL. |
| 56 | * Ex: 'css/foo.css'. |
| 57 | * @return string |
| 58 | * Ex: '/var/www/example.org/sites/default/ext/org.example.foo'. |
| 59 | * Ex: '/var/www/example.org/sites/default/ext/org.example.foo/css/foo.css'. |
| 60 | */ |
| 61 | public static function path($file = NULL) { |
| 62 | // return CRM_Core_Resources::singleton()->getPath(self::LONG_NAME, $file); |
| 63 | return __DIR__ . ($file === NULL ? '' : (DIRECTORY_SEPARATOR . $file)); |
| 64 | } |
| 65 | |
| 66 | /** |
| 67 | * Get the name of a class within this extension. |
| 68 | * |
| 69 | * @param string $suffix |
| 70 | * Ex: 'Page_HelloWorld' or 'Page\\HelloWorld'. |
| 71 | * @return string |
| 72 | * Ex: 'CRM_Foo_Page_HelloWorld'. |
| 73 | */ |
| 74 | public static function findClass($suffix) { |
| 75 | return self::CLASS_PREFIX . '_' . str_replace('\\', '_', $suffix); |
| 76 | } |
| 77 | |
| 78 | } |
| 79 | |
| 80 | use CRM_Contributioncancelactions_ExtensionUtil as E; |
| 81 | |
| 82 | /** |
| 83 | * (Delegated) Implements hook_civicrm_config(). |
| 84 | * |
| 85 | * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config |
| 86 | */ |
| 87 | function _contributioncancelactions_civix_civicrm_config(&$config = NULL) { |
| 88 | static $configured = FALSE; |
| 89 | if ($configured) { |
| 90 | return; |
| 91 | } |
| 92 | $configured = TRUE; |
| 93 | |
| 94 | $template =& CRM_Core_Smarty::singleton(); |
| 95 | |
| 96 | $extRoot = dirname(__FILE__) . DIRECTORY_SEPARATOR; |
| 97 | $extDir = $extRoot . 'templates'; |
| 98 | |
| 99 | if (is_array($template->template_dir)) { |
| 100 | array_unshift($template->template_dir, $extDir); |
| 101 | } |
| 102 | else { |
| 103 | $template->template_dir = [$extDir, $template->template_dir]; |
| 104 | } |
| 105 | |
| 106 | $include_path = $extRoot . PATH_SEPARATOR . get_include_path(); |
| 107 | set_include_path($include_path); |
| 108 | } |
| 109 | |
| 110 | /** |
| 111 | * (Delegated) Implements hook_civicrm_xmlMenu(). |
| 112 | * |
| 113 | * @param $files array(string) |
| 114 | * |
| 115 | * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_xmlMenu |
| 116 | */ |
| 117 | function _contributioncancelactions_civix_civicrm_xmlMenu(&$files) { |
| 118 | foreach (_contributioncancelactions_civix_glob(__DIR__ . '/xml/Menu/*.xml') as $file) { |
| 119 | $files[] = $file; |
| 120 | } |
| 121 | } |
| 122 | |
| 123 | /** |
| 124 | * Implements hook_civicrm_install(). |
| 125 | * |
| 126 | * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install |
| 127 | */ |
| 128 | function _contributioncancelactions_civix_civicrm_install() { |
| 129 | _contributioncancelactions_civix_civicrm_config(); |
| 130 | if ($upgrader = _contributioncancelactions_civix_upgrader()) { |
| 131 | $upgrader->onInstall(); |
| 132 | } |
| 133 | } |
| 134 | |
| 135 | /** |
| 136 | * Implements hook_civicrm_postInstall(). |
| 137 | * |
| 138 | * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_postInstall |
| 139 | */ |
| 140 | function _contributioncancelactions_civix_civicrm_postInstall() { |
| 141 | _contributioncancelactions_civix_civicrm_config(); |
| 142 | if ($upgrader = _contributioncancelactions_civix_upgrader()) { |
| 143 | if (is_callable([$upgrader, 'onPostInstall'])) { |
| 144 | $upgrader->onPostInstall(); |
| 145 | } |
| 146 | } |
| 147 | } |
| 148 | |
| 149 | /** |
| 150 | * Implements hook_civicrm_uninstall(). |
| 151 | * |
| 152 | * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_uninstall |
| 153 | */ |
| 154 | function _contributioncancelactions_civix_civicrm_uninstall() { |
| 155 | _contributioncancelactions_civix_civicrm_config(); |
| 156 | if ($upgrader = _contributioncancelactions_civix_upgrader()) { |
| 157 | $upgrader->onUninstall(); |
| 158 | } |
| 159 | } |
| 160 | |
| 161 | /** |
| 162 | * (Delegated) Implements hook_civicrm_enable(). |
| 163 | * |
| 164 | * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable |
| 165 | */ |
| 166 | function _contributioncancelactions_civix_civicrm_enable() { |
| 167 | _contributioncancelactions_civix_civicrm_config(); |
| 168 | if ($upgrader = _contributioncancelactions_civix_upgrader()) { |
| 169 | if (is_callable([$upgrader, 'onEnable'])) { |
| 170 | $upgrader->onEnable(); |
| 171 | } |
| 172 | } |
| 173 | } |
| 174 | |
| 175 | /** |
| 176 | * (Delegated) Implements hook_civicrm_disable(). |
| 177 | * |
| 178 | * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_disable |
| 179 | * @return mixed |
| 180 | */ |
| 181 | function _contributioncancelactions_civix_civicrm_disable() { |
| 182 | _contributioncancelactions_civix_civicrm_config(); |
| 183 | if ($upgrader = _contributioncancelactions_civix_upgrader()) { |
| 184 | if (is_callable([$upgrader, 'onDisable'])) { |
| 185 | $upgrader->onDisable(); |
| 186 | } |
| 187 | } |
| 188 | } |
| 189 | |
| 190 | /** |
| 191 | * (Delegated) Implements hook_civicrm_upgrade(). |
| 192 | * |
| 193 | * @param $op string, the type of operation being performed; 'check' or 'enqueue' |
| 194 | * @param $queue CRM_Queue_Queue, (for 'enqueue') the modifiable list of pending up upgrade tasks |
| 195 | * |
| 196 | * @return mixed |
| 197 | * based on op. for 'check', returns array(boolean) (TRUE if upgrades are pending) |
| 198 | * for 'enqueue', returns void |
| 199 | * |
| 200 | * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_upgrade |
| 201 | */ |
| 202 | function _contributioncancelactions_civix_civicrm_upgrade($op, CRM_Queue_Queue $queue = NULL) { |
| 203 | if ($upgrader = _contributioncancelactions_civix_upgrader()) { |
| 204 | return $upgrader->onUpgrade($op, $queue); |
| 205 | } |
| 206 | } |
| 207 | |
| 208 | /** |
| 209 | * @return CRM_Contributioncancelactions_Upgrader |
| 210 | */ |
| 211 | function _contributioncancelactions_civix_upgrader() { |
| 212 | if (!file_exists(__DIR__ . '/CRM/Contributioncancelactions/Upgrader.php')) { |
| 213 | return NULL; |
| 214 | } |
| 215 | else { |
| 216 | return CRM_Contributioncancelactions_Upgrader_Base::instance(); |
| 217 | } |
| 218 | } |
| 219 | |
| 220 | /** |
| 221 | * Search directory tree for files which match a glob pattern. |
| 222 | * |
| 223 | * Note: Dot-directories (like "..", ".git", or ".svn") will be ignored. |
| 224 | * Note: In Civi 4.3+, delegate to CRM_Utils_File::findFiles() |
| 225 | * |
| 226 | * @param string $dir base dir |
| 227 | * @param string $pattern , glob pattern, eg "*.txt" |
| 228 | * |
| 229 | * @return array |
| 230 | */ |
| 231 | function _contributioncancelactions_civix_find_files($dir, $pattern) { |
| 232 | if (is_callable(['CRM_Utils_File', 'findFiles'])) { |
| 233 | return CRM_Utils_File::findFiles($dir, $pattern); |
| 234 | } |
| 235 | |
| 236 | $todos = [$dir]; |
| 237 | $result = []; |
| 238 | while (!empty($todos)) { |
| 239 | $subdir = array_shift($todos); |
| 240 | foreach (_contributioncancelactions_civix_glob("$subdir/$pattern") as $match) { |
| 241 | if (!is_dir($match)) { |
| 242 | $result[] = $match; |
| 243 | } |
| 244 | } |
| 245 | if ($dh = opendir($subdir)) { |
| 246 | while (FALSE !== ($entry = readdir($dh))) { |
| 247 | $path = $subdir . DIRECTORY_SEPARATOR . $entry; |
| 248 | if ($entry[0] == '.') { |
| 249 | } |
| 250 | elseif (is_dir($path)) { |
| 251 | $todos[] = $path; |
| 252 | } |
| 253 | } |
| 254 | closedir($dh); |
| 255 | } |
| 256 | } |
| 257 | return $result; |
| 258 | } |
| 259 | |
| 260 | /** |
| 261 | * (Delegated) Implements hook_civicrm_managed(). |
| 262 | * |
| 263 | * Find any *.mgd.php files, merge their content, and return. |
| 264 | * |
| 265 | * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_managed |
| 266 | */ |
| 267 | function _contributioncancelactions_civix_civicrm_managed(&$entities) { |
| 268 | $mgdFiles = _contributioncancelactions_civix_find_files(__DIR__, '*.mgd.php'); |
| 269 | sort($mgdFiles); |
| 270 | foreach ($mgdFiles as $file) { |
| 271 | $es = include $file; |
| 272 | foreach ($es as $e) { |
| 273 | if (empty($e['module'])) { |
| 274 | $e['module'] = E::LONG_NAME; |
| 275 | } |
| 276 | if (empty($e['params']['version'])) { |
| 277 | $e['params']['version'] = '3'; |
| 278 | } |
| 279 | $entities[] = $e; |
| 280 | } |
| 281 | } |
| 282 | } |
| 283 | |
| 284 | /** |
| 285 | * (Delegated) Implements hook_civicrm_caseTypes(). |
| 286 | * |
| 287 | * Find any and return any files matching "xml/case/*.xml" |
| 288 | * |
| 289 | * Note: This hook only runs in CiviCRM 4.4+. |
| 290 | * |
| 291 | * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_caseTypes |
| 292 | */ |
| 293 | function _contributioncancelactions_civix_civicrm_caseTypes(&$caseTypes) { |
| 294 | if (!is_dir(__DIR__ . '/xml/case')) { |
| 295 | return; |
| 296 | } |
| 297 | |
| 298 | foreach (_contributioncancelactions_civix_glob(__DIR__ . '/xml/case/*.xml') as $file) { |
| 299 | $name = preg_replace('/\.xml$/', '', basename($file)); |
| 300 | if ($name != CRM_Case_XMLProcessor::mungeCaseType($name)) { |
| 301 | $errorMessage = sprintf("Case-type file name is malformed (%s vs %s)", $name, CRM_Case_XMLProcessor::mungeCaseType($name)); |
| 302 | throw new CRM_Core_Exception($errorMessage); |
| 303 | } |
| 304 | $caseTypes[$name] = [ |
| 305 | 'module' => E::LONG_NAME, |
| 306 | 'name' => $name, |
| 307 | 'file' => $file, |
| 308 | ]; |
| 309 | } |
| 310 | } |
| 311 | |
| 312 | /** |
| 313 | * (Delegated) Implements hook_civicrm_angularModules(). |
| 314 | * |
| 315 | * Find any and return any files matching "ang/*.ang.php" |
| 316 | * |
| 317 | * Note: This hook only runs in CiviCRM 4.5+. |
| 318 | * |
| 319 | * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_angularModules |
| 320 | */ |
| 321 | function _contributioncancelactions_civix_civicrm_angularModules(&$angularModules) { |
| 322 | if (!is_dir(__DIR__ . '/ang')) { |
| 323 | return; |
| 324 | } |
| 325 | |
| 326 | $files = _contributioncancelactions_civix_glob(__DIR__ . '/ang/*.ang.php'); |
| 327 | foreach ($files as $file) { |
| 328 | $name = preg_replace(':\.ang\.php$:', '', basename($file)); |
| 329 | $module = include $file; |
| 330 | if (empty($module['ext'])) { |
| 331 | $module['ext'] = E::LONG_NAME; |
| 332 | } |
| 333 | $angularModules[$name] = $module; |
| 334 | } |
| 335 | } |
| 336 | |
| 337 | /** |
| 338 | * (Delegated) Implements hook_civicrm_themes(). |
| 339 | * |
| 340 | * Find any and return any files matching "*.theme.php" |
| 341 | */ |
| 342 | function _contributioncancelactions_civix_civicrm_themes(&$themes) { |
| 343 | $files = _contributioncancelactions_civix_glob(__DIR__ . '/*.theme.php'); |
| 344 | foreach ($files as $file) { |
| 345 | $themeMeta = include $file; |
| 346 | if (empty($themeMeta['name'])) { |
| 347 | $themeMeta['name'] = preg_replace(':\.theme\.php$:', '', basename($file)); |
| 348 | } |
| 349 | if (empty($themeMeta['ext'])) { |
| 350 | $themeMeta['ext'] = E::LONG_NAME; |
| 351 | } |
| 352 | $themes[$themeMeta['name']] = $themeMeta; |
| 353 | } |
| 354 | } |
| 355 | |
| 356 | /** |
| 357 | * Glob wrapper which is guaranteed to return an array. |
| 358 | * |
| 359 | * The documentation for glob() says, "On some systems it is impossible to |
| 360 | * distinguish between empty match and an error." Anecdotally, the return |
| 361 | * result for an empty match is sometimes array() and sometimes FALSE. |
| 362 | * This wrapper provides consistency. |
| 363 | * |
| 364 | * @link http://php.net/glob |
| 365 | * @param string $pattern |
| 366 | * |
| 367 | * @return array |
| 368 | */ |
| 369 | function _contributioncancelactions_civix_glob($pattern) { |
| 370 | $result = glob($pattern); |
| 371 | return is_array($result) ? $result : []; |
| 372 | } |
| 373 | |
| 374 | /** |
| 375 | * Inserts a navigation menu item at a given place in the hierarchy. |
| 376 | * |
| 377 | * @param array $menu - menu hierarchy |
| 378 | * @param string $path - path to parent of this item, e.g. 'my_extension/submenu' |
| 379 | * 'Mailing', or 'Administer/System Settings' |
| 380 | * @param array $item - the item to insert (parent/child attributes will be |
| 381 | * filled for you) |
| 382 | * |
| 383 | * @return bool |
| 384 | */ |
| 385 | function _contributioncancelactions_civix_insert_navigation_menu(&$menu, $path, $item) { |
| 386 | // If we are done going down the path, insert menu |
| 387 | if (empty($path)) { |
| 388 | $menu[] = [ |
| 389 | 'attributes' => array_merge([ |
| 390 | 'label' => CRM_Utils_Array::value('name', $item), |
| 391 | 'active' => 1, |
| 392 | ], $item), |
| 393 | ]; |
| 394 | return TRUE; |
| 395 | } |
| 396 | else { |
| 397 | // Find an recurse into the next level down |
| 398 | $found = FALSE; |
| 399 | $path = explode('/', $path); |
| 400 | $first = array_shift($path); |
| 401 | foreach ($menu as $key => &$entry) { |
| 402 | if ($entry['attributes']['name'] == $first) { |
| 403 | if (!isset($entry['child'])) { |
| 404 | $entry['child'] = []; |
| 405 | } |
| 406 | $found = _contributioncancelactions_civix_insert_navigation_menu($entry['child'], implode('/', $path), $item); |
| 407 | } |
| 408 | } |
| 409 | return $found; |
| 410 | } |
| 411 | } |
| 412 | |
| 413 | /** |
| 414 | * (Delegated) Implements hook_civicrm_navigationMenu(). |
| 415 | */ |
| 416 | function _contributioncancelactions_civix_navigationMenu(&$nodes) { |
| 417 | if (!is_callable(['CRM_Core_BAO_Navigation', 'fixNavigationMenu'])) { |
| 418 | _contributioncancelactions_civix_fixNavigationMenu($nodes); |
| 419 | } |
| 420 | } |
| 421 | |
| 422 | /** |
| 423 | * Given a navigation menu, generate navIDs for any items which are |
| 424 | * missing them. |
| 425 | */ |
| 426 | function _contributioncancelactions_civix_fixNavigationMenu(&$nodes) { |
| 427 | $maxNavID = 1; |
| 428 | array_walk_recursive($nodes, function($item, $key) use (&$maxNavID) { |
| 429 | if ($key === 'navID') { |
| 430 | $maxNavID = max($maxNavID, $item); |
| 431 | } |
| 432 | }); |
| 433 | _contributioncancelactions_civix_fixNavigationMenuItems($nodes, $maxNavID, NULL); |
| 434 | } |
| 435 | |
| 436 | function _contributioncancelactions_civix_fixNavigationMenuItems(&$nodes, &$maxNavID, $parentID) { |
| 437 | $origKeys = array_keys($nodes); |
| 438 | foreach ($origKeys as $origKey) { |
| 439 | if (!isset($nodes[$origKey]['attributes']['parentID']) && $parentID !== NULL) { |
| 440 | $nodes[$origKey]['attributes']['parentID'] = $parentID; |
| 441 | } |
| 442 | // If no navID, then assign navID and fix key. |
| 443 | if (!isset($nodes[$origKey]['attributes']['navID'])) { |
| 444 | $newKey = ++$maxNavID; |
| 445 | $nodes[$origKey]['attributes']['navID'] = $newKey; |
| 446 | $nodes[$newKey] = $nodes[$origKey]; |
| 447 | unset($nodes[$origKey]); |
| 448 | $origKey = $newKey; |
| 449 | } |
| 450 | if (isset($nodes[$origKey]['child']) && is_array($nodes[$origKey]['child'])) { |
| 451 | _contributioncancelactions_civix_fixNavigationMenuItems($nodes[$origKey]['child'], $maxNavID, $nodes[$origKey]['attributes']['navID']); |
| 452 | } |
| 453 | } |
| 454 | } |
| 455 | |
| 456 | /** |
| 457 | * (Delegated) Implements hook_civicrm_entityTypes(). |
| 458 | * |
| 459 | * Find any *.entityType.php files, merge their content, and return. |
| 460 | * |
| 461 | * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_entityTypes |
| 462 | */ |
| 463 | function _contributioncancelactions_civix_civicrm_entityTypes(&$entityTypes) { |
| 464 | $entityTypes = array_merge($entityTypes, []); |
| 465 | } |