CRM/Utils/Address.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  * Address utilties
  30  *
  31  * @package CRM
  32  */
  33 class CRM_Utils_Address {
  34
  35   /**
  36    * Format an address string from address fields and a format string.
  37    *
  38    * Format an address basing on the address fields provided.
  39    * Use Setting's address_format if there's no format specified.
  40    *
  41    * @param array $fields
  42    *   The address fields.
  43    * @param string $format
  44    *   The desired address format.
  45    * @param bool $microformat
  46    *   If true indicates, the address to be built in hcard-microformat standard.
  47    * @param bool $mailing
  48    *   If true indicates, the call has been made from mailing label.
  49    * @param bool $individualFormat
  50    *   If true indicates, the call has been made for the contact of type 'individual'.
  51    *
  52    * @param null $tokenFields
  53    *
  54    * @return string
  55    *   formatted address string
  56    *
  57    */
  58   public static function format(
  59     $fields,
  60     $format = NULL,
  61     $microformat = FALSE,
  62     $mailing = FALSE,
  63     $individualFormat = FALSE,
  64     $tokenFields = NULL
  65   ) {
  66     static $config = NULL;
  67
  68     if (!$format) {
  69       $format = CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, 'address_format');
  70     }
  71
  72     if ($mailing) {
  73       $format = CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, 'mailing_format');
  74     }
  75
  76     $formatted = $format;
  77
  78     $fullPostalCode = CRM_Utils_Array::value('postal_code', $fields);
  79     if (!empty($fields['postal_code_suffix'])) {
  80       $fullPostalCode .= "-$fields[postal_code_suffix]";
  81     }
  82
  83     // make sure that some of the fields do have values
  84     $emptyFields = array(
  85       'supplemental_address_1',
  86       'supplemental_address_2',
  87       'state_province_name',
  88       'county',
  89     );
  90     foreach ($emptyFields as $f) {
  91       if (!isset($fields[$f])) {
  92         $fields[$f] = NULL;
  93       }
  94     }
  95
  96     $contactName = CRM_Utils_Array::value('display_name', $fields);
  97     if (!$individualFormat) {
  98       if (isset($fields['id'])) {
  99         $type = CRM_Contact_BAO_Contact::getContactType($fields['id']);
 100       }
 101       else {
 102         $type = 'Individual';
 103       }
 104
 105       if ($type == 'Individual') {
 106         $contactName = CRM_Utils_Array::value('addressee_display', $fields);
 107       }
 108     }
 109
 110     if (!$microformat) {
 111       // replacements in case of Individual Name Format
 112       $replacements = array(
 113         'contact.display_name' => CRM_Utils_Array::value('display_name', $fields),
 114         'contact.individual_prefix' => CRM_Utils_Array::value('individual_prefix', $fields),
 115         'contact.formal_title' => CRM_Utils_Array::value('formal_title', $fields),
 116         'contact.first_name' => CRM_Utils_Array::value('first_name', $fields),
 117         'contact.middle_name' => CRM_Utils_Array::value('middle_name', $fields),
 118         'contact.last_name' => CRM_Utils_Array::value('last_name', $fields),
 119         'contact.individual_suffix' => CRM_Utils_Array::value('individual_suffix', $fields),
 120         'contact.address_name' => CRM_Utils_Array::value('address_name', $fields),
 121         'contact.street_address' => CRM_Utils_Array::value('street_address', $fields),
 122         'contact.supplemental_address_1' => CRM_Utils_Array::value('supplemental_address_1', $fields),
 123         'contact.supplemental_address_2' => CRM_Utils_Array::value('supplemental_address_2', $fields),
 124         'contact.city' => CRM_Utils_Array::value('city', $fields),
 125         'contact.state_province_name' => CRM_Utils_Array::value('state_province_name', $fields),
 126         'contact.county' => CRM_Utils_Array::value('county', $fields),
 127         'contact.state_province' => CRM_Utils_Array::value('state_province', $fields),
 128         'contact.postal_code' => $fullPostalCode,
 129         'contact.country' => CRM_Utils_Array::value('country', $fields),
 130         'contact.world_region' => CRM_Utils_Array::value('world_region', $fields),
 131         'contact.geo_code_1' => CRM_Utils_Array::value('geo_code_1', $fields),
 132         'contact.geo_code_2' => CRM_Utils_Array::value('geo_code_2', $fields),
 133         'contact.current_employer' => CRM_Utils_Array::value('current_employer', $fields),
 134         'contact.nick_name' => CRM_Utils_Array::value('nick_name', $fields),
 135         'contact.email' => CRM_Utils_Array::value('email', $fields),
 136         'contact.im' => CRM_Utils_Array::value('im', $fields),
 137         'contact.do_not_email' => CRM_Utils_Array::value('do_not_email', $fields),
 138         'contact.do_not_phone' => CRM_Utils_Array::value('do_not_phone', $fields),
 139         'contact.do_not_mail' => CRM_Utils_Array::value('do_not_mail', $fields),
 140         'contact.do_not_sms' => CRM_Utils_Array::value('do_not_sms', $fields),
 141         'contact.do_not_trade' => CRM_Utils_Array::value('do_not_trade', $fields),
 142         'contact.job_title' => CRM_Utils_Array::value('job_title', $fields),
 143         'contact.birth_date' => CRM_Utils_Array::value('birth_date', $fields),
 144         'contact.gender' => CRM_Utils_Array::value('gender', $fields),
 145         'contact.is_opt_out' => CRM_Utils_Array::value('is_opt_out', $fields),
 146         'contact.preferred_mail_format' => CRM_Utils_Array::value('preferred_mail_format', $fields),
 147         'contact.phone' => CRM_Utils_Array::value('phone', $fields),
 148         'contact.home_URL' => CRM_Utils_Array::value('home_URL', $fields),
 149         'contact.contact_source' => CRM_Utils_Array::value('contact_source', $fields),
 150         'contact.external_identifier' => CRM_Utils_Array::value('external_identifier', $fields),
 151         'contact.contact_id' => CRM_Utils_Array::value('id', $fields),
 152         'contact.household_name' => CRM_Utils_Array::value('display_name', $fields),
 153         'contact.organization_name' => CRM_Utils_Array::value('display_name', $fields),
 154         'contact.legal_name' => CRM_Utils_Array::value('legal_name', $fields),
 155         'contact.preferred_communication_method' => CRM_Utils_Array::value('preferred_communication_method', $fields),
 156         'contact.communication_style' => CRM_Utils_Array::value('communication_style', $fields),
 157         'contact.addressee' => CRM_Utils_Array::value('addressee_display', $fields),
 158         'contact.email_greeting' => CRM_Utils_Array::value('email_greeting_display', $fields),
 159         'contact.postal_greeting' => CRM_Utils_Array::value('postal_greeting_display', $fields),
 160       );
 161     }
 162     else {
 163       $replacements = array(
 164         'contact.address_name' => "<span class=\"address-name\">" . $fields['address_name'] . "</span>",
 165         'contact.street_address' => "<span class=\"street-address\">" . $fields['street_address'] . "</span>",
 166         'contact.supplemental_address_1' => "<span class=\"extended-address\">" . $fields['supplemental_address_1'] . "</span>",
 167         'contact.supplemental_address_2' => $fields['supplemental_address_2'],
 168         'contact.city' => "<span class=\"locality\">" . $fields['city'] . "</span>",
 169         'contact.state_province_name' => "<span class=\"region\">" . $fields['state_province_name'] . "</span>",
 170         'contact.county' => "<span class=\"region\">" . $fields['county'],
 171         'contact.state_province' => "<span class=\"region\">" . $fields['state_province'] . "</span>",
 172         'contact.postal_code' => "<span class=\"postal-code\">" . $fullPostalCode . "</span>",
 173         'contact.country' => "<span class=\"country-name\">" . $fields['country'] . "</span>",
 174         'contact.world_region' => "<span class=\"region\">" . $fields['world_region'] . "</span>",
 175       );
 176
 177       // erase all empty ones, so we dont get blank lines
 178       foreach (array_keys($replacements) as $key) {
 179         $exactKey = substr($key, 0, 8) == 'contact.' ? substr($key, 8) : $key;
 180         if ($key != 'contact.postal_code' &&
 181           CRM_Utils_Array::value($exactKey, $fields) == NULL
 182         ) {
 183           $replacements[$key] = '';
 184         }
 185       }
 186       if (empty($fullPostalCode)) {
 187         $replacements['contact.postal_code'] = '';
 188       }
 189     }
 190
 191     // replacements in case of Custom Token
 192     if (stristr($formatted, 'custom_')) {
 193       $customToken = array_keys($fields);
 194       foreach ($customToken as $value) {
 195         if (substr($value, 0, 7) == 'custom_') {
 196           $replacements["contact.{$value}"] = $fields["{$value}"];
 197         }
 198       }
 199     }
 200
 201     // also sub all token fields
 202     if ($tokenFields) {
 203       foreach ($tokenFields as $token) {
 204         $replacements["{$token}"] = CRM_Utils_Array::value("{$token}", $fields);
 205       }
 206     }
 207
 208     // for every token, replace {fooTOKENbar} with fooVALUEbar if
 209     // the value is not empty, otherwise drop the whole {fooTOKENbar}
 210     foreach ($replacements as $token => $value) {
 211       if ($value && is_string($value) || is_numeric($value)) {
 212         $formatted = preg_replace("/{([^{}]*)\b{$token}\b([^{}]*)}/u", "\${1}{$value}\${2}", $formatted);
 213       }
 214       else {
 215         $formatted = preg_replace("/{[^{}]*\b{$token}\b[^{}]*}/u", '', $formatted);
 216       }
 217     }
 218
 219     // drop any {...} constructs from lines' ends
 220     if (!$microformat) {
 221       $formatted = "\n$formatted\n";
 222     }
 223     else {
 224       if ($microformat == 1) {
 225         $formatted = "\n<div class=\"location vcard\"><span class=\"adr\">\n$formatted</span></div>\n";
 226       }
 227       else {
 228         $formatted = "\n<div class=\"vcard\"><span class=\"adr\">$formatted</span></div>\n";
 229       }
 230     }
 231
 232     $formatted = preg_replace('/\n{[^{}]*}/u', "\n", $formatted);
 233     $formatted = preg_replace('/{[^{}]*}\n/u', "\n", $formatted);
 234
 235     // if there are any 'sibling' {...} constructs, replace them with the
 236     // contents of the first one; for example, when there's no state_province:
 237     // 1. {city}{, }{state_province}{ }{postal_code}
 238     // 2. San Francisco{, }{ }12345
 239     // 3. San Francisco, 12345
 240     $formatted = preg_replace('/{([^{}]*)}({[^{}]*})+/u', '\1', $formatted);
 241
 242     // drop any remaining curly braces leaving their contents
 243     $formatted = str_replace(array('{', '}'), '', $formatted);
 244
 245     // drop any empty lines left after the replacements
 246     $formatted = preg_replace('/^[ \t]*[\r\n]+/m', '', $formatted);
 247
 248     if (!$microformat) {
 249       $finalFormatted = $formatted;
 250     }
 251     else {
 252       // remove \n from each line and only add at the end
 253       // this hack solves formatting issue, when we convert nl2br
 254       $lines = array();
 255       $count = 1;
 256       $finalFormatted = NULL;
 257       $formattedArray = explode("\n", $formatted);
 258       $formattedArray = array_filter($formattedArray);
 259
 260       foreach ($formattedArray as $line) {
 261         $line = trim($line);
 262         if ($line) {
 263           if ($count > 1 && $count < count($formattedArray)) {
 264             $line = "$line\n";
 265           }
 266           $finalFormatted .= $line;
 267           $count++;
 268         }
 269       }
 270     }
 271     return $finalFormatted;
 272   }
 273
 274   /**
 275    * @param $format
 276    *
 277    * @return array
 278    */
 279   public static function sequence($format) {
 280     // also compute and store the address sequence
 281     $addressSequence = array(
 282       'address_name',
 283       'street_address',
 284       'supplemental_address_1',
 285       'supplemental_address_2',
 286       'city',
 287       'county',
 288       'state_province',
 289       'postal_code',
 290       'country',
 291     );
 292
 293     // get the field sequence from the format
 294     $newSequence = array();
 295     foreach ($addressSequence as $field) {
 296       if (substr_count($format, $field)) {
 297         $newSequence[strpos($format, $field)] = $field;
 298       }
 299     }
 300     ksort($newSequence);
 301
 302     // add the addressSequence fields that are missing in the addressFormat
 303     // to the end of the list, so that (for example) if state_province is not
 304     // specified in the addressFormat it's still in the address-editing form
 305     $newSequence = array_merge($newSequence, $addressSequence);
 306     $newSequence = array_unique($newSequence);
 307     return $newSequence;
 308   }
 309
 310 }