Commit bc5b1397 authored by sluc23's avatar sluc23
Browse files

Merge branch 'dev-update-civix' into 'master'

Update extension structure to civix v20.09.0

See merge request !43
parents 92cbc267 ab6d38e3
......@@ -4,12 +4,12 @@
/**
* The ExtensionUtil class provides small stubs for accessing resources of this
* extension.
* extension.
*/
class CRM_Redsys_ExtensionUtil {
const SHORT_NAME = "redsys";
const LONG_NAME = "com.ixiam.payment.redsys";
const CLASS_PREFIX = "CRM_Redsys";
const SHORT_NAME = 'redsys';
const LONG_NAME = 'redsys';
const CLASS_PREFIX = 'CRM_Redsys';
/**
* Translate a string using the extension's domain.
......@@ -24,9 +24,9 @@ class CRM_Redsys_ExtensionUtil {
* Translated text.
* @see ts
*/
public static function ts($text, $params = array()) {
public static function ts($text, $params = []) {
if (!array_key_exists('domain', $params)) {
$params['domain'] = array(self::LONG_NAME, NULL);
$params['domain'] = [self::LONG_NAME, NULL];
}
return ts($text, $params);
}
......@@ -82,7 +82,7 @@ use CRM_Redsys_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 _redsys_civix_civicrm_config(&$config = NULL) {
static $configured = FALSE;
......@@ -100,7 +100,7 @@ function _redsys_civix_civicrm_config(&$config = NULL) {
array_unshift($template->template_dir, $extDir);
}
else {
$template->template_dir = array($extDir, $template->template_dir);
$template->template_dir = [$extDir, $template->template_dir];
}
$include_path = $extRoot . PATH_SEPARATOR . get_include_path();
......@@ -112,7 +112,7 @@ function _redsys_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 _redsys_civix_civicrm_xmlMenu(&$files) {
foreach (_redsys_civix_glob(__DIR__ . '/xml/Menu/*.xml') as $file) {
......@@ -123,7 +123,7 @@ function _redsys_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 _redsys_civix_civicrm_install() {
_redsys_civix_civicrm_config();
......@@ -135,12 +135,12 @@ function _redsys_civix_civicrm_install() {
/**
* Implements hook_civicrm_postInstall().
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_postInstall
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_postInstall
*/
function _redsys_civix_civicrm_postInstall() {
_redsys_civix_civicrm_config();
if ($upgrader = _redsys_civix_upgrader()) {
if (is_callable(array($upgrader, 'onPostInstall'))) {
if (is_callable([$upgrader, 'onPostInstall'])) {
$upgrader->onPostInstall();
}
}
......@@ -149,7 +149,7 @@ function _redsys_civix_civicrm_postInstall() {
/**
* 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 _redsys_civix_civicrm_uninstall() {
_redsys_civix_civicrm_config();
......@@ -161,12 +161,12 @@ function _redsys_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 _redsys_civix_civicrm_enable() {
_redsys_civix_civicrm_config();
if ($upgrader = _redsys_civix_upgrader()) {
if (is_callable(array($upgrader, 'onEnable'))) {
if (is_callable([$upgrader, 'onEnable'])) {
$upgrader->onEnable();
}
}
......@@ -175,13 +175,13 @@ function _redsys_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 _redsys_civix_civicrm_disable() {
_redsys_civix_civicrm_config();
if ($upgrader = _redsys_civix_upgrader()) {
if (is_callable(array($upgrader, 'onDisable'))) {
if (is_callable([$upgrader, 'onDisable'])) {
$upgrader->onDisable();
}
}
......@@ -193,10 +193,11 @@ function _redsys_civix_civicrm_disable() {
* @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)
* @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 _redsys_civix_civicrm_upgrade($op, CRM_Queue_Queue $queue = NULL) {
if ($upgrader = _redsys_civix_upgrader()) {
......@@ -217,22 +218,23 @@ function _redsys_civix_upgrader() {
}
/**
* Search directory tree for files which match a glob pattern
* 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)
* @param string $dir base dir
* @param string $pattern , glob pattern, eg "*.txt"
*
* @return array
*/
function _redsys_civix_find_files($dir, $pattern) {
if (is_callable(array('CRM_Utils_File', 'findFiles'))) {
if (is_callable(['CRM_Utils_File', 'findFiles'])) {
return CRM_Utils_File::findFiles($dir, $pattern);
}
$todos = array($dir);
$result = array();
$todos = [$dir];
$result = [];
while (!empty($todos)) {
$subdir = array_shift($todos);
foreach (_redsys_civix_glob("$subdir/$pattern") as $match) {
......@@ -243,7 +245,7 @@ function _redsys_civix_find_files($dir, $pattern) {
if ($dh = opendir($subdir)) {
while (FALSE !== ($entry = readdir($dh))) {
$path = $subdir . DIRECTORY_SEPARATOR . $entry;
if ($entry{0} == '.') {
if ($entry[0] == '.') {
}
elseif (is_dir($path)) {
$todos[] = $path;
......@@ -260,20 +262,21 @@ function _redsys_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 _redsys_civix_civicrm_managed(&$entities) {
$mgdFiles = _redsys_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;
}
$entities[] = $e;
if (empty($e['params']['version'])) {
$e['params']['version'] = '3';
}
$entities[] = $e;
}
}
}
......@@ -285,7 +288,7 @@ function _redsys_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 _redsys_civix_civicrm_caseTypes(&$caseTypes) {
if (!is_dir(__DIR__ . '/xml/case')) {
......@@ -296,14 +299,13 @@ function _redsys_civix_civicrm_caseTypes(&$caseTypes) {
$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);
throw new CRM_Core_Exception($errorMessage);
}
$caseTypes[$name] = array(
$caseTypes[$name] = [
'module' => E::LONG_NAME,
'name' => $name,
'file' => $file,
);
];
}
}
......@@ -314,7 +316,7 @@ function _redsys_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 _redsys_civix_civicrm_angularModules(&$angularModules) {
if (!is_dir(__DIR__ . '/ang')) {
......@@ -332,6 +334,25 @@ function _redsys_civix_civicrm_angularModules(&$angularModules) {
}
}
/**
* (Delegated) Implements hook_civicrm_themes().
*
* Find any and return any files matching "*.theme.php"
*/
function _redsys_civix_civicrm_themes(&$themes) {
$files = _redsys_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.
*
......@@ -342,29 +363,34 @@ function _redsys_civix_civicrm_angularModules(&$angularModules) {
*
* @link http://php.net/glob
* @param string $pattern
* @return array, possibly empty
*
* @return array
*/
function _redsys_civix_glob($pattern) {
$result = glob($pattern);
return is_array($result) ? $result : array();
return is_array($result) ? $result : [];
}
/**
* 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)
*
* @return bool
*/
function _redsys_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(
$menu[] = [
'attributes' => array_merge([
'label' => CRM_Utils_Array::value('name', $item),
'active' => 1,
), $item),
);
], $item),
];
return TRUE;
}
else {
......@@ -375,9 +401,9 @@ function _redsys_civix_insert_navigation_menu(&$menu, $path, $item) {
foreach ($menu as $key => &$entry) {
if ($entry['attributes']['name'] == $first) {
if (!isset($entry['child'])) {
$entry['child'] = array();
$entry['child'] = [];
}
$found = _redsys_civix_insert_navigation_menu($entry['child'], implode('/', $path), $item, $key);
$found = _redsys_civix_insert_navigation_menu($entry['child'], implode('/', $path), $item);
}
}
return $found;
......@@ -388,7 +414,7 @@ function _redsys_civix_insert_navigation_menu(&$menu, $path, $item) {
* (Delegated) Implements hook_civicrm_navigationMenu().
*/
function _redsys_civix_navigationMenu(&$nodes) {
if (!is_callable(array('CRM_Core_BAO_Navigation', 'fixNavigationMenu'))) {
if (!is_callable(['CRM_Core_BAO_Navigation', 'fixNavigationMenu'])) {
_redsys_civix_fixNavigationMenu($nodes);
}
}
......@@ -430,17 +456,11 @@ function _redsys_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 _redsys_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;
}
}
......@@ -450,8 +470,8 @@ function _redsys_civix_civicrm_alterSettingsFolders(&$metaDataFolders = NULL) {
*
* Find any *.entityType.php files, merge their content, and return.
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_entityTypes
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_entityTypes
*/
function _redsys_civix_civicrm_entityTypes(&$entityTypes) {
$entityTypes = array_merge($entityTypes, array());
$entityTypes = array_merge($entityTypes, []);
}
<?php
require_once 'redsys.civix.php';
// phpcs:disable
use CRM_Redsys_ExtensionUtil as E;
// phpcs:enable
/**
* 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 redsys_civicrm_config(&$config) {
_redsys_civix_civicrm_config($config);
......@@ -15,7 +17,7 @@ function redsys_civicrm_config(&$config) {
/**
* Implements hook_civicrm_xmlMenu().
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_xmlMenu
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_xmlMenu
*/
function redsys_civicrm_xmlMenu(&$files) {
_redsys_civix_civicrm_xmlMenu($files);
......@@ -24,60 +26,16 @@ function redsys_civicrm_xmlMenu(&$files) {
/**
* Implements hook_civicrm_postInstall().
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_postInstall
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_postInstall
*/
function redsys_civicrm_postInstall() {
_redsys_civix_civicrm_postInstall();
}
/**
* Implements hook_civicrm_install().
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_install
*/
function redsys_civicrm_install() {
$params = array(
'name' => 'Redsys',
'title' => 'Redsys Payment Processor',
'description' => 'Works with Servired (Sermepa) and 4B (Pasat).',
'class_name' => 'Payment_Redsys',
'billing_mode' => 'notify',
'user_name_label' => 'Número de comercio',
'password_label' => 'Clave secreta de encriptación',
'url_site_default' => 'https://sis.redsys.es/sis/realizarPago',
'url_site_test_default' => 'https://sis-t.redsys.es:25443/sis/realizarPago',
'is_recur' => 0,
'payment_type' => 1,
);
$result = civicrm_api3('PaymentProcessorType', 'create', $params);
return _redsys_civix_civicrm_install();
}
/**
* Implements hook_civicrm_uninstall().
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_uninstall
*/
function redsys_civicrm_uninstall() {
$params = array(
'sequential' => 1,
'name' => 'Redsys',
);
$result = civicrm_api('PaymentProcessorType', 'get', $params);
if ($result["count"] == 1) {
$params = array(
'sequential' => 1,
'id' => $result["id"],
);
$result = civicrm_api3('PaymentProcessorType', 'delete', $params);
}
return _redsys_civix_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 redsys_civicrm_enable() {
_redsys_civix_civicrm_enable();
......@@ -86,7 +44,7 @@ function redsys_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 redsys_civicrm_disable() {
_redsys_civix_civicrm_disable();
......@@ -95,7 +53,7 @@ function redsys_civicrm_disable() {
/**
* Implements hook_civicrm_upgrade().
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_upgrade
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_upgrade
*/
function redsys_civicrm_upgrade($op, CRM_Queue_Queue $queue = NULL) {
return _redsys_civix_civicrm_upgrade($op, $queue);
......@@ -107,7 +65,7 @@ function redsys_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 redsys_civicrm_managed(&$entities) {
_redsys_civix_civicrm_managed($entities);
......@@ -120,7 +78,7 @@ function redsys_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 redsys_civicrm_caseTypes(&$caseTypes) {
_redsys_civix_civicrm_caseTypes($caseTypes);
......@@ -134,7 +92,7 @@ function redsys_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_angularModules
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_angularModules
*/
function redsys_civicrm_angularModules(&$angularModules) {
_redsys_civix_civicrm_angularModules($angularModules);
......@@ -143,7 +101,7 @@ function redsys_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 redsys_civicrm_alterSettingsFolders(&$metaDataFolders = NULL) {
_redsys_civix_civicrm_alterSettingsFolders($metaDataFolders);
......@@ -154,8 +112,61 @@ function redsys_civicrm_alterSettingsFolders(&$metaDataFolders = NULL) {
*
* Declare entity types provided by this module.
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_entityTypes
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_entityTypes
*/
function redsys_civicrm_entityTypes(&$entityTypes) {
_redsys_civix_civicrm_entityTypes($entityTypes);
}
/**
* Implements hook_civicrm_thems().
*/
function redsys_civicrm_themes(&$themes) {
_redsys_civix_civicrm_themes($themes);
}
// --- Functions below this ship commented out. Uncomment as required. ---
/**
* Implements hook_civicrm_install().
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_install
*/
function redsys_civicrm_install() {
$params = [
'name' => 'Redsys',
'title' => 'Redsys Payment Processor',
'description' => 'Works with Servired (Sermepa) and 4B (Pasat).',
'class_name' => 'Payment_Redsys',
'billing_mode' => 'notify',
'user_name_label' => 'Número de comercio',
'password_label' => 'Clave secreta de encriptación',
'url_site_default' => 'https://sis.redsys.es/sis/realizarPago',
'url_site_test_default' => 'https://sis-t.redsys.es:25443/sis/realizarPago',
'is_recur' => 0,
'payment_type' => 1,
];
$result = civicrm_api3('PaymentProcessorType', 'create', $params);
return _redsys_civix_civicrm_install();
}
/**
* Implements hook_civicrm_uninstall().
*
* @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_uninstall
*/
function redsys_civicrm_uninstall() {
$params = [
'sequential' => 1,
'name' => 'Redsys',
];
$result = civicrm_api('PaymentProcessorType', 'get', $params);
if ($result["count"] == 1) {
$params = [
'sequential' => 1,
'id' => $result["id"],
];
$result = civicrm_api3('PaymentProcessorType', 'delete', $params);
}
return _redsys_civix_civicrm_uninstall();
}
Markdown is supported
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