Merge pull request #13973 from eileenmcnaughton/array_format6

[civicrm-core.git] / CRM / Utils / Address.php

diff --git a/CRM/Utils/Address.php b/CRM/Utils/Address.php
index 84ec2f8162ebc5b3092f3fd8e0332950a4c51f94..4f2cdc5f5ce3efc376719ee8ad78bede747df3b8 100644 (file)
--- a/CRM/Utils/Address.php
+++ b/CRM/Utils/Address.php
@@ -3,7 +3,7 @@
  +--------------------------------------------------------------------+
  | CiviCRM version 5                                                  |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2018                                |
+ | Copyright CiviCRM LLC (c) 2004-2019                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -29,7 +29,7 @@
  * Address Utilities
  *
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2018
+ * @copyright CiviCRM LLC (c) 2004-2019
  */
 class CRM_Utils_Address {
 
@@ -81,13 +81,13 @@ class CRM_Utils_Address {
     }
 
     // make sure that some of the fields do have values
-    $emptyFields = array(
+    $emptyFields = [
       'supplemental_address_1',
       'supplemental_address_2',
       'supplemental_address_3',
       'state_province_name',
       'county',
-    );
+    ];
     foreach ($emptyFields as $f) {
       if (!isset($fields[$f])) {
         $fields[$f] = NULL;
@@ -98,7 +98,7 @@ class CRM_Utils_Address {
     if ($mailing && !empty($fields['country'])) {
       if (Civi::settings()->get('hideCountryMailingLabels')) {
         $domain = CRM_Core_BAO_Domain::getDomain();
-        $domainLocation = CRM_Core_BAO_Location::getValues(array('contact_id' => $domain->contact_id));
+        $domainLocation = CRM_Core_BAO_Location::getValues(['contact_id' => $domain->contact_id]);
         $domainAddress = $domainLocation['address'][1];
         $domainCountryId = $domainAddress['country_id'];
         if ($fields['country'] == CRM_Core_PseudoConstant::country($domainCountryId)) {
@@ -116,7 +116,7 @@ class CRM_Utils_Address {
 
     if (!$microformat) {
       // replacements in case of Individual Name Format
-      $replacements = array(
+      $replacements = [
         'contact.display_name' => CRM_Utils_Array::value('display_name', $fields),
         'contact.individual_prefix' => CRM_Utils_Array::value('individual_prefix', $fields),
         'contact.formal_title' => CRM_Utils_Array::value('formal_title', $fields),
@@ -165,10 +165,10 @@ class CRM_Utils_Address {
         'contact.addressee' => CRM_Utils_Array::value('addressee_display', $fields),
         'contact.email_greeting' => CRM_Utils_Array::value('email_greeting_display', $fields),
         'contact.postal_greeting' => CRM_Utils_Array::value('postal_greeting_display', $fields),
-      );
+      ];
     }
     else {
-      $replacements = array(
+      $replacements = [
         'contact.address_name' => "<span class=\"address-name\">" . $fields['address_name'] . "</span>",
         'contact.street_address' => "<span class=\"street-address\">" . $fields['street_address'] . "</span>",
         'contact.supplemental_address_1' => "<span class=\"extended-address\">" . $fields['supplemental_address_1'] . "</span>",
@@ -181,7 +181,7 @@ class CRM_Utils_Address {
         'contact.postal_code' => "<span class=\"postal-code\">" . $fullPostalCode . "</span>",
         'contact.country' => "<span class=\"country-name\">" . $fields['country'] . "</span>",
         'contact.world_region' => "<span class=\"region\">" . $fields['world_region'] . "</span>",
-      );
+      ];
 
       // erase all empty ones, so we dont get blank lines
       foreach (array_keys($replacements) as $key) {
@@ -249,7 +249,7 @@ class CRM_Utils_Address {
     $formatted = preg_replace('/{([^{}]*)}({[^{}]*})+/u', '\1', $formatted);
 
     // drop any remaining curly braces leaving their contents
-    $formatted = str_replace(array('{', '}'), '', $formatted);
+    $formatted = str_replace(['{', '}'], '', $formatted);
 
     // drop any empty lines left after the replacements
     $formatted = preg_replace('/^[ \t]*[\r\n]+/m', '', $formatted);
@@ -260,7 +260,7 @@ class CRM_Utils_Address {
     else {
       // remove \n from each line and only add at the end
       // this hack solves formatting issue, when we convert nl2br
-      $lines = array();
+      $lines = [];
       $count = 1;
       $finalFormatted = NULL;
       $formattedArray = explode("\n", $formatted);
@@ -287,7 +287,7 @@ class CRM_Utils_Address {
    */
   public static function sequence($format) {
     // also compute and store the address sequence
-    $addressSequence = array(
+    $addressSequence = [
       'address_name',
       'street_address',
       'supplemental_address_1',
@@ -298,10 +298,10 @@ class CRM_Utils_Address {
       'state_province',
       'postal_code',
       'country',
-    );
+    ];
 
     // get the field sequence from the format
-    $newSequence = array();
+    $newSequence = [];
     foreach ($addressSequence as $field) {
       if (substr_count($format, $field)) {
         $newSequence[strpos($format, $field)] = $field;
@@ -326,16 +326,15 @@ class CRM_Utils_Address {
    * @return string
    */
   public static function getFormattedBillingAddressFieldsFromParameters($params, $billingLocationTypeID) {
-    $addressParts = array(
+    $addressParts = [
       "street_address" => "billing_street_address-{$billingLocationTypeID}",
       "city" => "billing_city-{$billingLocationTypeID}",
       "postal_code" => "billing_postal_code-{$billingLocationTypeID}",
       "state_province" => "state_province-{$billingLocationTypeID}",
-      "state_province_name" => "state_province-{$billingLocationTypeID}",
       "country" => "country-{$billingLocationTypeID}",
-    );
+    ];
 
-    $addressFields = array();
+    $addressFields = [];
     foreach ($addressParts as $name => $field) {
       $value = CRM_Utils_Array::value($field, $params);
       $alternateName = 'billing_' . $name . '_id-' . $billingLocationTypeID;
@@ -349,12 +348,10 @@ class CRM_Utils_Address {
           $value = $params[$alternateName];
         }
       }
-      if (is_numeric($value) && ($name == 'state_province' || $name == 'state_province_name' || $name == 'country')) {
+      if (is_numeric($value) && ($name == 'state_province' || $name == 'country')) {
         if ($name == 'state_province') {
           $addressFields[$name] = CRM_Core_PseudoConstant::stateProvinceAbbreviation($value);
-        }
-        if ($name == 'state_province_name') {
-          $addressFields[$name] = CRM_Core_PseudoConstant::stateProvince($value);
+          $addressFields[$name . '_name'] = CRM_Core_PseudoConstant::stateProvince($value);
         }
         if ($name == 'country') {
           $addressFields[$name] = CRM_Core_PseudoConstant::countryIsoCode($value);