3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | This file is a part of CiviCRM. |
8 | CiviCRM is free software; you can copy, modify, and distribute it |
9 | under the terms of the GNU Affero General Public License |
10 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
12 | CiviCRM is distributed in the hope that it will be useful, but |
13 | WITHOUT ANY WARRANTY; without even the implied warranty of |
14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
15 | See the GNU Affero General Public License for more details. |
17 | You should have received a copy of the GNU Affero General Public |
18 | License and the CiviCRM Licensing Exception along |
19 | with this program; if not, contact CiviCRM LLC |
20 | at info[AT]civicrm[DOT]org. If you have questions about the |
21 | GNU Affero General Public License or the licensing of CiviCRM, |
22 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
23 +--------------------------------------------------------------------+
29 * @copyright CiviCRM LLC (c) 2004-2014
35 * Class CRM_Badge_Format_Badge
37 * parent class for building name badges
39 class CRM_Badge_BAO_Badge
{
41 public $debug = FALSE;
46 * This function is called to create name label pdf
48 * @param array $participants associated array with participant info
49 * @param array $layoutInfo associated array which contains meta data about format/layout
54 public function createLabels(&$participants, &$layoutInfo) {
55 $this->pdf
= new CRM_Utils_PDF_Label($layoutInfo['format'], 'mm');
57 $this->pdf
->setPrintHeader(FALSE);
58 $this->pdf
->setPrintFooter(FALSE);
59 $this->pdf
->AddPage();
60 $this->pdf
->SetGenerator($this, "generateLabel");
62 // this is very useful for debugging, by default set to FALSE
64 $this->border
= "LTRB";
67 foreach ($participants as $participant) {
68 $formattedRow = self
::formatLabel($participant, $layoutInfo);
69 $this->pdf
->AddPdfLabel($formattedRow);
72 $this->pdf
->Output(CRM_Utils_String
::munge($layoutInfo['title'], '_', 64) . '.pdf', 'D');
73 CRM_Utils_System
::civiExit(1);
77 * Funtion to create structure and add meta data according to layout
79 * @param array $row row element that needs to be formatted
80 * @param array $layout layout meta data
82 * @return array $formattedRow row with meta data
84 static function formatLabel(&$row, &$layout) {
85 $formattedRow = array('labelFormat' => $layout['label_format_name']);
86 $formattedRow['labelTitle'] = $layout['title'];
87 $formattedRow['labelId'] = $layout['id'];
90 if (!empty($layout['data']['rowElements'])) {
91 foreach ($layout['data']['rowElements'] as $key => $element) {
94 $value = $row[$element];
95 // hack to fix date field display format
96 if (strpos($element, '_date')) {
97 $value = CRM_Utils_Date
::customFormat($value, "%B %E%f");
101 $formattedRow['token'][$key] = array(
103 'font_name' => $layout['data']['font_name'][$key],
104 'font_size' => $layout['data']['font_size'][$key],
105 'font_style' => $layout['data']['font_style'][$key],
106 'text_alignment' => $layout['data']['text_alignment'][$key],
107 'token' => $layout['data']['token'][$key],
112 if (!empty($layout['data']['image_1'])) {
113 $formattedRow['image_1'] = $layout['data']['image_1'];
115 if (!empty($layout['data']['width_image_1'])) {
116 $formattedRow['width_image_1'] = $layout['data']['width_image_1'];
118 if (!empty($layout['data']['height_image_1'])) {
119 $formattedRow['height_image_1'] = $layout['data']['height_image_1'];
122 if (!empty($layout['data']['image_2'])) {
123 $formattedRow['image_2'] = $layout['data']['image_2'];
125 if (!empty($layout['data']['width_image_2'])) {
126 $formattedRow['width_image_2'] = $layout['data']['width_image_2'];
128 if (!empty($layout['data']['height_image_2'])) {
129 $formattedRow['height_image_2'] = $layout['data']['height_image_2'];
131 if (!empty($row['image_URL']) && $layout['data']['show_participant_image'])
133 $formattedRow['participant_image'] = $row['image_URL'];
135 if (!empty($layout['data']['width_participant_image'])) {
136 $formattedRow['width_participant_image'] = $layout['data']['width_participant_image'];
138 if (!empty($layout['data']['height_participant_image'])) {
139 $formattedRow['height_participant_image'] = $layout['data']['height_participant_image'];
141 if (!empty($layout['data']['alignment_participant_image'])) {
142 $formattedRow['alignment_participant_image'] = $layout['data']['alignment_participant_image'];
145 if (!empty($layout['data']['add_barcode'])) {
146 $formattedRow['barcode'] = array(
147 'alignment' => $layout['data']['barcode_alignment'],
148 'type' => $layout['data']['barcode_type'],
152 // finally assign all the row values, so that we can use it for barcode etc
153 $formattedRow['values'] = $row;
155 return $formattedRow;
158 public function generateLabel($formattedRow) {
159 switch ($formattedRow['labelFormat']) {
160 case 'A6 Badge Portrait 150x106':
161 case 'Hanging Badge 3-3/4" x 4-3"/4':
162 self
::labelCreator($formattedRow, 5);
166 self
::labelCreator($formattedRow);
171 public function labelCreator(&$formattedRow, $cellspacing = 0) {
173 $this->lMarginLogo
= 18;
174 $this->tMarginName
= 20;
176 $x = $this->pdf
->GetAbsX();
177 $y = $this->pdf
->getY();
179 //call hook alterBadge
180 CRM_Utils_Hook
::alterBadge($formattedRow['labelTitle'], $this, $formattedRow,$formattedRow['values']);
183 if (!empty($formattedRow['image_1'])) {
184 $this->printImage($formattedRow['image_1'], NULL, NULL, CRM_Utils_Array
::value('width_image_1', $formattedRow),
185 CRM_Utils_Array
::value('height_image_1', $formattedRow));
188 if (!empty($formattedRow['image_2'])) {
189 $this->printImage($formattedRow['image_2'], $x +
68, NULL, CRM_Utils_Array
::value('width_image_2', $formattedRow),
190 CRM_Utils_Array
::value('height_image_2', $formattedRow));
193 if ((CRM_Utils_Array
::value('height_image_1', $formattedRow) >
194 CRM_Utils_Array
::value('height_image_2', $formattedRow)) && !empty($formattedRow['height_image_1'])) {
195 $startOffset = CRM_Utils_Array
::value('height_image_1', $formattedRow);
197 elseif (!empty($formattedRow['height_image_2'])) {
198 $startOffset = CRM_Utils_Array
::value('height_image_2', $formattedRow);
201 if (CRM_Utils_Array
::value('participant_image', $formattedRow)){
203 switch (CRM_Utils_Array
::value('alignment_participant_image', $formattedRow)){
213 $this->pdf
->Image($formattedRow['participant_image'], $x+
$imageAlign, $y +
$startOffset, CRM_Utils_Array
::value('width_participant_image', $formattedRow), CRM_Utils_Array
::value('height_participant_image', $formattedRow));
214 if ($startOffset == NULL && CRM_Utils_Array
::value('height_participant_image', $formattedRow)){
215 $startOffset = CRM_Utils_Array
::value('height_participant_image', $formattedRow);
219 $this->pdf
->SetLineStyle(array(
224 'color' => array(0, 0, 200)
227 $rowCount = CRM_Badge_Form_Layout
::FIELD_ROWCOUNT
;
228 for ($i = 1; $i <= $rowCount; $i++
) {
229 if (!empty($formattedRow['token'][$i]['token'])) {
231 if ($formattedRow['token'][$i]['token'] != 'spacer') {
232 $value = $formattedRow['token'][$i]['value'];
236 $rowWidth = $this->pdf
->width
;
237 if (!empty($formattedRow['participant_image']) && !empty($formattedRow['width_participant_image']))
239 $rowWidth = $this->pdf
->width
- $formattedRow['width_participant_image'];
240 if ($formattedRow['alignment_participant_image']== 'L')
241 $xAlign = $x +
$formattedRow['width_participant_image'] +
$imageAlign;
243 $offset = $this->pdf
->getY() +
$startOffset +
$cellspacing;
245 $this->pdf
->SetFont($formattedRow['token'][$i]['font_name'], $formattedRow['token'][$i]['font_style'],
246 $formattedRow['token'][$i]['font_size']);
247 $this->pdf
->MultiCell($rowWidth, 0, $value,
248 $this->border
, $formattedRow['token'][$i]['text_alignment'], 0, 1, $xAlign, $offset);
250 // set this to zero so that it is added only for first element
255 if (!empty($formattedRow['barcode'])) {
256 $data = $formattedRow['values'];
258 if ($formattedRow['barcode']['type'] == 'barcode') {
259 $data['current_value'] =
260 $formattedRow['values']['contact_id'] . '-' . $formattedRow['values']['participant_id'];
263 // view participant url
264 $data['current_value'] = CRM_Utils_System
::url('civicrm/contact/view/participant',
265 'action=view&reset=1&cid=' . $formattedRow['values']['contact_id'] . '&id='
266 . $formattedRow['values']['participant_id'],
273 // call hook alterBarcode
274 CRM_Utils_Hook
::alterBarcode($data, $formattedRow['barcode']['type']);
276 if ($formattedRow['barcode']['type'] == 'barcode') {
280 switch ($formattedRow['barcode']['alignment']) {
297 'cellfitalign' => '',
300 'vpadding' => 'auto',
301 'fgcolor' => array(0, 0, 0),
304 'font' => 'helvetica',
309 $this->pdf
->write1DBarcode($data['current_value'], 'C128', $xAlign, $y +
$this->pdf
->height
- 10, '70',
310 12, 0.4, $style, 'B');
316 switch ($formattedRow['barcode']['alignment']) {
331 'vpadding' => 'auto',
332 'fgcolor' => array(0,0,0),
337 $this->pdf
->write2DBarcode($data['current_value'], 'QRCODE,H', $xAlign, $y +
$this->pdf
->height
- 26, 30,
344 * Helper function to print images
346 * @param string $img image url
356 function printImage($img, $x = '', $y = '', $w = NULL, $h = NULL) {
358 $x = $this->pdf
->GetAbsX();
362 $y = $this->pdf
->GetY();
368 list($w, $h) = self
::getImageProperties($img, $this->imgRes
, $w, $h);
369 $this->pdf
->Image($img, $x, $y, $w, $h, '', '', '', FALSE, 72, '', FALSE,
370 FALSE, $this->debug
, FALSE, FALSE, FALSE);
372 $this->pdf
->SetXY($x, $y);
375 static function getImageProperties($img, $imgRes = 300, $w = NULL, $h = NULL) {
376 $imgsize = getimagesize($img);
378 $w = !empty($w) ?
$w : $imgsize[0] / $f;
379 $h = !empty($h) ?
$h : $imgsize[1] / $f;
380 return array($w, $h);
384 * function to build badges parameters before actually creating badges.
386 * @param array $params associated array of submitted values
388 * @params object $form form/controller object
394 public static function buildBadges(&$params, &$form) {
395 // get name badge layout info
396 $layoutInfo = CRM_Badge_BAO_Layout
::buildLayout($params);
398 // spit / get actual field names from tokeni and individual contact image URLs
399 $returnProperties = array();
400 if (!empty($layoutInfo['data']['token'])) {
401 foreach ($layoutInfo['data']['token'] as $index => $value) {
404 $token = CRM_Utils_Token
::getTokens($value);
405 if (key($token) == 'contact') {
406 $element = $token['contact'][0];
408 elseif (key($token) == 'event') {
409 $element = $token['event'][0];
410 //FIX ME - we need to standardize event token names
411 if (substr($element, 0, 6) != 'event_') {
412 $element = 'event_' . $element;
415 elseif (key($token) == 'participant') {
416 $element = $token['participant'][0];
419 // build returnproperties for query
420 $returnProperties[$element] = 1;
423 // add actual field name to row element
424 $layoutInfo['data']['rowElements'][$index] = $element;
428 // add additional required fields for query execution
429 $additionalFields = array('participant_register_date', 'participant_id', 'event_id', 'contact_id', 'image_URL');
430 foreach ($additionalFields as $field) {
431 $returnProperties[$field] = 1;
434 if ($form->_single
) {
438 $queryParams = $form->get('queryParams');
441 $query = new CRM_Contact_BAO_Query($queryParams, $returnProperties, NULL, FALSE, FALSE,
442 CRM_Contact_BAO_Query
::MODE_EVENT
445 list($select, $from, $where, $having) = $query->query();
447 $where = "WHERE {$form->_componentClause}";
450 $where .= " AND {$form->_componentClause}";
454 if ($form->get(CRM_Utils_Sort
::SORT_ORDER
)) {
455 $sortOrder = $form->get(CRM_Utils_Sort
::SORT_ORDER
);
456 if (!empty($sortOrder)) {
457 $sortOrder = " ORDER BY $sortOrder";
460 $queryString = "$select $from $where $having $sortOrder";
462 $dao = CRM_Core_DAO
::executeQuery($queryString);
464 while ($dao->fetch()) {
465 $rows[$dao->participant_id
] = array();
466 foreach ($returnProperties as $key => $dontCare) {
467 $rows[$dao->participant_id
][$key] = isset($dao->$key) ?
$dao->$key : NULL;
471 $eventBadgeClass = new CRM_Badge_BAO_Badge();
472 $eventBadgeClass->createLabels($rows, $layoutInfo);