Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Run civix.upgrade #8

Merged
merged 1 commit into from
Sep 30, 2022
Merged

Run civix.upgrade #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
173 changes: 14 additions & 159 deletions exportpermission.civix.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ class CRM_Exportpermission_ExtensionUtil {
* Translated text.
* @see ts
*/
public static function ts($text, $params = []) {
public static function ts($text, $params = []): string {
if (!array_key_exists('domain', $params)) {
$params['domain'] = [self::LONG_NAME, NULL];
}
Expand All @@ -41,7 +41,7 @@ public static function ts($text, $params = []) {
* 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) {
public static function url($file = NULL): string {
if ($file === NULL) {
return rtrim(CRM_Core_Resources::singleton()->getUrl(self::LONG_NAME), '/');
}
Expand Down Expand Up @@ -79,6 +79,13 @@ public static function findClass($suffix) {

use CRM_Exportpermission_ExtensionUtil as E;

function _exportpermission_civix_mixin_polyfill() {
if (!class_exists('CRM_Extension_MixInfo')) {
$polyfill = __DIR__ . '/mixin/polyfill.php';
(require $polyfill)(E::LONG_NAME, E::SHORT_NAME, E::path());
}
}

/**
* (Delegated) Implements hook_civicrm_config().
*
Expand All @@ -91,9 +98,9 @@ function _exportpermission_civix_civicrm_config(&$config = NULL) {
}
$configured = TRUE;

$template =& CRM_Core_Smarty::singleton();
$template = CRM_Core_Smarty::singleton();

$extRoot = dirname(__FILE__) . DIRECTORY_SEPARATOR;
$extRoot = __DIR__ . DIRECTORY_SEPARATOR;
$extDir = $extRoot . 'templates';

if (is_array($template->template_dir)) {
Expand All @@ -105,19 +112,7 @@ function _exportpermission_civix_civicrm_config(&$config = NULL) {

$include_path = $extRoot . PATH_SEPARATOR . get_include_path();
set_include_path($include_path);
}

/**
* (Delegated) Implements hook_civicrm_xmlMenu().
*
* @param $files array(string)
*
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_xmlMenu
*/
function _exportpermission_civix_civicrm_xmlMenu(&$files) {
foreach (_exportpermission_civix_glob(__DIR__ . '/xml/Menu/*.xml') as $file) {
$files[] = $file;
}
_exportpermission_civix_mixin_polyfill();
}

/**
Expand All @@ -130,6 +125,7 @@ function _exportpermission_civix_civicrm_install() {
if ($upgrader = _exportpermission_civix_upgrader()) {
$upgrader->onInstall();
}
_exportpermission_civix_mixin_polyfill();
}

/**
Expand Down Expand Up @@ -170,6 +166,7 @@ function _exportpermission_civix_civicrm_enable() {
$upgrader->onEnable();
}
}
_exportpermission_civix_mixin_polyfill();
}

/**
Expand Down Expand Up @@ -217,136 +214,6 @@ function _exportpermission_civix_upgrader() {
}
}

/**
* Search directory tree for files which match a glob pattern.
*
* Note: Dot-directories (like "..", ".git", or ".svn") will be ignored.
* Note: Delegate to CRM_Utils_File::findFiles(), this function kept only
* for backward compatibility of extension code that uses it.
*
* @param string $dir base dir
* @param string $pattern , glob pattern, eg "*.txt"
*
* @return array
*/
function _exportpermission_civix_find_files($dir, $pattern) {
return CRM_Utils_File::findFiles($dir, $pattern);
}

/**
* (Delegated) Implements hook_civicrm_managed().
*
* Find any *.mgd.php files, merge their content, and return.
*
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_managed
*/
function _exportpermission_civix_civicrm_managed(&$entities) {
$mgdFiles = _exportpermission_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'] = E::LONG_NAME;
}
if (empty($e['params']['version'])) {
$e['params']['version'] = '3';
}
$entities[] = $e;
}
}
}

/**
* (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 https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_caseTypes
*/
function _exportpermission_civix_civicrm_caseTypes(&$caseTypes) {
if (!is_dir(__DIR__ . '/xml/case')) {
return;
}

foreach (_exportpermission_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));
throw new CRM_Core_Exception($errorMessage);
}
$caseTypes[$name] = [
'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 https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_angularModules
*/
function _exportpermission_civix_civicrm_angularModules(&$angularModules) {
if (!is_dir(__DIR__ . '/ang')) {
return;
}

$files = _exportpermission_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;
}
}

/**
* (Delegated) Implements hook_civicrm_themes().
*
* Find any and return any files matching "*.theme.php"
*/
function _exportpermission_civix_civicrm_themes(&$themes) {
$files = _exportpermission_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.
*
* 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
*/
function _exportpermission_civix_glob($pattern) {
$result = glob($pattern);
return is_array($result) ? $result : [];
}

/**
* Inserts a navigation menu item at a given place in the hierarchy.
*
Expand Down Expand Up @@ -429,18 +296,6 @@ function _exportpermission_civix_fixNavigationMenuItems(&$nodes, &$maxNavID, $pa
}
}

/**
* (Delegated) Implements hook_civicrm_alterSettingsFolders().
*
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_alterSettingsFolders
*/
function _exportpermission_civix_civicrm_alterSettingsFolders(&$metaDataFolders = NULL) {
$settingsDir = __DIR__ . DIRECTORY_SEPARATOR . 'settings';
if (!in_array($settingsDir, $metaDataFolders) && is_dir($settingsDir)) {
$metaDataFolders[] = $settingsDir;
}
}

/**
* (Delegated) Implements hook_civicrm_entityTypes().
*
Expand Down
41 changes: 8 additions & 33 deletions exportpermission.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,6 @@ function exportpermission_civicrm_config(&$config) {
_exportpermission_civix_civicrm_config($config);
}

/**
* Implements hook_civicrm_xmlMenu().
*/
function exportpermission_civicrm_xmlMenu(&$files) {
_exportpermission_civix_civicrm_xmlMenu($files);
}

/**
* Implements hook_civicrm_install().
*/
Expand Down Expand Up @@ -64,32 +57,6 @@ function exportpermission_civicrm_upgrade($op, CRM_Queue_Queue $queue = NULL) {
return _exportpermission_civix_civicrm_upgrade($op, $queue);
}

/**
* Implements hook_civicrm_managed().
*
* Generate a list of entities to create/deactivate/delete when this module
* is installed, disabled, uninstalled.
*/
function exportpermission_civicrm_managed(&$entities) {
_exportpermission_civix_civicrm_managed($entities);
}

/**
* Implements hook_civicrm_angularModules().
*
* Generate a list of Angular modules.
*/
function exportpermission_civicrm_angularModules(&$angularModules) {
_exportpermission_civix_civicrm_angularModules($angularModules);
}

/**
* Implements hook_civicrm_alterSettingsFolders().
*/
function exportpermission_civicrm_alterSettingsFolders(&$metaDataFolders = NULL) {
_exportpermission_civix_civicrm_alterSettingsFolders($metaDataFolders);
}

/**
* Implements hook_civicrm_permission().
*
Expand Down Expand Up @@ -189,3 +156,11 @@ function exportpermission_civicrm_buildForm($formName, &$form) {
}
}

/**
* Implements hook_civicrm_entityTypes().
*
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_entityTypes
*/
function exportpermission_civicrm_entityTypes(&$entityTypes) {
_exportpermission_civix_civicrm_entityTypes($entityTypes);
}
7 changes: 4 additions & 3 deletions info.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,15 @@
<url desc="Support">https://github.com/progressivetech/net.ourpowerbase.exportpermission/issues</url>
<url desc="Licensing">http://www.gnu.org/licenses/agpl-3.0.html</url>
</urls>
<releaseDate>2021-07-21</releaseDate>
<version>1.2</version>
<releaseDate>2022-09-27l</releaseDate>
<version>1.3</version>
<develStage>stable</develStage>
<compatibility>
<ver>5.35</ver>
<ver>5.53</ver>
</compatibility>
<comments>This extensions does not stop people from exporting data, it only hides the action from the menu.</comments>
<civix>
<namespace>CRM/Exportpermission</namespace>
<format>22.05.2</format>
</civix>
</extension>