getUrl(self::LONG_NAME, $file); } /** * Get the path of a resource file (in this extension). * * @param string|NULL $file * Ex: 'css/foo.css'. * @return string * Ex: '/var/www/example.org/sites/default/ext/org.example.foo/css/foo.css'. */ public static function path($file = NULL) { // return CRM_Core_Resources::singleton()->getPath(self::LONG_NAME, $file); return __DIR__ . ($path === NULL ? '' : (DIRECTORY_SEPARATOR . $file)); } /** * Get the name of a class within this extension. * * @param string $suffix * Ex: 'Page_HelloWorld' or 'Page\\HelloWorld'. * @return string * Ex: 'CRM_Foo_Page_HelloWorld'. */ public static function findClass($suffix) { return self::CLASS_PREFIX . '_' . str_replace('\\', '_', $suffix); } } use CRM_ConstituentsOnly_ExtensionUtil as E; /** * (Delegated) Implements hook_civicrm_config(). * * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_config */ function _constituentsonly_civix_civicrm_config(&$config = NULL) { static $configured = FALSE; if ($configured) { return; } $configured = TRUE; $template =& CRM_Core_Smarty::singleton(); $extRoot = dirname(__FILE__) . DIRECTORY_SEPARATOR; $extDir = $extRoot . 'templates'; if (is_array($template->template_dir)) { array_unshift($template->template_dir, $extDir); } else { $template->template_dir = array($extDir, $template->template_dir); } $include_path = $extRoot . PATH_SEPARATOR . get_include_path(); set_include_path($include_path); } /** * (Delegated) Implements hook_civicrm_xmlMenu(). * * @param $files array(string) * * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_xmlMenu */ function _constituentsonly_civix_civicrm_xmlMenu(&$files) { foreach (_constituentsonly_civix_glob(__DIR__ . '/xml/Menu/*.xml') as $file) { $files[] = $file; } } /** * Implements hook_civicrm_install(). * * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_install */ function _constituentsonly_civix_civicrm_install() { _constituentsonly_civix_civicrm_config(); if ($upgrader = _constituentsonly_civix_upgrader()) { $upgrader->onInstall(); } } /** * Implements hook_civicrm_postInstall(). * * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_postInstall */ function _constituentsonly_civix_civicrm_postInstall() { _constituentsonly_civix_civicrm_config(); if ($upgrader = _constituentsonly_civix_upgrader()) { if (is_callable(array($upgrader, 'onPostInstall'))) { $upgrader->onPostInstall(); } } } /** * Implements hook_civicrm_uninstall(). * * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_uninstall */ function _constituentsonly_civix_civicrm_uninstall() { _constituentsonly_civix_civicrm_config(); if ($upgrader = _constituentsonly_civix_upgrader()) { $upgrader->onUninstall(); } } /** * (Delegated) Implements hook_civicrm_enable(). * * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_enable */ function _constituentsonly_civix_civicrm_enable() { _constituentsonly_civix_civicrm_config(); if ($upgrader = _constituentsonly_civix_upgrader()) { if (is_callable(array($upgrader, 'onEnable'))) { $upgrader->onEnable(); } } } /** * (Delegated) Implements hook_civicrm_disable(). * * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_disable * @return mixed */ function _constituentsonly_civix_civicrm_disable() { _constituentsonly_civix_civicrm_config(); if ($upgrader = _constituentsonly_civix_upgrader()) { if (is_callable(array($upgrader, 'onDisable'))) { $upgrader->onDisable(); } } } /** * (Delegated) Implements hook_civicrm_upgrade(). * * @param $op string, the type of operation being performed; 'check' or 'enqueue' * @param $queue CRM_Queue_Queue, (for 'enqueue') the modifiable list of pending up upgrade tasks * * @return mixed based on op. for 'check', returns array(boolean) (TRUE if upgrades are pending) * for 'enqueue', returns void * * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_upgrade */ function _constituentsonly_civix_civicrm_upgrade($op, CRM_Queue_Queue $queue = NULL) { if ($upgrader = _constituentsonly_civix_upgrader()) { return $upgrader->onUpgrade($op, $queue); } } /** * @return CRM_ConstituentsOnly_Upgrader */ function _constituentsonly_civix_upgrader() { if (!file_exists(__DIR__ . '/CRM/Excludefromsearch/Upgrader.php')) { return NULL; } else { return CRM_ConstituentsOnly_Upgrader_Base::instance(); } } /** * Search directory tree for files which match a glob pattern * * Note: Dot-directories (like "..", ".git", or ".svn") will be ignored. * Note: In Civi 4.3+, delegate to CRM_Utils_File::findFiles() * * @param $dir string, base dir * @param $pattern string, glob pattern, eg "*.txt" * @return array(string) */ function _constituentsonly_civix_find_files($dir, $pattern) { if (is_callable(array('CRM_Utils_File', 'findFiles'))) { return CRM_Utils_File::findFiles($dir, $pattern); } $todos = array($dir); $result = array(); while (!empty($todos)) { $subdir = array_shift($todos); foreach (_constituentsonly_civix_glob("$subdir/$pattern") as $match) { if (!is_dir($match)) { $result[] = $match; } } if ($dh = opendir($subdir)) { while (FALSE !== ($entry = readdir($dh))) { $path = $subdir . DIRECTORY_SEPARATOR . $entry; if ($entry{0} == '.') { } elseif (is_dir($path)) { $todos[] = $path; } } closedir($dh); } } return $result; } /** * (Delegated) Implements hook_civicrm_managed(). * * Find any *.mgd.php files, merge their content, and return. * * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_managed */ function _constituentsonly_civix_civicrm_managed(&$entities) { $mgdFiles = _constituentsonly_civix_find_files(__DIR__, '*.mgd.php'); foreach ($mgdFiles as $file) { $es = include $file; foreach ($es as $e) { if (empty($e['module'])) { $e['module'] = E::LONG_NAME; } $entities[] = $e; if (empty($e['params']['version'])) { $e['params']['version'] = '3'; } } } } /** * (Delegated) Implements hook_civicrm_caseTypes(). * * Find any and return any files matching "xml/case/*.xml" * * Note: This hook only runs in CiviCRM 4.4+. * * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_caseTypes */ function _constituentsonly_civix_civicrm_caseTypes(&$caseTypes) { if (!is_dir(__DIR__ . '/xml/case')) { return; } foreach (_constituentsonly_civix_glob(__DIR__ . '/xml/case/*.xml') as $file) { $name = preg_replace('/\.xml$/', '', basename($file)); if ($name != CRM_Case_XMLProcessor::mungeCaseType($name)) { $errorMessage = sprintf("Case-type file name is malformed (%s vs %s)", $name, CRM_Case_XMLProcessor::mungeCaseType($name)); CRM_Core_Error::fatal($errorMessage); // throw new CRM_Core_Exception($errorMessage); } $caseTypes[$name] = array( 'module' => E::LONG_NAME, 'name' => $name, 'file' => $file, ); } } /** * (Delegated) Implements hook_civicrm_angularModules(). * * Find any and return any files matching "ang/*.ang.php" * * Note: This hook only runs in CiviCRM 4.5+. * * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_angularModules */ function _constituentsonly_civix_civicrm_angularModules(&$angularModules) { if (!is_dir(__DIR__ . '/ang')) { return; } $files = _constituentsonly_civix_glob(__DIR__ . '/ang/*.ang.php'); foreach ($files as $file) { $name = preg_replace(':\.ang\.php$:', '', basename($file)); $module = include $file; if (empty($module['ext'])) { $module['ext'] = E::LONG_NAME; } $angularModules[$name] = $module; } } /** * Glob wrapper which is guaranteed to return an array. * * The documentation for glob() says, "On some systems it is impossible to * distinguish between empty match and an error." Anecdotally, the return * result for an empty match is sometimes array() and sometimes FALSE. * This wrapper provides consistency. * * @link http://php.net/glob * @param string $pattern * @return array, possibly empty */ function _constituentsonly_civix_glob($pattern) { $result = glob($pattern); return is_array($result) ? $result : array(); } /** * Inserts a navigation menu item at a given place in the hierarchy. * * @param array $menu - menu hierarchy * @param string $path - path where insertion should happen (ie. Administer/System Settings) * @param array $item - menu you need to insert (parent/child attributes will be filled for you) */ function _constituentsonly_civix_insert_navigation_menu(&$menu, $path, $item) { // If we are done going down the path, insert menu if (empty($path)) { $menu[] = array( 'attributes' => array_merge(array( 'label' => CRM_Utils_Array::value('name', $item), 'active' => 1, ), $item), ); return TRUE; } else { // Find an recurse into the next level down $found = FALSE; $path = explode('/', $path); $first = array_shift($path); foreach ($menu as $key => &$entry) { if ($entry['attributes']['name'] == $first) { if (!isset($entry['child'])) { $entry['child'] = array(); } $found = _constituentsonly_civix_insert_navigation_menu($entry['child'], implode('/', $path), $item, $key); } } return $found; } } /** * (Delegated) Implements hook_civicrm_navigationMenu(). */ function _constituentsonly_civix_navigationMenu(&$nodes) { if (!is_callable(array('CRM_Core_BAO_Navigation', 'fixNavigationMenu'))) { _constituentsonly_civix_fixNavigationMenu($nodes); } } /** * Given a navigation menu, generate navIDs for any items which are * missing them. */ function _constituentsonly_civix_fixNavigationMenu(&$nodes) { $maxNavID = 1; array_walk_recursive($nodes, function($item, $key) use (&$maxNavID) { if ($key === 'navID') { $maxNavID = max($maxNavID, $item); } }); _constituentsonly_civix_fixNavigationMenuItems($nodes, $maxNavID, NULL); } function _constituentsonly_civix_fixNavigationMenuItems(&$nodes, &$maxNavID, $parentID) { $origKeys = array_keys($nodes); foreach ($origKeys as $origKey) { if (!isset($nodes[$origKey]['attributes']['parentID']) && $parentID !== NULL) { $nodes[$origKey]['attributes']['parentID'] = $parentID; } // If no navID, then assign navID and fix key. if (!isset($nodes[$origKey]['attributes']['navID'])) { $newKey = ++$maxNavID; $nodes[$origKey]['attributes']['navID'] = $newKey; $nodes[$newKey] = $nodes[$origKey]; unset($nodes[$origKey]); $origKey = $newKey; } if (isset($nodes[$origKey]['child']) && is_array($nodes[$origKey]['child'])) { _constituentsonly_civix_fixNavigationMenuItems($nodes[$origKey]['child'], $maxNavID, $nodes[$origKey]['attributes']['navID']); } } } /** * (Delegated) Implements hook_civicrm_alterSettingsFolders(). * * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_alterSettingsFolders */ function _constituentsonly_civix_civicrm_alterSettingsFolders(&$metaDataFolders = NULL) { static $configured = FALSE; if ($configured) { return; } $configured = TRUE; $settingsDir = __DIR__ . DIRECTORY_SEPARATOR . 'settings'; if (is_dir($settingsDir) && !in_array($settingsDir, $metaDataFolders)) { $metaDataFolders[] = $settingsDir; } }