Skip to content
Snippets Groups Projects
Commit 7b64a779 authored by ayduns's avatar ayduns
Browse files

Update civix file and doc links

parent 32a7f1e7
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
README.md
+ 1
− 1
View file @ 7b64a779
......@@ -14,7 +14,7 @@ This extension limits the assignees of any activity to a specified group (static
Normally the assignee field is blank when adding an Activity. If the main use of activities is to record people's own actions then always needing to add oneself as the assignee is repetitive.
This option allows the current user to be as the default assignees.
This option allows the current user to be set as the default assignee.
### How do I get set up? ###
......
assignee.civix.php
+ 160
− 34
View file @ 7b64a779
......@@ -2,10 +2,87 @@
// AUTO-GENERATED FILE -- Civix may overwrite any changes made to this file
/**
* The ExtensionUtil class provides small stubs for accessing resources of this
* extension.
*/
class CRM_Assignee_ExtensionUtil {
const SHORT_NAME = "assignee";
const LONG_NAME = "assignee";
const CLASS_PREFIX = "CRM_Assignee";
/**
* Translate a string using the extension's domain.
*
* If the extension doesn't have a specific translation
* for the string, fallback to the default translations.
*
* @param string $text
* Canonical message text (generally en_US).
* @param array $params
* @return string
* Translated text.
* @see ts
*/
public static function ts($text, $params = array()) {
if (!array_key_exists('domain', $params)) {
$params['domain'] = array(self::LONG_NAME, NULL);
}
return ts($text, $params);
}
/**
* Get the URL of a resource file (in this extension).
*
* @param string|NULL $file
* Ex: NULL.
* Ex: 'css/foo.css'.
* @return string
* Ex: 'http://example.org/sites/default/ext/org.example.foo'.
* Ex: 'http://example.org/sites/default/ext/org.example.foo/css/foo.css'.
*/
public static function url($file = NULL) {
if ($file === NULL) {
return rtrim(CRM_Core_Resources::singleton()->getUrl(self::LONG_NAME), '/');
}
return CRM_Core_Resources::singleton()->getUrl(self::LONG_NAME, $file);
}
/**
* Get the path of a resource file (in this extension).
*
* @param string|NULL $file
* Ex: NULL.
* Ex: 'css/foo.css'.
* @return string
* Ex: '/var/www/example.org/sites/default/ext/org.example.foo'.
* 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__ . ($file === 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_Assignee_ExtensionUtil as E;
/**
* (Delegated) Implements hook_civicrm_config().
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_config
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config
*/
function _assignee_civix_civicrm_config(&$config = NULL) {
static $configured = FALSE;
......@@ -19,14 +96,14 @@ function _assignee_civix_civicrm_config(&$config = NULL) {
$extRoot = dirname(__FILE__) . DIRECTORY_SEPARATOR;
$extDir = $extRoot . 'templates';
if ( is_array( $template->template_dir ) ) {
array_unshift( $template->template_dir, $extDir );
if (is_array($template->template_dir)) {
array_unshift($template->template_dir, $extDir);
}
else {
$template->template_dir = array( $extDir, $template->template_dir );
$template->template_dir = array($extDir, $template->template_dir);
}
$include_path = $extRoot . PATH_SEPARATOR . get_include_path( );
$include_path = $extRoot . PATH_SEPARATOR . get_include_path();
set_include_path($include_path);
}
......@@ -35,7 +112,7 @@ function _assignee_civix_civicrm_config(&$config = NULL) {
*
* @param $files array(string)
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_xmlMenu
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_xmlMenu
*/
function _assignee_civix_civicrm_xmlMenu(&$files) {
foreach (_assignee_civix_glob(__DIR__ . '/xml/Menu/*.xml') as $file) {
......@@ -46,7 +123,7 @@ function _assignee_civix_civicrm_xmlMenu(&$files) {
/**
* Implements hook_civicrm_install().
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_install
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install
*/
function _assignee_civix_civicrm_install() {
_assignee_civix_civicrm_config();
......@@ -55,10 +132,24 @@ function _assignee_civix_civicrm_install() {
}
}
/**
* Implements hook_civicrm_postInstall().
*
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_postInstall
*/
function _assignee_civix_civicrm_postInstall() {
_assignee_civix_civicrm_config();
if ($upgrader = _assignee_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
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_uninstall
*/
function _assignee_civix_civicrm_uninstall() {
_assignee_civix_civicrm_config();
......@@ -70,7 +161,7 @@ function _assignee_civix_civicrm_uninstall() {
/**
* (Delegated) Implements hook_civicrm_enable().
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_enable
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable
*/
function _assignee_civix_civicrm_enable() {
_assignee_civix_civicrm_config();
......@@ -84,7 +175,7 @@ function _assignee_civix_civicrm_enable() {
/**
* (Delegated) Implements hook_civicrm_disable().
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_disable
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_disable
* @return mixed
*/
function _assignee_civix_civicrm_disable() {
......@@ -105,7 +196,7 @@ function _assignee_civix_civicrm_disable() {
* @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
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_upgrade
*/
function _assignee_civix_civicrm_upgrade($op, CRM_Queue_Queue $queue = NULL) {
if ($upgrader = _assignee_civix_upgrader()) {
......@@ -114,14 +205,14 @@ function _assignee_civix_civicrm_upgrade($op, CRM_Queue_Queue $queue = NULL) {
}
/**
* @return CRM_assignee_Upgrader
* @return CRM_Assignee_Upgrader
*/
function _assignee_civix_upgrader() {
if (!file_exists(__DIR__.'/CRM/Assignee/Upgrader.php')) {
if (!file_exists(__DIR__ . '/CRM/Assignee/Upgrader.php')) {
return NULL;
}
else {
return CRM_assignee_Upgrader_Base::instance();
return CRM_Assignee_Upgrader_Base::instance();
}
}
......@@ -153,7 +244,8 @@ function _assignee_civix_find_files($dir, $pattern) {
while (FALSE !== ($entry = readdir($dh))) {
$path = $subdir . DIRECTORY_SEPARATOR . $entry;
if ($entry{0} == '.') {
} elseif (is_dir($path)) {
}
elseif (is_dir($path)) {
$todos[] = $path;
}
}
......@@ -167,15 +259,19 @@ function _assignee_civix_find_files($dir, $pattern) {
*
* Find any *.mgd.php files, merge their content, and return.
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_managed
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_managed
*/
function _assignee_civix_civicrm_managed(&$entities) {
$mgdFiles = _assignee_civix_find_files(__DIR__, '*.mgd.php');
sort($mgdFiles);
foreach ($mgdFiles as $file) {
$es = include $file;
foreach ($es as $e) {
if (empty($e['module'])) {
$e['module'] = 'assignee';
$e['module'] = E::LONG_NAME;
}
if (empty($e['params']['version'])) {
$e['params']['version'] = '3';
}
$entities[] = $e;
}
......@@ -189,7 +285,7 @@ function _assignee_civix_civicrm_managed(&$entities) {
*
* Note: This hook only runs in CiviCRM 4.4+.
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_caseTypes
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_caseTypes
*/
function _assignee_civix_civicrm_caseTypes(&$caseTypes) {
if (!is_dir(__DIR__ . '/xml/case')) {
......@@ -204,7 +300,7 @@ function _assignee_civix_civicrm_caseTypes(&$caseTypes) {
// throw new CRM_Core_Exception($errorMessage);
}
$caseTypes[$name] = array(
'module' => 'assignee',
'module' => E::LONG_NAME,
'name' => $name,
'file' => $file,
);
......@@ -218,7 +314,7 @@ function _assignee_civix_civicrm_caseTypes(&$caseTypes) {
*
* Note: This hook only runs in CiviCRM 4.5+.
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_angularModules
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_angularModules
*/
function _assignee_civix_civicrm_angularModules(&$angularModules) {
if (!is_dir(__DIR__ . '/ang')) {
......@@ -230,12 +326,31 @@ function _assignee_civix_civicrm_angularModules(&$angularModules) {
$name = preg_replace(':\.ang\.php$:', '', basename($file));
$module = include $file;
if (empty($module['ext'])) {
$module['ext'] = 'assignee';
$module['ext'] = E::LONG_NAME;
}
$angularModules[$name] = $module;
}
}
/**
* (Delegated) Implements hook_civicrm_themes().
*
* Find any and return any files matching "*.theme.php"
*/
function _assignee_civix_civicrm_themes(&$themes) {
$files = _assignee_civix_glob(__DIR__ . '/*.theme.php');
foreach ($files as $file) {
$themeMeta = include $file;
if (empty($themeMeta['name'])) {
$themeMeta['name'] = preg_replace(':\.theme\.php$:', '', basename($file));
}
if (empty($themeMeta['ext'])) {
$themeMeta['ext'] = E::LONG_NAME;
}
$themes[$themeMeta['name']] = $themeMeta;
}
}
/**
* Glob wrapper which is guaranteed to return an array.
*
......@@ -257,8 +372,10 @@ function _assignee_civix_glob($pattern) {
* 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)
* @param string $path - path to parent of this item, e.g. 'my_extension/submenu'
* 'Mailing', or 'Administer/System Settings'
* @param array $item - the item to insert (parent/child attributes will be
* filled for you)
*/
function _assignee_civix_insert_navigation_menu(&$menu, $path, $item) {
// If we are done going down the path, insert menu
......@@ -273,12 +390,14 @@ function _assignee_civix_insert_navigation_menu(&$menu, $path, $item) {
}
else {
// Find an recurse into the next level down
$found = false;
$found = FALSE;
$path = explode('/', $path);
$first = array_shift($path);
foreach ($menu as $key => &$entry) {
if ($entry['attributes']['name'] == $first) {
if (!$entry['child']) $entry['child'] = array();
if (!isset($entry['child'])) {
$entry['child'] = array();
}
$found = _assignee_civix_insert_navigation_menu($entry['child'], implode('/', $path), $item, $key);
}
}
......@@ -305,7 +424,7 @@ function _assignee_civix_fixNavigationMenu(&$nodes) {
if ($key === 'navID') {
$maxNavID = max($maxNavID, $item);
}
});
});
_assignee_civix_fixNavigationMenuItems($nodes, $maxNavID, NULL);
}
......@@ -332,17 +451,24 @@ function _assignee_civix_fixNavigationMenuItems(&$nodes, &$maxNavID, $parentID)
/**
* (Delegated) Implements hook_civicrm_alterSettingsFolders().
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_alterSettingsFolders
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_alterSettingsFolders
*/
function _assignee_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)) {
if (!in_array($settingsDir, $metaDataFolders) && is_dir($settingsDir)) {
$metaDataFolders[] = $settingsDir;
}
}
/**
* (Delegated) Implements hook_civicrm_entityTypes().
*
* Find any *.entityType.php files, merge their content, and return.
*
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_entityTypes
*/
function _assignee_civix_civicrm_entityTypes(&$entityTypes) {
$entityTypes = array_merge($entityTypes, array (
));
}
assignee.php
+ 14
− 14
View file @ 7b64a779
......@@ -5,7 +5,7 @@ require_once 'assignee.civix.php';
/**
* Implements hook_civicrm_config().
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_config
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config
*/
function assignee_civicrm_config(&$config) {
_assignee_civix_civicrm_config($config);
......@@ -16,7 +16,7 @@ function assignee_civicrm_config(&$config) {
*
* @param array $files
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_xmlMenu
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_xmlMenu
*/
function assignee_civicrm_xmlMenu(&$files) {
_assignee_civix_civicrm_xmlMenu($files);
......@@ -25,7 +25,7 @@ function assignee_civicrm_xmlMenu(&$files) {
/**
* Implements hook_civicrm_install().
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_install
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install
*/
function assignee_civicrm_install() {
_assignee_civix_civicrm_install();
......@@ -34,7 +34,7 @@ function assignee_civicrm_install() {
/**
* Implements hook_civicrm_uninstall().
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_uninstall
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_uninstall
*/
function assignee_civicrm_uninstall() {
_assignee_civix_civicrm_uninstall();
......@@ -43,7 +43,7 @@ function assignee_civicrm_uninstall() {
/**
* Implements hook_civicrm_enable().
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_enable
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable
*/
function assignee_civicrm_enable() {
_assignee_civix_civicrm_enable();
......@@ -52,7 +52,7 @@ function assignee_civicrm_enable() {
/**
* Implements hook_civicrm_disable().
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_disable
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_disable
*/
function assignee_civicrm_disable() {
_assignee_civix_civicrm_disable();
......@@ -68,7 +68,7 @@ function assignee_civicrm_disable() {
* 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
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_upgrade
*/
function assignee_civicrm_upgrade($op, CRM_Queue_Queue $queue = NULL) {
return _assignee_civix_civicrm_upgrade($op, $queue);
......@@ -80,7 +80,7 @@ function assignee_civicrm_upgrade($op, CRM_Queue_Queue $queue = NULL) {
* Generate a list of entities to create/deactivate/delete when this module
* is installed, disabled, uninstalled.
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_managed
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_managed
*/
function assignee_civicrm_managed(&$entities) {
_assignee_civix_civicrm_managed($entities);
......@@ -95,7 +95,7 @@ function assignee_civicrm_managed(&$entities) {
*
* Note: This hook only runs in CiviCRM 4.4+.
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_caseTypes
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_caseTypes
*/
function assignee_civicrm_caseTypes(&$caseTypes) {
_assignee_civix_civicrm_caseTypes($caseTypes);
......@@ -109,7 +109,7 @@ function assignee_civicrm_caseTypes(&$caseTypes) {
* Note: This hook only runs in CiviCRM 4.5+. It may
* use features only available in v4.6+.
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_caseTypes
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_caseTypes
*/
function assignee_civicrm_angularModules(&$angularModules) {
_assignee_civix_civicrm_angularModules($angularModules);
......@@ -118,7 +118,7 @@ _assignee_civix_civicrm_angularModules($angularModules);
/**
* Implements hook_civicrm_alterSettingsFolders().
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_alterSettingsFolders
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_alterSettingsFolders
*/
function assignee_civicrm_alterSettingsFolders(&$metaDataFolders = NULL) {
_assignee_civix_civicrm_alterSettingsFolders($metaDataFolders);
......@@ -127,7 +127,7 @@ function assignee_civicrm_alterSettingsFolders(&$metaDataFolders = NULL) {
/**
* Implements hook_civicrm_preProcess().
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_preProcess
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_preProcess
*/
function assignee_civicrm_preProcess($formName, &$form) {
if (is_a($form, 'CRM_Activity_Form_Activity')) {
......@@ -142,7 +142,7 @@ function assignee_civicrm_preProcess($formName, &$form) {
/**
* Implements hook_civicrm_buildForm().
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_buildForm
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_buildForm
*/
function assignee_civicrm_buildForm($formName, &$form) {
if (is_a($form, 'CRM_Activity_Form_Activity') AND Civi::settings()->get('assignee_as_source')) {
......@@ -153,7 +153,7 @@ function assignee_civicrm_buildForm($formName, &$form) {
/**
* Implements hook_civicrm_navigationMenu().
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_navigationMenu
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_navigationMenu
*/
function assignee_civicrm_navigationMenu(&$menu) {
_assignee_civix_insert_navigation_menu($menu, "Administer/System Settings", [
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment