civicrmpostcodelookup.php

<?php

require_once 'civicrmpostcodelookup.civix.php';
use CRM_Civicrmpostcodelookup_ExtensionUtil as E;

// Postcode lookup providers
// FIXME: Move this list to option values
$GLOBALS["providers"] = [
  'afd' => 'AFD',
  'civipostcode' => 'CiviPostcode',
  'experian' => 'Experian',
  'postcodeanywhere' => 'PostcodeAnywhere',
  'getaddressio'  => 'GetAddress'
];

/**
 * Implementation of hook_civicrm_config
 *
 * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_config
 */
function civicrmpostcodelookup_civicrm_config(&$config) {
  _civicrmpostcodelookup_civix_civicrm_config($config);
}

/**
 * Implementation of hook_civicrm_xmlMenu
 *
 * @param $files array(string)
 *
 * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_xmlMenu
 */
function civicrmpostcodelookup_civicrm_xmlMenu(&$files) {
  _civicrmpostcodelookup_civix_civicrm_xmlMenu($files);
}

/**
 * Implementation of hook_civicrm_install
 *
 * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_install
 */
function civicrmpostcodelookup_civicrm_install() {
  \Civi::settings()->set('api_details', '');
  _civicrmpostcodelookup_civix_civicrm_install();
}

/**
 * Implementation of hook_civicrm_uninstall
 *
 * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_uninstall
 */
function civicrmpostcodelookup_civicrm_uninstall() {
  _civicrmpostcodelookup_civix_civicrm_uninstall();
}

/**
 * Implementation of hook_civicrm_enable
 *
 * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_enable
 */
function civicrmpostcodelookup_civicrm_enable() {
  _civicrmpostcodelookup_civix_civicrm_enable();
}

/**
 * Implementation of hook_civicrm_disable
 *
 * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_disable
 */
function civicrmpostcodelookup_civicrm_disable() {
  _civicrmpostcodelookup_civix_civicrm_disable();
}

/**
 * Implementation of 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 civicrmpostcodelookup_civicrm_upgrade($op, CRM_Queue_Queue $queue = NULL) {
  return _civicrmpostcodelookup_civix_civicrm_upgrade($op, $queue);
}

/**
 * Implementation of hook_civicrm_managed
 *
 * 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
 */
function civicrmpostcodelookup_civicrm_managed(&$entities) {
  _civicrmpostcodelookup_civix_civicrm_managed($entities);
}

/**
 * Implementation of hook_civicrm_caseTypes
 *
 * Generate a list of case-types
 *
 * Note: This hook only runs in CiviCRM 4.4+.
 *
 * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_caseTypes
 */
function civicrmpostcodelookup_civicrm_caseTypes(&$caseTypes) {
  _civicrmpostcodelookup_civix_civicrm_caseTypes($caseTypes);
}

/**
 * Implementation of hook_civicrm_alterSettingsFolders
 *
 * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_alterSettingsFolders
 */
function civicrmpostcodelookup_civicrm_alterSettingsFolders(&$metaDataFolders = NULL) {
  _civicrmpostcodelookup_civix_civicrm_alterSettingsFolders($metaDataFolders);
}

/**
 * Add navigation for Postcode Lookup under "Administer" menu
 */
function civicrmpostcodelookup_civicrm_navigationMenu(&$menu) {
  $item[] =  [
    'label'      => E::ts('Postcode Lookup'),
    'name'       => 'Postcode Lookup',
    'url'        => 'civicrm/admin/postcodelookup/settings?reset=1',
    'permission' => 'administer CiviCRM',
    'operator'   => NULL,
    'separator'  => TRUE,
    'active'     => 1
  ];
  _civicrmpostcodelookup_civix_insert_navigation_menu($menu, 'Administer', $item[0]);
  _civicrmpostcodelookup_civix_navigationMenu($menu);
}

function civicrmpostcodelookup_civicrm_buildForm($formName, &$form) {
  $postCodeLookupPages = [
    'CRM_Contact_Form_Contact'
    , 'CRM_Contact_Form_Inline_Address'
    , 'CRM_Profile_Form_Edit'
    , 'CRM_Event_Form_Registration_Register'
    , 'CRM_Contribute_Form_Contribution_Main'
    , 'CRM_Event_Form_ManageEvent_Location'
    , 'CRM_Financial_Form_Payment'
    , 'CRM_Contact_Form_Domain'
  ];
  if (in_array($formName, $postCodeLookupPages)) {
    // Assign the postcode lookup provider to form, so that we can call the related function in AJAX
    $settingsStr = \Civi::settings()->get('api_details');
    $settingsArray = unserialize($settingsStr);
    $form->assign('civiPostCodeLookupProvider', $settingsArray['provider']);
    $settingsArray['location_type_id'] = $settingsArray['location_type_id'] ?? [];
    $settingsArray['location_type_id'][] = 'Primary';
    $form->assign('civiPostCodeLookupLocationTypeJson', json_encode($settingsArray['location_type_id']));
  }
}

/**
 * Implementation of hook_civicrm_permission
 *
 * @param array $permissions
 * @return void
 */
function civicrmpostcodelookup_civicrm_permission(&$permissions) {
  $permissions += [
    'access postcode lookup' => E::ts('CiviCRM: Access CiviCRM Postcode lookups'),
  ];
}