ext/sequentialcreditnotes/sequentialcreditnotes.civix.php

   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_Sequentialcreditnotes_ExtensionUtil {
  10   const SHORT_NAME = "sequentialcreditnotes";
  11   const LONG_NAME = "sequentialcreditnotes";
  12   const CLASS_PREFIX = "CRM_Sequentialcreditnotes";
  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_Sequentialcreditnotes_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 _sequentialcreditnotes_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 = __DIR__ . 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  * Implements hook_civicrm_install().
 112  *
 113  * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install
 114  */
 115 function _sequentialcreditnotes_civix_civicrm_install() {
 116   _sequentialcreditnotes_civix_civicrm_config();
 117   if ($upgrader = _sequentialcreditnotes_civix_upgrader()) {
 118     $upgrader->onInstall();
 119   }
 120 }
 121
 122 /**
 123  * Implements hook_civicrm_postInstall().
 124  *
 125  * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_postInstall
 126  */
 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();
 132     }
 133   }
 134 }
 135
 136 /**
 137  * Implements hook_civicrm_uninstall().
 138  *
 139  * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_uninstall
 140  */
 141 function _sequentialcreditnotes_civix_civicrm_uninstall() {
 142   _sequentialcreditnotes_civix_civicrm_config();
 143   if ($upgrader = _sequentialcreditnotes_civix_upgrader()) {
 144     $upgrader->onUninstall();
 145   }
 146 }
 147
 148 /**
 149  * (Delegated) Implements hook_civicrm_enable().
 150  *
 151  * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable
 152  */
 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();
 158     }
 159   }
 160 }
 161
 162 /**
 163  * (Delegated) Implements hook_civicrm_disable().
 164  *
 165  * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_disable
 166  * @return mixed
 167  */
 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();
 173     }
 174   }
 175 }
 176
 177 /**
 178  * (Delegated) Implements hook_civicrm_upgrade().
 179  *
 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
 182  *
 183  * @return mixed
 184  *   based on op. for 'check', returns array(boolean) (TRUE if upgrades are pending) for 'enqueue', returns void
 185  *
 186  * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_upgrade
 187  */
 188 function _sequentialcreditnotes_civix_civicrm_upgrade($op, CRM_Queue_Queue $queue = NULL) {
 189   if ($upgrader = _sequentialcreditnotes_civix_upgrader()) {
 190     return $upgrader->onUpgrade($op, $queue);
 191   }
 192 }
 193
 194 /**
 195  * @return CRM_Sequentialcreditnotes_Upgrader
 196  */
 197 function _sequentialcreditnotes_civix_upgrader() {
 198   if (!file_exists(__DIR__ . '/CRM/Sequentialcreditnotes/Upgrader.php')) {
 199     return NULL;
 200   }
 201   else {
 202     return CRM_Sequentialcreditnotes_Upgrader_Base::instance();
 203   }
 204 }
 205
 206 /**
 207  * Inserts a navigation menu item at a given place in the hierarchy.
 208  *
 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
 213  *    filled for you)
 214  *
 215  * @return bool
 216  */
 217 function _sequentialcreditnotes_civix_insert_navigation_menu(&$menu, $path, $item) {
 218   // If we are done going down the path, insert menu
 219   if (empty($path)) {
 220     $menu[] = [
 221       'attributes' => array_merge([
 222         'label'      => $item['name'] ?? NULL,
 223         'active'     => 1,
 224       ], $item),
 225     ];
 226     return TRUE;
 227   }
 228   else {
 229     // Find an recurse into the next level down
 230     $found = FALSE;
 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'] = [];
 237         }
 238         $found = _sequentialcreditnotes_civix_insert_navigation_menu($entry['child'], implode('/', $path), $item);
 239       }
 240     }
 241     return $found;
 242   }
 243 }
 244
 245 /**
 246  * (Delegated) Implements hook_civicrm_navigationMenu().
 247  */
 248 function _sequentialcreditnotes_civix_navigationMenu(&$nodes) {
 249   if (!is_callable(['CRM_Core_BAO_Navigation', 'fixNavigationMenu'])) {
 250     _sequentialcreditnotes_civix_fixNavigationMenu($nodes);
 251   }
 252 }
 253
 254 /**
 255  * Given a navigation menu, generate navIDs for any items which are
 256  * missing them.
 257  */
 258 function _sequentialcreditnotes_civix_fixNavigationMenu(&$nodes) {
 259   $maxNavID = 1;
 260   array_walk_recursive($nodes, function($item, $key) use (&$maxNavID) {
 261     if ($key === 'navID') {
 262       $maxNavID = max($maxNavID, $item);
 263     }
 264   });
 265   _sequentialcreditnotes_civix_fixNavigationMenuItems($nodes, $maxNavID, NULL);
 266 }
 267
 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;
 273     }
 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]);
 280       $origKey = $newKey;
 281     }
 282     if (isset($nodes[$origKey]['child']) && is_array($nodes[$origKey]['child'])) {
 283       _sequentialcreditnotes_civix_fixNavigationMenuItems($nodes[$origKey]['child'], $maxNavID, $nodes[$origKey]['attributes']['navID']);
 284     }
 285   }
 286 }
 287
 288 /**
 289  * (Delegated) Implements hook_civicrm_entityTypes().
 290  *
 291  * Find any *.entityType.php files, merge their content, and return.
 292  *
 293  * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_entityTypes
 294  */
 295 function _sequentialcreditnotes_civix_civicrm_entityTypes(&$entityTypes) {
 296   $entityTypes = array_merge($entityTypes, []);
 297 }