CRM/Utils/Address.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.5                                                |
   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            the address fields
  42    * @param string  $format            the desired address format
  43    * @param boolean $microformat       if true indicates, the address to be built in hcard-microformat standard.
  44    * @param boolean $mailing           if true indicates, the call has been made from mailing label
  45    * @param boolean $individualFormat  if true indicates, the call has been made for the contact of type 'individual'
  46    *
  47    * @return string  formatted address string
  48    *
  49    * @static
  50    */
  51   static function format(
  52     $fields,
  53     $format           = NULL,
  54     $microformat      = FALSE,
  55     $mailing          = FALSE,
  56     $individualFormat = FALSE,
  57     $tokenFields      = NULL
  58   ) {
  59     static $config = NULL;
  60
  61     if (!$format) {
  62       $format =
  63         CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, 'address_format');
  64     }
  65
  66     if ($mailing) {
  67       $format =
  68         CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, 'mailing_format');
  69     }
  70
  71     $formatted = $format;
  72
  73     $fullPostalCode = CRM_Utils_Array::value('postal_code', $fields);
  74     if (!empty($fields['postal_code_suffix'])) {
  75       $fullPostalCode .= "-$fields[postal_code_suffix]";
  76     }
  77
  78     // make sure that some of the fields do have values
  79     $emptyFields = array(
  80       'supplemental_address_1',
  81       'supplemental_address_2',
  82       'state_province_name',
  83       'county',
  84     );
  85     foreach ($emptyFields as $f) {
  86       if (!isset($fields[$f])) {
  87         $fields[$f] = NULL;
  88       }
  89     }
  90
  91     $contactName = CRM_Utils_Array::value('display_name', $fields);
  92     if (!$individualFormat) {
  93       if (isset($fields['id'])) {
  94         $type = CRM_Contact_BAO_Contact::getContactType($fields['id']);
  95       }
  96       else {
  97         $type = 'Individual';
  98       }
  99
 100       if ($type == 'Individual') {
 101         $contactName = CRM_Utils_Array::value('addressee_display', $fields);
 102       }
 103     }
 104
 105     if (!$microformat) {
 106         // replacements in case of Individual Name Format
 107       $replacements = array(
 108         'contact.display_name' => CRM_Utils_Array::value('display_name', $fields),
 109         'contact.individual_prefix' => CRM_Utils_Array::value('individual_prefix', $fields),
 110         'contact.formal_title' => CRM_Utils_Array::value('formal_title', $fields),
 111         'contact.first_name' => CRM_Utils_Array::value('first_name', $fields),
 112         'contact.middle_name' => CRM_Utils_Array::value('middle_name', $fields),
 113         'contact.last_name' => CRM_Utils_Array::value('last_name', $fields),
 114         'contact.individual_suffix' => CRM_Utils_Array::value('individual_suffix', $fields),
 115         'contact.address_name' => CRM_Utils_Array::value('address_name', $fields),
 116         'contact.street_address' => CRM_Utils_Array::value('street_address', $fields),
 117         'contact.supplemental_address_1' => CRM_Utils_Array::value('supplemental_address_1', $fields),
 118         'contact.supplemental_address_2' => CRM_Utils_Array::value('supplemental_address_2', $fields),
 119         'contact.city' => CRM_Utils_Array::value('city', $fields),
 120         'contact.state_province_name' => CRM_Utils_Array::value('state_province_name', $fields),
 121         'contact.county' => CRM_Utils_Array::value('county', $fields),
 122         'contact.state_province' => CRM_Utils_Array::value('state_province', $fields),
 123         'contact.postal_code' => $fullPostalCode,
 124         'contact.country' => CRM_Utils_Array::value('country', $fields),
 125         'contact.world_region' => CRM_Utils_Array::value('world_region', $fields),
 126         'contact.geo_code_1' => CRM_Utils_Array::value('geo_code_1', $fields),
 127         'contact.geo_code_2' => CRM_Utils_Array::value('geo_code_2', $fields),
 128         'contact.current_employer' => CRM_Utils_Array::value('current_employer', $fields),
 129         'contact.nick_name' => CRM_Utils_Array::value('nick_name', $fields),
 130         'contact.email' => CRM_Utils_Array::value('email', $fields),
 131         'contact.im' => CRM_Utils_Array::value('im', $fields),
 132         'contact.do_not_email' => CRM_Utils_Array::value('do_not_email', $fields),
 133         'contact.do_not_phone' => CRM_Utils_Array::value('do_not_phone', $fields),
 134         'contact.do_not_mail' => CRM_Utils_Array::value('do_not_mail', $fields),
 135         'contact.do_not_sms' => CRM_Utils_Array::value('do_not_sms', $fields),
 136         'contact.do_not_trade' => CRM_Utils_Array::value('do_not_trade', $fields),
 137         'contact.job_title' => CRM_Utils_Array::value('job_title', $fields),
 138         'contact.birth_date' => CRM_Utils_Array::value('birth_date', $fields),
 139         'contact.gender' => CRM_Utils_Array::value('gender', $fields),
 140         'contact.is_opt_out' => CRM_Utils_Array::value('is_opt_out', $fields),
 141         'contact.home_URL' => CRM_Utils_Array::value('home_URL', $fields),
 142         'contact.preferred_mail_format' => CRM_Utils_Array::value('preferred_mail_format', $fields),
 143         'contact.phone' => CRM_Utils_Array::value('phone', $fields),
 144         'contact.home_URL' => CRM_Utils_Array::value('home_URL', $fields),
 145         'contact.contact_source' => CRM_Utils_Array::value('contact_source', $fields),
 146         'contact.external_identifier' => CRM_Utils_Array::value('external_identifier', $fields),
 147         'contact.contact_id' => CRM_Utils_Array::value('id', $fields),
 148         'contact.household_name' => CRM_Utils_Array::value('display_name', $fields),
 149         'contact.organization_name' => CRM_Utils_Array::value('display_name', $fields),
 150         'contact.legal_name' => CRM_Utils_Array::value('legal_name', $fields),
 151         'contact.preferred_communication_method' => CRM_Utils_Array::value('preferred_communication_method', $fields),
 152         'contact.communication_style' => CRM_Utils_Array::value('communication_style', $fields),
 153         'contact.addressee' => CRM_Utils_Array::value('addressee_display', $fields),
 154         'contact.email_greeting' => CRM_Utils_Array::value('email_greeting_display', $fields),
 155         'contact.postal_greeting' => CRM_Utils_Array::value('postal_greeting_display', $fields),
 156       );
 157     }
 158     else {
 159       $replacements = array(
 160         'contact.address_name' => "<span class=\"address-name\">" . $fields['address_name'] . "</span>",
 161         'contact.street_address' => "<span class=\"street-address\">" . $fields['street_address'] . "</span>",
 162         'contact.supplemental_address_1' => "<span class=\"extended-address\">" . $fields['supplemental_address_1'] . "</span>",
 163         'contact.supplemental_address_2' => $fields['supplemental_address_2'],
 164         'contact.city' => "<span class=\"locality\">" . $fields['city'] . "</span>",
 165         'contact.state_province_name' => "<span class=\"region\">" . $fields['state_province_name'] . "</span>",
 166         'contact.county' => "<span class=\"region\">" . $fields['county'],
 167         'contact.state_province' => "<span class=\"region\">" . $fields['state_province'] . "</span>",
 168         'contact.postal_code' => "<span class=\"postal-code\">" . $fullPostalCode . "</span>",
 169         'contact.country' => "<span class=\"country-name\">" . $fields['country'] . "</span>",
 170         'contact.world_region' => "<span class=\"region\">" . $fields['world_region'] . "</span>",
 171       );
 172
 173       // erase all empty ones, so we dont get blank lines
 174       foreach (array_keys($replacements) as $key) {
 175         $exactKey = substr($key, 0, 8) == 'contact.' ? substr($key, 8) : $key;
 176         if ($key != 'contact.postal_code' &&
 177           CRM_Utils_Array::value($exactKey, $fields) == NULL
 178         ) {
 179           $replacements[$key] = '';
 180         }
 181       }
 182       if (empty($fullPostalCode)) {
 183         $replacements['contact.postal_code'] = '';
 184       }
 185     }
 186
 187     // replacements in case of Custom Token
 188     if (stristr($formatted, 'custom_')) {
 189       $customToken = array_keys($fields);
 190       foreach ($customToken as $value) {
 191         if (substr($value, 0, 7) == 'custom_') {
 192           $replacements["contact.{$value}"] = $fields["{$value}"];
 193         }
 194       }
 195     }
 196
 197     // also sub all token fields
 198     if ($tokenFields) {
 199       foreach ($tokenFields as $token) {
 200         $replacements["{$token}"] = CRM_Utils_Array::value("{$token}", $fields);
 201       }
 202     }
 203
 204     // for every token, replace {fooTOKENbar} with fooVALUEbar if
 205     // the value is not empty, otherwise drop the whole {fooTOKENbar}
 206     foreach ($replacements as $token => $value) {
 207       if ($value && is_string($value)) {
 208         $formatted = preg_replace("/{([^{}]*)\b{$token}\b([^{}]*)}/u", "\${1}{$value}\${2}", $formatted);
 209       }
 210       else {
 211         $formatted = preg_replace("/{[^{}]*\b{$token}\b[^{}]*}/u", '', $formatted);
 212       }
 213     }
 214
 215     // drop any {...} constructs from lines' ends
 216     if (!$microformat) {
 217       $formatted = "\n$formatted\n";
 218     }
 219     else {
 220       if ($microformat == 1) {
 221         $formatted = "\n<div class=\"location vcard\"><span class=\"adr\">\n$formatted</span></div>\n";
 222       }
 223       else {
 224         $formatted = "\n<div class=\"vcard\"><span class=\"adr\">$formatted</span></div>\n";
 225       }
 226     }
 227
 228     $formatted = preg_replace('/\n{[^{}]*}/u', "\n", $formatted);
 229     $formatted = preg_replace('/{[^{}]*}\n/u', "\n", $formatted);
 230
 231     // if there are any 'sibling' {...} constructs, replace them with the
 232     // contents of the first one; for example, when there's no state_province:
 233     // 1. {city}{, }{state_province}{ }{postal_code}
 234     // 2. San Francisco{, }{ }12345
 235     // 3. San Francisco, 12345
 236     $formatted = preg_replace('/{([^{}]*)}({[^{}]*})+/u', '\1', $formatted);
 237
 238     // drop any remaining curly braces leaving their contents
 239     $formatted = str_replace(array('{', '}'), '', $formatted);
 240
 241     // drop any empty lines left after the replacements
 242     $formatted = preg_replace('/^[ \t]*[\r\n]+/m', '', $formatted);
 243
 244     if (!$microformat) {
 245       $finalFormatted = $formatted;
 246     }
 247     else {
 248       // remove \n from each line and only add at the end
 249       // this hack solves formatting issue, when we convert nl2br
 250       $lines          = array();
 251       $count          = 1;
 252       $finalFormatted = NULL;
 253       $formattedArray = explode("\n", $formatted);
 254       $formattedArray = array_filter($formattedArray);
 255
 256       foreach ($formattedArray as $line) {
 257         $line = trim($line);
 258         if ($line) {
 259           if ($count > 1 && $count < count($formattedArray)) {
 260             $line = "$line\n";
 261           }
 262           $finalFormatted .= $line;
 263           $count++;
 264         }
 265       }
 266     }
 267     return $finalFormatted;
 268   }
 269
 270   static function sequence($format) {
 271     // also compute and store the address sequence
 272     $addressSequence = array(
 273       'address_name',
 274       'street_address',
 275       'supplemental_address_1',
 276       'supplemental_address_2',
 277       'city',
 278       'county',
 279       'state_province',
 280       'postal_code',
 281       'country',
 282     );
 283
 284     // get the field sequence from the format
 285     $newSequence = array();
 286     foreach ($addressSequence as $field) {
 287       if (substr_count($format, $field)) {
 288         $newSequence[strpos($format, $field)] = $field;
 289       }
 290     }
 291     ksort($newSequence);
 292
 293     // add the addressSequence fields that are missing in the addressFormat
 294     // to the end of the list, so that (for example) if state_province is not
 295     // specified in the addressFormat it's still in the address-editing form
 296     $newSequence = array_merge($newSequence, $addressSequence);
 297     $newSequence = array_unique($newSequence);
 298     return $newSequence;
 299   }
 300 }
 301