CRM-19464 Enable use of 'Supplemental Address 3'

In some situations, the address format is too limited.  The 'Supplemental Address 3'
already exists in the schema but was not exposed to the GUI.

This touches many files but the changes are fairly simple.  Wherever 'Supplemental Address 2'
existed, there is now a 'Supplemental Address 3' as well.

CRM/Contact/BAO/Contact/Location.php

@@ -132,6 +132,7 @@ public static function &getMapInfo($ids, $locationTypeID = NULL, $imageUrlOnly =
           civicrm_address.street_address as street_address,
           civicrm_address.supplemental_address_1 as supplemental_address_1,
           civicrm_address.supplemental_address_2 as supplemental_address_2,
+          civicrm_address.supplemental_address_3 as supplemental_address_3,
           civicrm_address.city as city,
           civicrm_address.postal_code as postal_code,
           civicrm_address.postal_code_suffix as postal_code_suffix,
@@ -180,6 +181,7 @@ public static function &getMapInfo($ids, $locationTypeID = NULL, $imageUrlOnly =
           $dao->street_address,
           $dao->supplemental_address_1,
           $dao->supplemental_address_2,
+          $dao->supplemental_address_3,
           $dao->city,
         )
       );

CRM/Contact/BAO/Query.php

@@ -369,6 +369,7 @@ class CRM_Contact_BAO_Query {
     'street_unit',
     'supplemental_address_1',
     'supplemental_address_2',
+    'supplemental_address_3',
     'city',
     'postal_code',
     'postal_code_suffix',
@@ -2382,6 +2383,7 @@ public static function getLocationTableName(&$where, &$locType) {
           'street_unit',
           'supplemental_address_1',
           'supplemental_address_2',
+          'supplemental_address_3',
           'city',
           'postal_code',
           'postal_code_suffix',
@@ -4238,6 +4240,7 @@ public static function &defaultReturnProperties($mode = 1) {
           'street_address' => 1,
           'supplemental_address_1' => 1,
           'supplemental_address_2' => 1,
+          'supplemental_address_3' => 1,
           'city' => 1,
           'postal_code' => 1,
           'postal_code_suffix' => 1,

CRM/Contact/Form/Edit/Address.php

@@ -100,6 +100,7 @@ public static function buildQuickForm(&$form, $addressBlockCount = NULL, $sharin
       'street_address',
       'supplemental_address_1',
       'supplemental_address_2',
+      'supplemental_address_3',
       'city',
       'postal_code',
       'postal_code_suffix',

CRM/Contact/Form/Search/Criteria.php

@@ -299,6 +299,7 @@ public static function location(&$form) {
       'street_address' => array(ts('Street Address'), $attributes['street_address'], NULL, NULL),
       'supplemental_address_1' => array(ts('Supplemental Address 1'), $attributes['supplemental_address_1'], NULL, NULL),
       'supplemental_address_2' => array(ts('Supplemental Address 2'), $attributes['supplemental_address_2'], NULL, NULL),
+      'supplemental_address_3' => array(ts('Supplemental Address 3'), $attributes['supplemental_address_3'], NULL, NULL),
       'city' => array(ts('City'), $attributes['city'], NULL, NULL),
       'postal_code' => array(ts('Postal Code'), $attributes['postal_code'], NULL, NULL),
       'country' => array(ts('Country'), $attributes['country_id'], 'country', FALSE),

CRM/Contact/Page/View/Vcard.php

@@ -107,6 +107,9 @@ public function run() {
         if (!empty($location['supplemental_address_2'])) {
           $extend .= ', ' . $location['supplemental_address_2'];
         }
+        if (!empty($location['supplemental_address_3'])) {
+          $extend .= ', ' . $location['supplemental_address_3'];
+        }
         $street = CRM_Utils_Array::value('street_address', $location);
         $locality = CRM_Utils_Array::value('city', $location);
         $region = NULL;

CRM/Contribute/Form/Task/Invoice.php

@@ -434,6 +434,7 @@ public static function printPDF($contribIDs, &$params, $contactIds) {
         'street_address' => CRM_Utils_Array::value('street_address', CRM_Utils_Array::value($contribution->contact_id, $billingAddress)),
         'supplemental_address_1' => CRM_Utils_Array::value('supplemental_address_1', CRM_Utils_Array::value($contribution->contact_id, $billingAddress)),
         'supplemental_address_2' => CRM_Utils_Array::value('supplemental_address_2', CRM_Utils_Array::value($contribution->contact_id, $billingAddress)),
+        'supplemental_address_3' => CRM_Utils_Array::value('supplemental_address_3', CRM_Utils_Array::value($contribution->contact_id, $billingAddress)),
         'city' => CRM_Utils_Array::value('city', CRM_Utils_Array::value($contribution->contact_id, $billingAddress)),
         'stateProvinceAbbreviation' => $stateProvinceAbbreviation,
         'postal_code' => CRM_Utils_Array::value('postal_code', CRM_Utils_Array::value($contribution->contact_id, $billingAddress)),
@@ -443,6 +444,7 @@ public static function printPDF($contribIDs, &$params, $contactIds) {
         'domain_street_address' => CRM_Utils_Array::value('street_address', CRM_Utils_Array::value('1', $locationDefaults['address'])),
         'domain_supplemental_address_1' => CRM_Utils_Array::value('supplemental_address_1', CRM_Utils_Array::value('1', $locationDefaults['address'])),
         'domain_supplemental_address_2' => CRM_Utils_Array::value('supplemental_address_2', CRM_Utils_Array::value('1', $locationDefaults['address'])),
+        'domain_supplemental_address_3' => CRM_Utils_Array::value('supplemental_address_3', CRM_Utils_Array::value('1', $locationDefaults['address'])),
         'domain_city' => CRM_Utils_Array::value('city', CRM_Utils_Array::value('1', $locationDefaults['address'])),
         'domain_postal_code' => CRM_Utils_Array::value('postal_code', CRM_Utils_Array::value('1', $locationDefaults['address'])),
         'domain_state' => $stateProvinceAbbreviationDomain,

CRM/Core/BAO/Address.php

@@ -569,6 +569,7 @@ public function addDisplay($microformat = FALSE) {
       'street_address' => $this->street_address,
       'supplemental_address_1' => $this->supplemental_address_1,
       'supplemental_address_2' => $this->supplemental_address_2,
+      'supplemental_address_3' => $this->supplemental_address_3,
       'city' => $this->city,
       'state_province_name' => isset($this->state_name) ? $this->state_name : "",
       'state_province' => isset($this->state) ? $this->state : "",
@@ -971,6 +972,7 @@ public static function checkContactSharedAddressFields(&$fields, $contactId) {
       'postal_code_suffix',
       'supplemental_address_1',
       'supplemental_address_2',
+      'supplemental_address_3',
     );
 
     foreach ($fields as $name => & $values) {

CRM/Core/BAO/Mapping.php

@@ -645,6 +645,7 @@ public static function buildMappingForm(&$form, $mappingType, $mappingId, $colum
       'street_address',
       'supplemental_address_1',
       'supplemental_address_2',
+      'supplemental_address_3',
       'city',
       'postal_code',
       'postal_code_suffix',

CRM/Core/BAO/UFGroup.php

@@ -709,6 +709,7 @@ public static function getLocationFields() {
       'street_address',
       'supplemental_address_1',
       'supplemental_address_2',
+      'supplemental_address_3',
       'city',
       'postal_code',
       'postal_code_suffix',

CRM/Core/DAO/Address.php

@@ -30,7 +30,7 @@
  *
  * Generated from xml/schema/CRM/Core/Address.xml
  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
- * (GenCodeChecksum:459fcbe817baa776e55ab44e3818b8eb)
+ * (GenCodeChecksum:472057d193d1e875a14e7719a2d6a2ee)
  */
 require_once 'CRM/Core/DAO.php';
 require_once 'CRM/Utils/Type.php';
@@ -514,6 +514,11 @@ static function &fields() {
           'description' => 'Supplemental Address Information, Line 3',
           'maxlength' => 96,
           'size' => CRM_Utils_Type::HUGE,
+          'import' => true,
+          'where' => 'civicrm_address.supplemental_address_3',
+          'headerPattern' => '/(supplemental(\s)?)?address(\s\d+)?/i',
+          'dataPattern' => '/unit|ap(ar)?t(ment)?\s(\d|\w)+/i',
+          'export' => true,
           'table_name' => 'civicrm_address',
           'entity' => 'Address',
           'bao' => 'CRM_Core_BAO_Address',

CRM/Core/DAO/AllCoreTables.data.php

@@ -24,7 +24,7 @@
 | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
 +--------------------------------------------------------------------+
 */
-// (GenCodeChecksum:de6dc96f4442bc90970f8e8c26b1c802)
+// (GenCodeChecksum:2d196ddd274c6e0e1847af66fcc7101d)
 return array(
   'CRM_Core_DAO_AddressFormat' => array(
     'name' => 'AddressFormat',

CRM/Core/Page/AJAX/Location.php

@@ -128,6 +128,7 @@ public static function getPermissionedLocation() {
       'street_address',
       'supplemental_address_1',
       'supplemental_address_2',
+      'supplemental_address_3',
       'city',
       'postal_code',
       'county',

CRM/Event/BAO/Event.php

@@ -794,6 +794,7 @@ public static function &getCompleteInfo(
   civicrm_address.street_address as street_address,
   civicrm_address.supplemental_address_1 as supplemental_address_1,
   civicrm_address.supplemental_address_2 as supplemental_address_2,
+  civicrm_address.supplemental_address_3 as supplemental_address_3,
   civicrm_address.city as city,
   civicrm_address.postal_code as postal_code,
   civicrm_address.postal_code_suffix as postal_code_suffix,
@@ -872,6 +873,7 @@ public static function &getCompleteInfo(
           'street_address' => $dao->street_address,
           'supplemental_address_1' => $dao->supplemental_address_1,
           'supplemental_address_2' => $dao->supplemental_address_2,
+          'supplemental_address_3' => $dao->supplemental_address_3,
           'city' => $dao->city,
           'state_province' => $dao->state,
           'postal_code' => $dao->postal_code,
@@ -1877,7 +1879,7 @@ public static function getLocationEvents() {
     $events = array();
 
     $query = "
-SELECT CONCAT_WS(' :: ' , ca.name, ca.street_address, ca.city, sp.name, ca.supplemental_address_1, ca.supplemental_address_2) title, ce.loc_block_id
+SELECT CONCAT_WS(' :: ' , ca.name, ca.street_address, ca.city, sp.name, ca.supplemental_address_1, ca.supplemental_address_2, ca.supplemental_address_3) title, ce.loc_block_id
 FROM   civicrm_event ce
 INNER JOIN civicrm_loc_block lb ON ce.loc_block_id = lb.id
 INNER JOIN civicrm_address ca   ON lb.address_id = ca.id

CRM/Export/BAO/Export.php

@@ -329,6 +329,7 @@ public static function exportComponents(
         'street_address',
         'supplemental_address_1',
         'supplemental_address_2',
+        'supplemental_address_3',
         'city',
         'postal_code',
         'postal_code_suffix',

CRM/Report/Form.php

@@ -4047,6 +4047,7 @@ public function addAddressFields($groupBy = TRUE, $orderBy = FALSE, $filters = T
       'street_address' => ts('Street Address'),
       'supplemental_address_1' => ts('Supplementary Address Field 1'),
       'supplemental_address_2' => ts('Supplementary Address Field 2'),
+      'supplemental_address_3' => ts('Supplementary Address Field 3'),
       'street_number' => ts('Street Number'),
       'street_name' => ts('Street Name'),
       'street_unit' => ts('Street Unit'),

CRM/Report/Form/Extended.php

@@ -760,6 +760,12 @@ public function getAddressColumns($options = array()) {
             'default' => CRM_Utils_Array::value('supplemental_address_2', $options['defaults'], FALSE),
             'name' => 'supplemental_address_2',
           ),
+          $options['prefix'] . 'supplemental_address_3' => array(
+            'title' => ts($options['prefix_label'] .
+              'Supplementary Address Field 3'),
+            'default' => CRM_Utils_Array::value('supplemental_address_3', $options['defaults'], FALSE),
+            'name' => 'supplemental_address_3',
+          ),
           $options['prefix'] . 'street_number' => array(
             'name' => 'street_number',
             'title' => ts($options['prefix_label'] . 'Street Number'),

CRM/UF/Form/Preview.php

@@ -79,6 +79,7 @@ public function preProcess() {
         'street_address',
         'supplemental_address_1',
         'supplemental_address_2',
+        'supplemental_address_3',
         'city',
         'postal_code',
         'postal_code_suffix',

CRM/Utils/Address.php

@@ -85,6 +85,7 @@ public static function format(
     $emptyFields = array(
       'supplemental_address_1',
       'supplemental_address_2',
+      'supplemental_address_3',
       'state_province_name',
       'county',
     );
@@ -142,6 +143,7 @@ public static function format(
         'contact.street_address' => CRM_Utils_Array::value('street_address', $fields),
         'contact.supplemental_address_1' => CRM_Utils_Array::value('supplemental_address_1', $fields),
         'contact.supplemental_address_2' => CRM_Utils_Array::value('supplemental_address_2', $fields),
+        'contact.supplemental_address_3' => CRM_Utils_Array::value('supplemental_address_3', $fields),
         'contact.city' => CRM_Utils_Array::value('city', $fields),
         'contact.state_province_name' => CRM_Utils_Array::value('state_province_name', $fields),
         'contact.county' => CRM_Utils_Array::value('county', $fields),
@@ -186,6 +188,7 @@ public static function format(
         'contact.street_address' => "<span class=\"street-address\">" . $fields['street_address'] . "</span>",
         'contact.supplemental_address_1' => "<span class=\"extended-address\">" . $fields['supplemental_address_1'] . "</span>",
         'contact.supplemental_address_2' => $fields['supplemental_address_2'],
+        'contact.supplemental_address_3' => $fields['supplemental_address_3'],
         'contact.city' => "<span class=\"locality\">" . $fields['city'] . "</span>",
         'contact.state_province_name' => "<span class=\"region\">" . $fields['state_province_name'] . "</span>",
         'contact.county' => "<span class=\"region\">" . $fields['county'],
@@ -304,6 +307,7 @@ public static function sequence($format) {
       'street_address',
       'supplemental_address_1',
       'supplemental_address_2',
+      'supplemental_address_3',
       'city',
       'county',
       'state_province',

CRM/Utils/DeprecatedUtils.php

@@ -1133,6 +1133,7 @@ function _civicrm_api3_deprecated_add_formatted_location_blocks(&$values, &$para
     'state_province',
     'supplemental_address_1',
     'supplemental_address_2',
+    'supplemental_address_3',
     'StateProvince.name',
   );
 

api/v3/Contact.php

@@ -212,6 +212,10 @@ function _civicrm_api3_contact_get_spec(&$params) {
     'title' => 'Primary Address Supplemental Address 2',
     'type' => CRM_Utils_Type::T_STRING,
   );
+  $params['supplemental_address_3'] = array(
+    'title' => 'Primary Address Supplemental Address 3',
+    'type' => CRM_Utils_Type::T_STRING,
+  );
   $params['current_employer'] = array(
     'title' => 'Current Employer',
     'type' => CRM_Utils_Type::T_STRING,

api/v3/Domain.php

@@ -64,7 +64,7 @@ function civicrm_api3_domain_get($params) {
       );
       $values['location'] = CRM_Core_BAO_Location::getValues($locparams, TRUE);
       $address_array = array(
-        'street_address', 'supplemental_address_1', 'supplemental_address_2',
+        'street_address', 'supplemental_address_1', 'supplemental_address_2', 'supplemental_address_3',
         'city', 'state_province_id', 'postal_code', 'country_id',
         'geo_code_1', 'geo_code_2',
       );

api/v3/examples/Activity/ReturnAssigneeContact.php

@@ -116,6 +116,7 @@ function activity_get_expectedresult() {
               'street_address' => '',
               'supplemental_address_1' => '',
               'supplemental_address_2' => '',
+              'supplemental_address_3' => '',
               'city' => '',
               'postal_code_suffix' => '',
               'postal_code' => '',

api/v3/examples/Contact/APIChainedArray.php

@@ -93,6 +93,7 @@ function contact_get_expectedresult() {
         'street_address' => '',
         'supplemental_address_1' => '',
         'supplemental_address_2' => '',
+        'supplemental_address_3' => '',
         'city' => '',
         'postal_code_suffix' => '',
         'postal_code' => '',

api/v3/examples/Contact/APIChainedArrayFormats.php

@@ -94,6 +94,7 @@ function contact_get_expectedresult() {
         'street_address' => '',
         'supplemental_address_1' => '',
         'supplemental_address_2' => '',
+        'supplemental_address_3' => '',
         'city' => '',
         'postal_code_suffix' => '',
         'postal_code' => '',

api/v3/examples/Contact/APIChainedArrayMultipleCustom.php

@@ -91,6 +91,7 @@ function contact_get_expectedresult() {
         'street_address' => '',
         'supplemental_address_1' => '',
         'supplemental_address_2' => '',
+        'supplemental_address_3' => '',
         'city' => '',
         'postal_code_suffix' => '',
         'postal_code' => '',

api/v3/examples/Contact/Get.php

@@ -84,6 +84,7 @@ function contact_get_expectedresult() {
         'street_address' => '',
         'supplemental_address_1' => '',
         'supplemental_address_2' => '',
+        'supplemental_address_3' => '',
         'city' => '',
         'postal_code_suffix' => '',
         'postal_code' => '',

api/v3/examples/Contact/GetSingleContact.php

@@ -82,6 +82,7 @@ function contact_getsingle_expectedresult() {
     'street_address' => '',
     'supplemental_address_1' => '',
     'supplemental_address_2' => '',
+    'supplemental_address_3' => '',
     'city' => '',
     'postal_code_suffix' => '',
     'postal_code' => '',

api/v3/examples/Contact/GroupFilterUsingContactAPI.php

@@ -91,6 +91,7 @@ function contact_get_expectedresult() {
         'street_address' => '',
         'supplemental_address_1' => '',
         'supplemental_address_2' => '',
+        'supplemental_address_3' => '',
         'city' => '',
         'postal_code_suffix' => '',
         'postal_code' => '',

api/v3/examples/Contact/NestedReplaceEmail.php

@@ -115,6 +115,7 @@ function contact_get_expectedresult() {
         'street_address' => '',
         'supplemental_address_1' => '',
         'supplemental_address_2' => '',
+        'supplemental_address_3' => '',
         'city' => '',
         'postal_code_suffix' => '',
         'postal_code' => '',

api/v3/examples/Domain/Get.php

@@ -57,6 +57,7 @@ function domain_get_expectedresult() {
           'street_address' => '45 Penny Lane',
           'supplemental_address_1' => '',
           'supplemental_address_2' => '',
+          'supplemental_address_3' => '',
           'city' => '',
           'state_province_id' => '',
           'postal_code' => '',
@@ -82,6 +83,7 @@ function domain_get_expectedresult() {
           'street_address' => '15 Main St',
           'supplemental_address_1' => '',
           'supplemental_address_2' => '',
+          'supplemental_address_3' => '',
           'city' => 'Collinsville',
           'state_province_id' => '1006',
           'postal_code' => '6022',

api/v3/examples/Mailing/GetTokens.php

@@ -107,6 +107,7 @@ function mailing_gettokens_expectedresult() {
       '{contact.street_unit}' => 'Street Unit',
       '{contact.supplemental_address_1}' => 'Supplemental Address 1',
       '{contact.supplemental_address_2}' => 'Supplemental Address 2',
+      '{contact.supplemental_address_3}' => 'Supplemental Address 3',
       '{contact.city}' => 'City',
       '{contact.postal_code_suffix}' => 'Postal Code Suffix',
       '{contact.postal_code}' => 'Postal Code',

api/v3/examples/Setting/GetDefaults.php

@@ -50,6 +50,7 @@ function setting_getdefaults_expectedresult() {
 {contact.street_address}
 {contact.supplemental_address_1}
 {contact.supplemental_address_2}
+{contact.supplemental_address_3}
 {contact.city}{, }{contact.state_province}{ }{contact.postal_code}
 {contact.country}',
       ),

api/v3/examples/Setting/GetFields.php

@@ -334,6 +334,7 @@ function setting_getfields_expectedresult() {
 {contact.street_address}
 {contact.supplemental_address_1}
 {contact.supplemental_address_2}
+{contact.supplemental_address_3}
 {contact.city}{, }{contact.state_province}{ }{contact.postal_code}
 {contact.country}',
         'add' => '4.1',
@@ -353,6 +354,7 @@ function setting_getfields_expectedresult() {
 {contact.street_address}
 {contact.supplemental_address_1}
 {contact.supplemental_address_2}
+{contact.supplemental_address_3}
 {contact.city}{, }{contact.state_province}{ }{contact.postal_code}
 {contact.country}',
         'add' => '4.1',

api/v3/examples/Setting/Revert.php

@@ -55,6 +55,7 @@ function setting_revert_expectedresult() {
 {contact.street_address}
 {contact.supplemental_address_1}
 {contact.supplemental_address_2}
+{contact.supplemental_address_3}
 {contact.city}{, }{contact.state_province}{ }{contact.postal_code}
 {contact.country}',
         ),