<?php
/*
+--------------------------------------------------------------------+
- | CiviCRM version 4.5 |
+ | CiviCRM version 4.6 |
+--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014 |
+ | Copyright CiviCRM LLC (c) 2004-2015 |
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
| GNU Affero General Public License or the licensing of CiviCRM, |
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
+--------------------------------------------------------------------+
-*/
+ */
/**
* Address utilties
class CRM_Utils_Address {
/**
- * Format an address string from address fields and a format string
+ * Format an address string from address fields and a format string.
*
* Format an address basing on the address fields provided.
* Use Setting's address_format if there's no format specified.
*
- * @param array $fields the address fields
- * @param string $format the desired address format
- * @param boolean $microformat if true indicates, the address to be built in hcard-microformat standard.
- * @param boolean $mailing if true indicates, the call has been made from mailing label
- * @param boolean $individualFormat if true indicates, the call has been made for the contact of type 'individual'
+ * @param array $fields
+ * The address fields.
+ * @param string $format
+ * The desired address format.
+ * @param bool $microformat
+ * If true indicates, the address to be built in hcard-microformat standard.
+ * @param bool $mailing
+ * If true indicates, the call has been made from mailing label.
+ * @param bool $individualFormat
+ * If true indicates, the call has been made for the contact of type 'individual'.
*
* @param null $tokenFields
*
- * @return string formatted address string
+ * @return string
+ * formatted address string
*
- * @static
*/
- static function format(
+ public static function format(
$fields,
- $format = NULL,
- $microformat = FALSE,
- $mailing = FALSE,
+ $format = NULL,
+ $microformat = FALSE,
+ $mailing = FALSE,
$individualFormat = FALSE,
- $tokenFields = NULL
+ $tokenFields = NULL
) {
static $config = NULL;
if (!$format) {
- $format =
- CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, 'address_format');
+ $format = CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, 'address_format');
}
if ($mailing) {
- $format =
- CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, 'mailing_format');
+ $format = CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, 'mailing_format');
}
$formatted = $format;
}
if (!$microformat) {
- // replacements in case of Individual Name Format
+ // replacements in case of Individual Name Format
$replacements = array(
'contact.display_name' => CRM_Utils_Array::value('display_name', $fields),
'contact.individual_prefix' => CRM_Utils_Array::value('individual_prefix', $fields),
'contact.birth_date' => CRM_Utils_Array::value('birth_date', $fields),
'contact.gender' => CRM_Utils_Array::value('gender', $fields),
'contact.is_opt_out' => CRM_Utils_Array::value('is_opt_out', $fields),
- 'contact.home_URL' => CRM_Utils_Array::value('home_URL', $fields),
'contact.preferred_mail_format' => CRM_Utils_Array::value('preferred_mail_format', $fields),
'contact.phone' => CRM_Utils_Array::value('phone', $fields),
'contact.home_URL' => CRM_Utils_Array::value('home_URL', $fields),
else {
// remove \n from each line and only add at the end
// this hack solves formatting issue, when we convert nl2br
- $lines = array();
- $count = 1;
+ $lines = array();
+ $count = 1;
$finalFormatted = NULL;
$formattedArray = explode("\n", $formatted);
$formattedArray = array_filter($formattedArray);
*
* @return array
*/
- static function sequence($format) {
+ public static function sequence($format) {
// also compute and store the address sequence
$addressSequence = array(
'address_name',
$newSequence = array_unique($newSequence);
return $newSequence;
}
-}
+}