3 // AUTO-GENERATED FILE -- Civix may overwrite any changes made to this file
6 * The ExtensionUtil class provides small stubs for accessing resources of this
9 class CRM_Sequentialcreditnotes_ExtensionUtil
{
10 const SHORT_NAME
= "sequentialcreditnotes";
11 const LONG_NAME
= "sequentialcreditnotes";
12 const CLASS_PREFIX
= "CRM_Sequentialcreditnotes";
15 * Translate a string using the extension's domain.
17 * If the extension doesn't have a specific translation
18 * for the string, fallback to the default translations.
21 * Canonical message text (generally en_US).
22 * @param array $params
27 public static function ts($text, $params = []) {
28 if (!array_key_exists('domain', $params)) {
29 $params['domain'] = [self
::LONG_NAME
, NULL];
31 return ts($text, $params);
35 * Get the URL of a resource file (in this extension).
37 * @param string|NULL $file
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'.
44 public static function url($file = NULL) {
46 return rtrim(CRM_Core_Resources
::singleton()->getUrl(self
::LONG_NAME
), '/');
48 return CRM_Core_Resources
::singleton()->getUrl(self
::LONG_NAME
, $file);
52 * Get the path of a resource file (in this extension).
54 * @param string|NULL $file
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'.
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));
67 * Get the name of a class within this extension.
69 * @param string $suffix
70 * Ex: 'Page_HelloWorld' or 'Page\\HelloWorld'.
72 * Ex: 'CRM_Foo_Page_HelloWorld'.
74 public static function findClass($suffix) {
75 return self
::CLASS_PREFIX
. '_' . str_replace('\\', '_', $suffix);
80 use CRM_Sequentialcreditnotes_ExtensionUtil
as E
;
83 * (Delegated) Implements hook_civicrm_config().
85 * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config
87 function _sequentialcreditnotes_civix_civicrm_config(&$config = NULL) {
88 static $configured = FALSE;
94 $template =& CRM_Core_Smarty
::singleton();
96 $extRoot = dirname(__FILE__
) . DIRECTORY_SEPARATOR
;
97 $extDir = $extRoot . 'templates';
99 if (is_array($template->template_dir
)) {
100 array_unshift($template->template_dir
, $extDir);
103 $template->template_dir
= [$extDir, $template->template_dir
];
106 $include_path = $extRoot . PATH_SEPARATOR
. get_include_path();
107 set_include_path($include_path);
111 * (Delegated) Implements hook_civicrm_xmlMenu().
113 * @param $files array(string)
115 * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_xmlMenu
117 function _sequentialcreditnotes_civix_civicrm_xmlMenu(&$files) {
118 foreach (_sequentialcreditnotes_civix_glob(__DIR__
. '/xml/Menu/*.xml') as $file) {
124 * Implements hook_civicrm_install().
126 * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install
128 function _sequentialcreditnotes_civix_civicrm_install() {
129 _sequentialcreditnotes_civix_civicrm_config();
130 if ($upgrader = _sequentialcreditnotes_civix_upgrader()) {
131 $upgrader->onInstall();
136 * Implements hook_civicrm_postInstall().
138 * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_postInstall
140 function _sequentialcreditnotes_civix_civicrm_postInstall() {
141 _sequentialcreditnotes_civix_civicrm_config();
142 if ($upgrader = _sequentialcreditnotes_civix_upgrader()) {
143 if (is_callable([$upgrader, 'onPostInstall'])) {
144 $upgrader->onPostInstall();
150 * Implements hook_civicrm_uninstall().
152 * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_uninstall
154 function _sequentialcreditnotes_civix_civicrm_uninstall() {
155 _sequentialcreditnotes_civix_civicrm_config();
156 if ($upgrader = _sequentialcreditnotes_civix_upgrader()) {
157 $upgrader->onUninstall();
162 * (Delegated) Implements hook_civicrm_enable().
164 * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable
166 function _sequentialcreditnotes_civix_civicrm_enable() {
167 _sequentialcreditnotes_civix_civicrm_config();
168 if ($upgrader = _sequentialcreditnotes_civix_upgrader()) {
169 if (is_callable([$upgrader, 'onEnable'])) {
170 $upgrader->onEnable();
176 * (Delegated) Implements hook_civicrm_disable().
178 * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_disable
181 function _sequentialcreditnotes_civix_civicrm_disable() {
182 _sequentialcreditnotes_civix_civicrm_config();
183 if ($upgrader = _sequentialcreditnotes_civix_upgrader()) {
184 if (is_callable([$upgrader, 'onDisable'])) {
185 $upgrader->onDisable();
191 * (Delegated) Implements hook_civicrm_upgrade().
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
197 * based on op. for 'check', returns array(boolean) (TRUE if upgrades are pending) for 'enqueue', returns void
199 * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_upgrade
201 function _sequentialcreditnotes_civix_civicrm_upgrade($op, CRM_Queue_Queue
$queue = NULL) {
202 if ($upgrader = _sequentialcreditnotes_civix_upgrader()) {
203 return $upgrader->onUpgrade($op, $queue);
208 * @return CRM_Sequentialcreditnotes_Upgrader
210 function _sequentialcreditnotes_civix_upgrader() {
211 if (!file_exists(__DIR__
. '/CRM/Sequentialcreditnotes/Upgrader.php')) {
215 return CRM_Sequentialcreditnotes_Upgrader_Base
::instance();
220 * Search directory tree for files which match a glob pattern.
222 * Note: Dot-directories (like "..", ".git", or ".svn") will be ignored.
223 * Note: In Civi 4.3+, delegate to CRM_Utils_File::findFiles()
225 * @param string $dir base dir
226 * @param string $pattern , glob pattern, eg "*.txt"
228 * @return array(string)
230 function _sequentialcreditnotes_civix_find_files($dir, $pattern) {
231 if (is_callable(['CRM_Utils_File', 'findFiles'])) {
232 return CRM_Utils_File
::findFiles($dir, $pattern);
237 while (!empty($todos)) {
238 $subdir = array_shift($todos);
239 foreach (_sequentialcreditnotes_civix_glob("$subdir/$pattern") as $match) {
240 if (!is_dir($match)) {
244 if ($dh = opendir($subdir)) {
245 while (FALSE !== ($entry = readdir($dh))) {
246 $path = $subdir . DIRECTORY_SEPARATOR
. $entry;
247 if ($entry[0] == '.') {
249 elseif (is_dir($path)) {
260 * (Delegated) Implements hook_civicrm_managed().
262 * Find any *.mgd.php files, merge their content, and return.
264 * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_managed
266 function _sequentialcreditnotes_civix_civicrm_managed(&$entities) {
267 $mgdFiles = _sequentialcreditnotes_civix_find_files(__DIR__
, '*.mgd.php');
269 foreach ($mgdFiles as $file) {
271 foreach ($es as $e) {
272 if (empty($e['module'])) {
273 $e['module'] = E
::LONG_NAME
;
275 if (empty($e['params']['version'])) {
276 $e['params']['version'] = '3';
284 * (Delegated) Implements hook_civicrm_caseTypes().
286 * Find any and return any files matching "xml/case/*.xml"
288 * Note: This hook only runs in CiviCRM 4.4+.
290 * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_caseTypes
292 function _sequentialcreditnotes_civix_civicrm_caseTypes(&$caseTypes) {
293 if (!is_dir(__DIR__
. '/xml/case')) {
297 foreach (_sequentialcreditnotes_civix_glob(__DIR__
. '/xml/case/*.xml') as $file) {
298 $name = preg_replace('/\.xml$/', '', basename($file));
299 if ($name != CRM_Case_XMLProcessor
::mungeCaseType($name)) {
300 $errorMessage = sprintf("Case-type file name is malformed (%s vs %s)", $name, CRM_Case_XMLProcessor
::mungeCaseType($name));
301 throw new CRM_Core_Exception($errorMessage);
303 $caseTypes[$name] = [
304 'module' => E
::LONG_NAME
,
312 * (Delegated) Implements hook_civicrm_angularModules().
314 * Find any and return any files matching "ang/*.ang.php"
316 * Note: This hook only runs in CiviCRM 4.5+.
318 * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_angularModules
320 function _sequentialcreditnotes_civix_civicrm_angularModules(&$angularModules) {
321 if (!is_dir(__DIR__
. '/ang')) {
325 $files = _sequentialcreditnotes_civix_glob(__DIR__
. '/ang/*.ang.php');
326 foreach ($files as $file) {
327 $name = preg_replace(':\.ang\.php$:', '', basename($file));
328 $module = include $file;
329 if (empty($module['ext'])) {
330 $module['ext'] = E
::LONG_NAME
;
332 $angularModules[$name] = $module;
337 * (Delegated) Implements hook_civicrm_themes().
339 * Find any and return any files matching "*.theme.php"
341 function _sequentialcreditnotes_civix_civicrm_themes(&$themes) {
342 $files = _sequentialcreditnotes_civix_glob(__DIR__
. '/*.theme.php');
343 foreach ($files as $file) {
344 $themeMeta = include $file;
345 if (empty($themeMeta['name'])) {
346 $themeMeta['name'] = preg_replace(':\.theme\.php$:', '', basename($file));
348 if (empty($themeMeta['ext'])) {
349 $themeMeta['ext'] = E
::LONG_NAME
;
351 $themes[$themeMeta['name']] = $themeMeta;
356 * Glob wrapper which is guaranteed to return an array.
358 * The documentation for glob() says, "On some systems it is impossible to
359 * distinguish between empty match and an error." Anecdotally, the return
360 * result for an empty match is sometimes array() and sometimes FALSE.
361 * This wrapper provides consistency.
363 * @link http://php.net/glob
364 * @param string $pattern
366 * @return array, possibly empty
368 function _sequentialcreditnotes_civix_glob($pattern) {
369 $result = glob($pattern);
370 return is_array($result) ?
$result : [];
374 * Inserts a navigation menu item at a given place in the hierarchy.
376 * @param array $menu - menu hierarchy
377 * @param string $path - path to parent of this item, e.g. 'my_extension/submenu'
378 * 'Mailing', or 'Administer/System Settings'
379 * @param array $item - the item to insert (parent/child attributes will be
384 function _sequentialcreditnotes_civix_insert_navigation_menu(&$menu, $path, $item) {
385 // If we are done going down the path, insert menu
388 'attributes' => array_merge([
389 'label' => $item['name'] ??
NULL,
396 // Find an recurse into the next level down
398 $path = explode('/', $path);
399 $first = array_shift($path);
400 foreach ($menu as $key => &$entry) {
401 if ($entry['attributes']['name'] == $first) {
402 if (!isset($entry['child'])) {
403 $entry['child'] = [];
405 $found = _sequentialcreditnotes_civix_insert_navigation_menu($entry['child'], implode('/', $path), $item);
413 * (Delegated) Implements hook_civicrm_navigationMenu().
415 function _sequentialcreditnotes_civix_navigationMenu(&$nodes) {
416 if (!is_callable(['CRM_Core_BAO_Navigation', 'fixNavigationMenu'])) {
417 _sequentialcreditnotes_civix_fixNavigationMenu($nodes);
422 * Given a navigation menu, generate navIDs for any items which are
425 function _sequentialcreditnotes_civix_fixNavigationMenu(&$nodes) {
427 array_walk_recursive($nodes, function($item, $key) use (&$maxNavID) {
428 if ($key === 'navID') {
429 $maxNavID = max($maxNavID, $item);
432 _sequentialcreditnotes_civix_fixNavigationMenuItems($nodes, $maxNavID, NULL);
435 function _sequentialcreditnotes_civix_fixNavigationMenuItems(&$nodes, &$maxNavID, $parentID) {
436 $origKeys = array_keys($nodes);
437 foreach ($origKeys as $origKey) {
438 if (!isset($nodes[$origKey]['attributes']['parentID']) && $parentID !== NULL) {
439 $nodes[$origKey]['attributes']['parentID'] = $parentID;
441 // If no navID, then assign navID and fix key.
442 if (!isset($nodes[$origKey]['attributes']['navID'])) {
443 $newKey = ++
$maxNavID;
444 $nodes[$origKey]['attributes']['navID'] = $newKey;
445 $nodes[$newKey] = $nodes[$origKey];
446 unset($nodes[$origKey]);
449 if (isset($nodes[$origKey]['child']) && is_array($nodes[$origKey]['child'])) {
450 _sequentialcreditnotes_civix_fixNavigationMenuItems($nodes[$origKey]['child'], $maxNavID, $nodes[$origKey]['attributes']['navID']);
456 * (Delegated) Implements hook_civicrm_alterSettingsFolders().
458 * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_alterSettingsFolders
460 function _sequentialcreditnotes_civix_civicrm_alterSettingsFolders(&$metaDataFolders = NULL) {
461 $settingsDir = __DIR__
. DIRECTORY_SEPARATOR
;
462 if (!in_array($settingsDir, $metaDataFolders) && is_dir($settingsDir)) {
463 $metaDataFolders[] = $settingsDir;
468 * (Delegated) Implements hook_civicrm_entityTypes().
470 * Find any *.entityType.php files, merge their content, and return.
472 * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_entityTypes
474 function _sequentialcreditnotes_civix_civicrm_entityTypes(&$entityTypes) {
475 $entityTypes = array_merge($entityTypes, []);