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 = __DIR__
. 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 * Implements hook_civicrm_install().
113 * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install
115 function _sequentialcreditnotes_civix_civicrm_install() {
116 _sequentialcreditnotes_civix_civicrm_config();
117 if ($upgrader = _sequentialcreditnotes_civix_upgrader()) {
118 $upgrader->onInstall();
123 * Implements hook_civicrm_postInstall().
125 * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_postInstall
127 function _sequentialcreditnotes_civix_civicrm_postInstall() {
128 _sequentialcreditnotes_civix_civicrm_config();
129 if ($upgrader = _sequentialcreditnotes_civix_upgrader()) {
130 if (is_callable([$upgrader, 'onPostInstall'])) {
131 $upgrader->onPostInstall();
137 * Implements hook_civicrm_uninstall().
139 * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_uninstall
141 function _sequentialcreditnotes_civix_civicrm_uninstall() {
142 _sequentialcreditnotes_civix_civicrm_config();
143 if ($upgrader = _sequentialcreditnotes_civix_upgrader()) {
144 $upgrader->onUninstall();
149 * (Delegated) Implements hook_civicrm_enable().
151 * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable
153 function _sequentialcreditnotes_civix_civicrm_enable() {
154 _sequentialcreditnotes_civix_civicrm_config();
155 if ($upgrader = _sequentialcreditnotes_civix_upgrader()) {
156 if (is_callable([$upgrader, 'onEnable'])) {
157 $upgrader->onEnable();
163 * (Delegated) Implements hook_civicrm_disable().
165 * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_disable
168 function _sequentialcreditnotes_civix_civicrm_disable() {
169 _sequentialcreditnotes_civix_civicrm_config();
170 if ($upgrader = _sequentialcreditnotes_civix_upgrader()) {
171 if (is_callable([$upgrader, 'onDisable'])) {
172 $upgrader->onDisable();
178 * (Delegated) Implements hook_civicrm_upgrade().
180 * @param $op string, the type of operation being performed; 'check' or 'enqueue'
181 * @param $queue CRM_Queue_Queue, (for 'enqueue') the modifiable list of pending up upgrade tasks
184 * based on op. for 'check', returns array(boolean) (TRUE if upgrades are pending) for 'enqueue', returns void
186 * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_upgrade
188 function _sequentialcreditnotes_civix_civicrm_upgrade($op, CRM_Queue_Queue
$queue = NULL) {
189 if ($upgrader = _sequentialcreditnotes_civix_upgrader()) {
190 return $upgrader->onUpgrade($op, $queue);
195 * @return CRM_Sequentialcreditnotes_Upgrader
197 function _sequentialcreditnotes_civix_upgrader() {
198 if (!file_exists(__DIR__
. '/CRM/Sequentialcreditnotes/Upgrader.php')) {
202 return CRM_Sequentialcreditnotes_Upgrader_Base
::instance();
207 * Inserts a navigation menu item at a given place in the hierarchy.
209 * @param array $menu - menu hierarchy
210 * @param string $path - path to parent of this item, e.g. 'my_extension/submenu'
211 * 'Mailing', or 'Administer/System Settings'
212 * @param array $item - the item to insert (parent/child attributes will be
217 function _sequentialcreditnotes_civix_insert_navigation_menu(&$menu, $path, $item) {
218 // If we are done going down the path, insert menu
221 'attributes' => array_merge([
222 'label' => $item['name'] ??
NULL,
229 // Find an recurse into the next level down
231 $path = explode('/', $path);
232 $first = array_shift($path);
233 foreach ($menu as $key => &$entry) {
234 if ($entry['attributes']['name'] == $first) {
235 if (!isset($entry['child'])) {
236 $entry['child'] = [];
238 $found = _sequentialcreditnotes_civix_insert_navigation_menu($entry['child'], implode('/', $path), $item);
246 * (Delegated) Implements hook_civicrm_navigationMenu().
248 function _sequentialcreditnotes_civix_navigationMenu(&$nodes) {
249 if (!is_callable(['CRM_Core_BAO_Navigation', 'fixNavigationMenu'])) {
250 _sequentialcreditnotes_civix_fixNavigationMenu($nodes);
255 * Given a navigation menu, generate navIDs for any items which are
258 function _sequentialcreditnotes_civix_fixNavigationMenu(&$nodes) {
260 array_walk_recursive($nodes, function($item, $key) use (&$maxNavID) {
261 if ($key === 'navID') {
262 $maxNavID = max($maxNavID, $item);
265 _sequentialcreditnotes_civix_fixNavigationMenuItems($nodes, $maxNavID, NULL);
268 function _sequentialcreditnotes_civix_fixNavigationMenuItems(&$nodes, &$maxNavID, $parentID) {
269 $origKeys = array_keys($nodes);
270 foreach ($origKeys as $origKey) {
271 if (!isset($nodes[$origKey]['attributes']['parentID']) && $parentID !== NULL) {
272 $nodes[$origKey]['attributes']['parentID'] = $parentID;
274 // If no navID, then assign navID and fix key.
275 if (!isset($nodes[$origKey]['attributes']['navID'])) {
276 $newKey = ++
$maxNavID;
277 $nodes[$origKey]['attributes']['navID'] = $newKey;
278 $nodes[$newKey] = $nodes[$origKey];
279 unset($nodes[$origKey]);
282 if (isset($nodes[$origKey]['child']) && is_array($nodes[$origKey]['child'])) {
283 _sequentialcreditnotes_civix_fixNavigationMenuItems($nodes[$origKey]['child'], $maxNavID, $nodes[$origKey]['attributes']['navID']);
289 * (Delegated) Implements hook_civicrm_entityTypes().
291 * Find any *.entityType.php files, merge their content, and return.
293 * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_entityTypes
295 function _sequentialcreditnotes_civix_civicrm_entityTypes(&$entityTypes) {
296 $entityTypes = array_merge($entityTypes, []);