diff --git a/CRM/Twingle/Form/Profile.php b/CRM/Twingle/Form/Profile.php index a38dc7e..ebc75c1 100644 --- a/CRM/Twingle/Form/Profile.php +++ b/CRM/Twingle/Form/Profile.php @@ -139,7 +139,7 @@ class CRM_Twingle_Form_Profile extends CRM_Core_Form { $this->_op = 'create'; } - // Verify that profile with the given name exists. + // Verify that a profile with the given name exists. $profile_name = CRM_Utils_Request::retrieve('name', 'String', $this); if (!$this->profile = CRM_Twingle_Profile::getProfile($profile_name)) { $profile_name = NULL; @@ -171,23 +171,22 @@ class CRM_Twingle_Form_Profile extends CRM_Core_Form { CRM_Utils_System::setTitle(E::ts('Edit Twingle API profile %1', array(1 => $this->profile->getName()))); break; case 'copy': - // This will be a 'create' actually. - $this->_op = 'create'; - + // Retrieve the source profile name. + $profile_name = CRM_Utils_Request::retrieve('source_name', 'String', $this); // When copying without a valid profile name, copy the default profile. if (!$profile_name) { $profile_name = 'default'; - $this->profile = CRM_Twingle_Profile::getProfile($profile_name); } + $this->profile = clone CRM_Twingle_Profile::getProfile($profile_name); - // Set a new name for this profile. + // Propose a new name for this profile. $profile_name = $profile_name . '_copy'; $this->profile->setName($profile_name); CRM_Utils_System::setTitle(E::ts('New Twingle API profile')); break; case 'create': // Load factory default profile values. - $this->profile = CRM_twingle_Profile::createDefaultProfile($profile_name); + $this->profile = CRM_Twingle_Profile::createDefaultProfile($profile_name); CRM_Utils_System::setTitle(E::ts('New Twingle API profile')); break; } @@ -428,13 +427,6 @@ class CRM_Twingle_Form_Profile extends CRM_Core_Form { parent::buildQuickForm(); } - /** - * @inheritdoc - */ - public function addRules() { - $this->addFormRule(array('CRM_Twingle_Form_Profile', 'validateProfileForm')); - } - /** * Validates the profile form. * @@ -445,12 +437,21 @@ class CRM_Twingle_Form_Profile extends CRM_Core_Form { * TRUE when the form was successfully validated, or an array of error * messages, keyed by form element name. */ - public static function validateProfileForm($values) { - $errors = array(); + public function validate() { + $values = $this->exportValues(); + + // Validate new profile names. + if ( + isset($values['name']) + && ($values['name'] != $this->profile->getName() || $this->_op != 'edit') + && !empty(CRM_Twingle_Profile::getProfile($values['name'])) + ) { + $this->_errors['name'] = E::ts('A profile with this name already exists.'); + } // Restrict profile names to alphanumeric characters and the underscore. if (isset($values['name']) && preg_match("/[^A-Za-z0-9\_]/", $values['name'])) { - $errors['name'] = E::ts('Only alphanumeric characters and the underscore (_) are allowed for profile names.'); + $this->_errors['name'] = E::ts('Only alphanumeric characters and the underscore (_) are allowed for profile names.'); } // Validate custom field mapping. @@ -513,10 +514,10 @@ class CRM_Twingle_Form_Profile extends CRM_Core_Form { } } catch (Exception $exception) { - $errors['custom_field_mapping'] = $exception->getMessage(); + $this->_errors['custom_field_mapping'] = $exception->getMessage(); } - return empty($errors) ? TRUE : $errors; + return parent::validate(); } /** @@ -524,7 +525,7 @@ class CRM_Twingle_Form_Profile extends CRM_Core_Form { */ public function setDefaultValues() { $defaults = parent::setDefaultValues(); - if (in_array($this->_op, array('create', 'edit'))) { + if (in_array($this->_op, array('create', 'edit', 'copy'))) { $defaults['name'] = $this->profile->getName(); $profile_data = $this->profile->getData(); foreach ($profile_data as $element_name => $value) { @@ -543,7 +544,7 @@ class CRM_Twingle_Form_Profile extends CRM_Core_Form { */ public function postProcess() { $values = $this->exportValues(); - if (in_array($this->_op, array('create', 'edit'))) { + if (in_array($this->_op, array('create', 'edit', 'copy'))) { if (empty($values['name'])) { $values['name'] = 'default'; } diff --git a/api/v3/TwingleDonation/Submit.php b/api/v3/TwingleDonation/Submit.php index 75220bb..44c415f 100644 --- a/api/v3/TwingleDonation/Submit.php +++ b/api/v3/TwingleDonation/Submit.php @@ -400,27 +400,6 @@ function civicrm_api3_twingle_donation_Submit($params) { $contact_data += $custom_fields['Individual']; } - if (!$contact_id = CRM_Twingle_Submission::getContact( - 'Individual', - $contact_data, - $profile, - $params - )) { - throw new CiviCRM_API3_Exception( - E::ts('Individual contact could not be found or created.'), - 'api_error' - ); - } - - // Save user_extrafield as contact note. - if (!empty($params['user_extrafield'])) { - civicrm_api3('Note', 'create', array( - 'entity_table' => 'civicrm_contact', - 'entity_id' => $contact_id, - 'note' => $params['user_extrafield'], - )); - } - // Organisation lookup. if (!empty($params['organization_name'])) { $organisation_data = array( @@ -449,6 +428,31 @@ function civicrm_api3_twingle_donation_Submit($params) { ); } } + elseif (!empty($submitted_address)) { + $contact_data += $submitted_address; + } + + if (!$contact_id = CRM_Twingle_Submission::getContact( + 'Individual', + $contact_data, + $profile, + $params + )) { + throw new CiviCRM_API3_Exception( + E::ts('Individual contact could not be found or created.'), + 'api_error' + ); + } + + // Save user_extrafield as contact note. + if (!empty($params['user_extrafield'])) { + civicrm_api3('Note', 'create', array( + 'entity_table' => 'civicrm_contact', + 'entity_id' => $contact_id, + 'note' => $params['user_extrafield'], + )); + } + // Share organisation address with individual contact, using configured // location type for organisation address. $address_shared = ( @@ -460,19 +464,6 @@ function civicrm_api3_twingle_donation_Submit($params) { ) ); - // Address is not shared, use submitted address with - // configured location type. - if (!$address_shared && !empty($submitted_address)) { - // Do not use `Address.create` API action, let XCM decide - // whether to create an address. - CRM_Twingle_Submission::getContact( - 'Individual', - array('id' => $contact_id) + $submitted_address, - $profile, - $params - ); - } - // Create employer relationship between organization and individual. if (isset($organisation_id)) { CRM_Twingle_Submission::updateEmployerRelation($contact_id, $organisation_id); diff --git a/templates/CRM/Twingle/Form/Profile.tpl b/templates/CRM/Twingle/Form/Profile.tpl index 708cb5a..dff57ba 100644 --- a/templates/CRM/Twingle/Form/Profile.tpl +++ b/templates/CRM/Twingle/Form/Profile.tpl @@ -14,7 +14,7 @@
- {if $op == 'create' or $op == 'edit'} + {if $op == 'create' or $op == 'edit' or $op == 'copy'}
diff --git a/templates/CRM/Twingle/Page/Profiles.tpl b/templates/CRM/Twingle/Page/Profiles.tpl index 30dbfce..f97b9ed 100644 --- a/templates/CRM/Twingle/Page/Profiles.tpl +++ b/templates/CRM/Twingle/Page/Profiles.tpl @@ -39,7 +39,7 @@ {ts domain="de.systopia.twingle"}Edit{/ts} - {ts domain="de.systopia.twingle"}Copy{/ts} + {ts domain="de.systopia.twingle"}Copy{/ts} {if $profile_name == 'default'} {ts domain="de.systopia.twingle"}Reset{/ts} {else} diff --git a/twingle.civix.php b/twingle.civix.php index 7d5bd46..c407f6f 100644 --- a/twingle.civix.php +++ b/twingle.civix.php @@ -7,9 +7,9 @@ * extension. */ class CRM_Twingle_ExtensionUtil { - const SHORT_NAME = "twingle"; - const LONG_NAME = "de.systopia.twingle"; - const CLASS_PREFIX = "CRM_Twingle"; + const SHORT_NAME = 'twingle'; + const LONG_NAME = 'de.systopia.twingle'; + const CLASS_PREFIX = 'CRM_Twingle'; /** * Translate a string using the extension's domain. @@ -24,9 +24,9 @@ class CRM_Twingle_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_Twingle_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 _twingle_civix_civicrm_config(&$config = NULL) { static $configured = FALSE; @@ -100,7 +100,7 @@ function _twingle_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 _twingle_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 _twingle_civix_civicrm_xmlMenu(&$files) { foreach (_twingle_civix_glob(__DIR__ . '/xml/Menu/*.xml') as $file) { @@ -123,7 +123,7 @@ function _twingle_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 _twingle_civix_civicrm_install() { _twingle_civix_civicrm_config(); @@ -135,12 +135,12 @@ function _twingle_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 _twingle_civix_civicrm_postInstall() { _twingle_civix_civicrm_config(); if ($upgrader = _twingle_civix_upgrader()) { - if (is_callable(array($upgrader, 'onPostInstall'))) { + if (is_callable([$upgrader, 'onPostInstall'])) { $upgrader->onPostInstall(); } } @@ -149,7 +149,7 @@ function _twingle_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 _twingle_civix_civicrm_uninstall() { _twingle_civix_civicrm_config(); @@ -161,12 +161,12 @@ function _twingle_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 _twingle_civix_civicrm_enable() { _twingle_civix_civicrm_config(); if ($upgrader = _twingle_civix_upgrader()) { - if (is_callable(array($upgrader, 'onEnable'))) { + if (is_callable([$upgrader, 'onEnable'])) { $upgrader->onEnable(); } } @@ -175,13 +175,13 @@ function _twingle_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 _twingle_civix_civicrm_disable() { _twingle_civix_civicrm_config(); if ($upgrader = _twingle_civix_upgrader()) { - if (is_callable(array($upgrader, 'onDisable'))) { + if (is_callable([$upgrader, 'onDisable'])) { $upgrader->onDisable(); } } @@ -193,10 +193,11 @@ function _twingle_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) - * for 'enqueue', returns void + * @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 _twingle_civix_civicrm_upgrade($op, CRM_Queue_Queue $queue = NULL) { if ($upgrader = _twingle_civix_upgrader()) { @@ -217,49 +218,27 @@ function _twingle_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() + * Note: Delegate to CRM_Utils_File::findFiles(), this function kept only + * for backward compatibility of extension code that uses it. * - * @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 _twingle_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 (_twingle_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; + return CRM_Utils_File::findFiles($dir, $pattern); } + /** * (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 + * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_managed */ function _twingle_civix_civicrm_managed(&$entities) { $mgdFiles = _twingle_civix_find_files(__DIR__, '*.mgd.php'); @@ -285,7 +264,7 @@ function _twingle_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 _twingle_civix_civicrm_caseTypes(&$caseTypes) { if (!is_dir(__DIR__ . '/xml/case')) { @@ -296,14 +275,13 @@ function _twingle_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 +292,7 @@ function _twingle_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 _twingle_civix_civicrm_angularModules(&$angularModules) { if (!is_dir(__DIR__ . '/ang')) { @@ -332,6 +310,25 @@ function _twingle_civix_civicrm_angularModules(&$angularModules) { } } +/** + * (Delegated) Implements hook_civicrm_themes(). + * + * Find any and return any files matching "*.theme.php" + */ +function _twingle_civix_civicrm_themes(&$themes) { + $files = _twingle_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,11 +339,12 @@ function _twingle_civix_civicrm_angularModules(&$angularModules) { * * @link http://php.net/glob * @param string $pattern - * @return array, possibly empty + * + * @return array */ function _twingle_civix_glob($pattern) { $result = glob($pattern); - return is_array($result) ? $result : array(); + return is_array($result) ? $result : []; } /** @@ -357,16 +355,18 @@ function _twingle_civix_glob($pattern) { * 'Mailing', or 'Administer/System Settings' * @param array $item - the item to insert (parent/child attributes will be * filled for you) + * + * @return bool */ function _twingle_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 { @@ -377,9 +377,9 @@ function _twingle_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 = _twingle_civix_insert_navigation_menu($entry['child'], implode('/', $path), $item, $key); + $found = _twingle_civix_insert_navigation_menu($entry['child'], implode('/', $path), $item); } } return $found; @@ -390,7 +390,7 @@ function _twingle_civix_insert_navigation_menu(&$menu, $path, $item) { * (Delegated) Implements hook_civicrm_navigationMenu(). */ function _twingle_civix_navigationMenu(&$nodes) { - if (!is_callable(array('CRM_Core_BAO_Navigation', 'fixNavigationMenu'))) { + if (!is_callable(['CRM_Core_BAO_Navigation', 'fixNavigationMenu'])) { _twingle_civix_fixNavigationMenu($nodes); } } @@ -432,17 +432,11 @@ function _twingle_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 _twingle_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; } } @@ -452,10 +446,8 @@ function _twingle_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 _twingle_civix_civicrm_entityTypes(&$entityTypes) { - $entityTypes = array_merge($entityTypes, array ( - )); + $entityTypes = array_merge($entityTypes, []); }