3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
15 * @copyright CiviCRM LLC https://civicrm.org/licensing
19 * This class provides the common functionality for sending email to one or a group of contact ids.
21 class CRM_Contact_Form_Task_LabelCommon
{
24 * Create labels (pdf).
26 * @param array $contactRows
27 * Associated array of contact data.
28 * @param string $format
29 * Format in which labels needs to be printed.
30 * @param string $fileName
31 * The name of the file to save the label in.
33 public static function createLabel(&$contactRows, &$format, $fileName = 'MailingLabels_CiviCRM.pdf') {
34 $pdf = new CRM_Utils_PDF_Label($format, 'mm');
38 //build contact string that needs to be printed
40 foreach ((array) $contactRows as $row => $value) {
41 foreach ($value as $k => $v) {
45 $pdf->AddPdfLabel($val);
48 $pdf->Output($fileName, 'D');
52 * Get the rows for the labels.
55 * @param int $locationTypeID
56 * @param bool $respectDoNotMail
57 * @param $mergeSameAddress
58 * @param bool $mergeSameHousehold
62 * Array of rows for labels
64 public static function getRows($contactIDs, $locationTypeID, $respectDoNotMail, $mergeSameAddress, $mergeSameHousehold) {
67 //get the address format sequence from the config file
68 $addressReturnProperties = CRM_Contact_Form_Task_LabelCommon
::getAddressReturnProperties();
70 //build the return properties
71 $returnProperties = ['display_name' => 1, 'contact_type' => 1, 'prefix_id' => 1];
72 $mailingFormat = Civi
::settings()->get('mailing_format');
74 $mailingFormatProperties = [];
76 $mailingFormatProperties = CRM_Utils_Token
::getReturnProperties($mailingFormat);
77 $returnProperties = array_merge($returnProperties, $mailingFormatProperties);
80 $customFormatProperties = [];
81 if (stristr($mailingFormat, 'custom_')) {
82 foreach ($mailingFormatProperties as $token => $true) {
83 if (substr($token, 0, 7) == 'custom_') {
84 if (empty($customFormatProperties[$token])) {
85 $customFormatProperties[$token] = $mailingFormatProperties[$token];
90 $returnProperties = array_merge($returnProperties, $customFormatProperties);
92 if ($mergeSameAddress) {
93 // we need first name/last name for summarising to avoid spillage
94 $returnProperties['first_name'] = 1;
95 $returnProperties['last_name'] = 1;
98 //get the contacts information
99 $params = $custom = [];
100 foreach ($contactIDs as $key => $contactID) {
102 CRM_Core_Form
::CB_PREFIX
. $contactID,
111 if (!empty($respectDoNotMail['do_not_mail'])) {
112 $params[] = ['do_not_mail', '=', 0, 0, 0];
115 $params[] = ['is_deceased', '=', 0, 0, 0];
117 if ($locationTypeID) {
118 $locType = CRM_Core_PseudoConstant
::get('CRM_Core_DAO_Address', 'location_type_id');
119 $locName = $locType[$locationTypeID];
120 $location = ['location' => ["{$locName}" => $addressReturnProperties]];
121 $returnProperties = array_merge($returnProperties, $location);
122 $params[] = ['location_type', '=', [$locationTypeID => 1], 0, 0];
125 $returnProperties = array_merge($returnProperties, $addressReturnProperties);
128 foreach ($returnProperties as $name) {
129 $cfID = CRM_Core_BAO_CustomField
::getKeyID($name);
135 //get the total number of contacts to fetch from database.
136 $numberofContacts = count($contactIDs);
137 //this does the same as calling civicrm_api3('contact, get, array('id' => array('IN' => $this->_contactIds)
138 // except it also handles multiple locations
139 $query = new CRM_Contact_BAO_Query($params, $returnProperties);
140 $details = $query->apiQuery($params, $returnProperties, NULL, NULL, 0, $numberofContacts);
142 $messageToken = CRM_Utils_Token
::getTokens($mailingFormat);
143 $details = $details[0];
144 $tokenFields = CRM_Contact_Form_Task_LabelCommon
::getTokenData($details);
146 foreach ($contactIDs as $value) {
147 foreach ($custom as $cfID) {
148 if (isset($details[$value]["custom_{$cfID}"])) {
149 $details[$value]["custom_{$cfID}"] = CRM_Core_BAO_CustomField
::displayValue($details[$value]["custom_{$cfID}"], $cfID);
152 $contact = $details[$value] ??
NULL;
154 if (is_a($contact, 'CRM_Core_Error')) {
158 // we need to remove all the "_id"
159 unset($contact['contact_id']);
161 if ($locName && !empty($contact[$locName])) {
162 // If location type is not primary, $contact contains
163 // one more array as "$contact[$locName] = array( values... )"
165 if (!CRM_Contact_Form_Task_Label
::tokenIsFound($contact, $mailingFormatProperties, $tokenFields)) {
169 unset($contact[$locName]);
171 if (!empty($contact['county_id'])) {
172 unset($contact['county_id']);
175 foreach ($contact as $field => $fieldValue) {
176 $rows[$value][$field] = $fieldValue;
180 $paramsothers = ['contact_id' => $value];
181 $valuesothers = CRM_Core_BAO_Location
::getValues($paramsothers, $valuesothers);
182 if ($locationTypeID) {
183 foreach ($valuesothers as $vals) {
184 if (CRM_Utils_Array
::value('location_type_id', $vals) ==
187 foreach ($vals as $k => $v) {
195 $rows[$value][$k] = $v['1']['name'];
198 $rows[$value][$k] = $v['1'][$k];
200 $rows[$value][$k . '_id'] = $v['1']['id'];
208 if (!CRM_Contact_Form_Task_Label
::tokenIsFound($contact, $mailingFormatProperties, $tokenFields)) {
212 if (!empty($contact['addressee_display'])) {
213 $contact['addressee_display'] = trim($contact['addressee_display']);
215 if (!empty($contact['addressee'])) {
216 $contact['addressee'] = $contact['addressee_display'];
219 // now create the rows for generating mailing labels
220 foreach ($contact as $field => $fieldValue) {
221 $rows[$value][$field] = $fieldValue;
225 // sigh couldn't extract out tokenfields yet
226 return [$rows, $tokenFields];
230 * Get array of return properties for address fields required for mailing label.
233 * return properties for address e.g
234 * [street_address => 1, supplemental_address_1 => 1, supplemental_address_2 => 1]
236 public static function getAddressReturnProperties() {
237 $mailingFormat = Civi
::settings()->get('mailing_format');
239 $addressFields = CRM_Utils_Address
::sequence($mailingFormat);
240 $addressReturnProperties = array_fill_keys($addressFields, 1);
242 if (array_key_exists('postal_code', $addressReturnProperties)) {
243 $addressReturnProperties['postal_code_suffix'] = 1;
245 return $addressReturnProperties;
249 * Get token list from mailing format & contacts
250 * @param array $contacts
253 public static function getTokenData(&$contacts) {
254 $mailingFormat = Civi
::settings()->get('mailing_format');
255 $tokens = $tokenFields = [];
256 $messageToken = CRM_Utils_Token
::getTokens($mailingFormat);
258 // also get all token values
259 CRM_Utils_Hook
::tokenValues($contacts,
260 array_keys($contacts),
263 'CRM_Contact_Form_Task_LabelCommon'
266 CRM_Utils_Hook
::tokens($tokens);
268 foreach ($tokens as $category => $catTokens) {
269 foreach ($catTokens as $token => $tokenName) {
270 $tokenFields[] = $token;
282 public function mergeSameHousehold(&$rows) {
283 // group selected contacts by type
286 foreach ($rows as $contact_id => $row) {
287 if ($row['contact_type'] == 'Household') {
288 $households[$contact_id] = $row;
290 elseif ($row['contact_type'] == 'Individual') {
291 $individuals[$contact_id] = $row;
295 // exclude individuals belonging to selected households
296 foreach ($households as $household_id => $row) {
297 $dao = new CRM_Contact_DAO_Relationship();
298 $dao->contact_id_b
= $household_id;
300 while ($dao->fetch()) {
301 $individual_id = $dao->contact_id_a
;
302 if (array_key_exists($individual_id, $individuals)) {
303 unset($individuals[$individual_id]);
308 // merge back individuals and households
309 $rows = array_merge($individuals, $households);