501 lines
16 KiB
PHP
501 lines
16 KiB
PHP
|
<?php
|
||
|
|
/*
|
||
|
|
+--------------------------------------------------------------------+
|
||
|
|
| CiviCRM version 4.7 |
|
||
|
|
+--------------------------------------------------------------------+
|
||
|
|
| This file is a part of CiviCRM. |
|
||
|
|
| |
|
||
|
|
| CiviCRM is free software; you can copy, modify, and distribute it |
|
||
|
|
| under the terms of the GNU Affero General Public License |
|
||
|
|
| Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
|
||
|
|
| |
|
||
|
|
| CiviCRM is distributed in the hope that it will be useful, but |
|
||
|
|
| WITHOUT ANY WARRANTY; without even the implied warranty of |
|
||
|
|
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
|
||
|
|
| See the GNU Affero General Public License for more details. |
|
||
|
|
| |
|
||
|
|
| You should have received a copy of the GNU Affero General Public |
|
||
|
|
| License and the CiviCRM Licensing Exception along |
|
||
|
|
| with this program; if not, contact CiviCRM LLC |
|
||
|
|
| at info[AT]civicrm[DOT]org. If you have questions about the |
|
||
|
|
| GNU Affero General Public License or the licensing of CiviCRM, |
|
||
|
|
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
|
||
|
|
+--------------------------------------------------------------------+
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
*
|
||
|
|
* @package CRM
|
||
|
|
* @copyright CiviCRM LLC (c) 2004-2017
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Class CRM_Badge_Format_Badge.
|
||
|
|
*
|
||
|
|
* parent class for building name badges
|
||
|
|
*/
|
||
|
|
class CRM_Badge_BAO_Badge {
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @var bool
|
||
|
|
*/
|
||
|
|
public $debug = FALSE;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @var int
|
||
|
|
*/
|
||
|
|
public $border = 0;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* This function is called to create name label pdf.
|
||
|
|
*
|
||
|
|
* @param array $participants
|
||
|
|
* Associated array with participant info.
|
||
|
|
* @param array $layoutInfo
|
||
|
|
* Associated array which contains meta data about format/layout.
|
||
|
|
*/
|
||
|
|
public function createLabels(&$participants, &$layoutInfo) {
|
||
|
|
$this->pdf = new CRM_Utils_PDF_Label($layoutInfo['format'], 'mm');
|
||
|
|
$this->pdf->Open();
|
||
|
|
$this->pdf->setPrintHeader(FALSE);
|
||
|
|
$this->pdf->setPrintFooter(FALSE);
|
||
|
|
$this->pdf->AddPage();
|
||
|
|
$this->pdf->SetGenerator($this, "generateLabel");
|
||
|
|
|
||
|
|
// this is very useful for debugging, by default set to FALSE
|
||
|
|
if ($this->debug) {
|
||
|
|
$this->border = "LTRB";
|
||
|
|
}
|
||
|
|
|
||
|
|
foreach ($participants as $participant) {
|
||
|
|
$formattedRow = self::formatLabel($participant, $layoutInfo);
|
||
|
|
$this->pdf->AddPdfLabel($formattedRow);
|
||
|
|
}
|
||
|
|
|
||
|
|
$this->pdf->Output(CRM_Utils_String::munge($layoutInfo['title'], '_', 64) . '.pdf', 'D');
|
||
|
|
CRM_Utils_System::civiExit(1);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Function to create structure and add meta data according to layout.
|
||
|
|
*
|
||
|
|
* @param array $row
|
||
|
|
* Row element that needs to be formatted.
|
||
|
|
* @param array $layout
|
||
|
|
* Layout meta data.
|
||
|
|
*
|
||
|
|
* @return array
|
||
|
|
* row with meta data
|
||
|
|
*/
|
||
|
|
public static function formatLabel(&$row, &$layout) {
|
||
|
|
$formattedRow = array('labelFormat' => $layout['label_format_name']);
|
||
|
|
$formattedRow['labelTitle'] = $layout['title'];
|
||
|
|
$formattedRow['labelId'] = $layout['id'];
|
||
|
|
|
||
|
|
if (!empty($layout['data']['rowElements'])) {
|
||
|
|
foreach ($layout['data']['rowElements'] as $key => $element) {
|
||
|
|
$value = '';
|
||
|
|
if ($element) {
|
||
|
|
$value = $row[$element];
|
||
|
|
// hack to fix date field display format
|
||
|
|
if (strpos($element, '_date')) {
|
||
|
|
$value = CRM_Utils_Date::customFormat($value, "%B %E%f");
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
$formattedRow['token'][$key] = array(
|
||
|
|
'value' => $value,
|
||
|
|
'font_name' => $layout['data']['font_name'][$key],
|
||
|
|
'font_size' => $layout['data']['font_size'][$key],
|
||
|
|
'font_style' => $layout['data']['font_style'][$key],
|
||
|
|
'text_alignment' => $layout['data']['text_alignment'][$key],
|
||
|
|
'token' => $layout['data']['token'][$key],
|
||
|
|
);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
if (!empty($layout['data']['image_1'])) {
|
||
|
|
$formattedRow['image_1'] = $layout['data']['image_1'];
|
||
|
|
}
|
||
|
|
if (!empty($layout['data']['width_image_1'])) {
|
||
|
|
$formattedRow['width_image_1'] = $layout['data']['width_image_1'];
|
||
|
|
}
|
||
|
|
if (!empty($layout['data']['height_image_1'])) {
|
||
|
|
$formattedRow['height_image_1'] = $layout['data']['height_image_1'];
|
||
|
|
}
|
||
|
|
|
||
|
|
if (!empty($layout['data']['image_2'])) {
|
||
|
|
$formattedRow['image_2'] = $layout['data']['image_2'];
|
||
|
|
}
|
||
|
|
if (!empty($layout['data']['width_image_2'])) {
|
||
|
|
$formattedRow['width_image_2'] = $layout['data']['width_image_2'];
|
||
|
|
}
|
||
|
|
if (!empty($layout['data']['height_image_2'])) {
|
||
|
|
$formattedRow['height_image_2'] = $layout['data']['height_image_2'];
|
||
|
|
}
|
||
|
|
if (!empty($row['image_URL']) && !empty($layout['data']['show_participant_image'])) {
|
||
|
|
$formattedRow['participant_image'] = $row['image_URL'];
|
||
|
|
}
|
||
|
|
if (!empty($layout['data']['width_participant_image'])) {
|
||
|
|
$formattedRow['width_participant_image'] = $layout['data']['width_participant_image'];
|
||
|
|
}
|
||
|
|
if (!empty($layout['data']['height_participant_image'])) {
|
||
|
|
$formattedRow['height_participant_image'] = $layout['data']['height_participant_image'];
|
||
|
|
}
|
||
|
|
if (!empty($layout['data']['alignment_participant_image'])) {
|
||
|
|
$formattedRow['alignment_participant_image'] = $layout['data']['alignment_participant_image'];
|
||
|
|
}
|
||
|
|
|
||
|
|
if (!empty($layout['data']['add_barcode'])) {
|
||
|
|
$formattedRow['barcode'] = array(
|
||
|
|
'alignment' => $layout['data']['barcode_alignment'],
|
||
|
|
'type' => $layout['data']['barcode_type'],
|
||
|
|
);
|
||
|
|
}
|
||
|
|
|
||
|
|
// finally assign all the row values, so that we can use it for barcode etc
|
||
|
|
$formattedRow['values'] = $row;
|
||
|
|
|
||
|
|
return $formattedRow;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param $formattedRow
|
||
|
|
*/
|
||
|
|
public function generateLabel($formattedRow) {
|
||
|
|
switch ($formattedRow['labelFormat']) {
|
||
|
|
case 'A6 Badge Portrait 150x106':
|
||
|
|
case 'Hanging Badge 3-3/4" x 4-3"/4':
|
||
|
|
self::labelCreator($formattedRow, 5);
|
||
|
|
break;
|
||
|
|
|
||
|
|
case 'Avery 5395':
|
||
|
|
default:
|
||
|
|
self::labelCreator($formattedRow);
|
||
|
|
break;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param $formattedRow
|
||
|
|
* @param int $cellspacing
|
||
|
|
*/
|
||
|
|
public function labelCreator(&$formattedRow, $cellspacing = 0) {
|
||
|
|
$this->lMarginLogo = 18;
|
||
|
|
$this->tMarginName = 20;
|
||
|
|
|
||
|
|
$x = $this->pdf->GetAbsX();
|
||
|
|
$y = $this->pdf->getY();
|
||
|
|
|
||
|
|
//call hook alterBadge
|
||
|
|
CRM_Utils_Hook::alterBadge($formattedRow['labelTitle'], $this, $formattedRow, $formattedRow['values']);
|
||
|
|
|
||
|
|
$startOffset = 0;
|
||
|
|
if (!empty($formattedRow['image_1'])) {
|
||
|
|
$this->printImage($formattedRow['image_1'], NULL, NULL, CRM_Utils_Array::value('width_image_1', $formattedRow),
|
||
|
|
CRM_Utils_Array::value('height_image_1', $formattedRow));
|
||
|
|
}
|
||
|
|
|
||
|
|
if (!empty($formattedRow['image_2'])) {
|
||
|
|
$this->printImage($formattedRow['image_2'], $x + 68, NULL, CRM_Utils_Array::value('width_image_2', $formattedRow),
|
||
|
|
CRM_Utils_Array::value('height_image_2', $formattedRow));
|
||
|
|
}
|
||
|
|
|
||
|
|
if ((CRM_Utils_Array::value('height_image_1', $formattedRow) >
|
||
|
|
CRM_Utils_Array::value('height_image_2', $formattedRow)) && !empty($formattedRow['height_image_1'])
|
||
|
|
) {
|
||
|
|
$startOffset = CRM_Utils_Array::value('height_image_1', $formattedRow);
|
||
|
|
}
|
||
|
|
elseif (!empty($formattedRow['height_image_2'])) {
|
||
|
|
$startOffset = CRM_Utils_Array::value('height_image_2', $formattedRow);
|
||
|
|
}
|
||
|
|
|
||
|
|
if (!empty($formattedRow['participant_image'])) {
|
||
|
|
$imageAlign = 0;
|
||
|
|
switch (CRM_Utils_Array::value('alignment_participant_image', $formattedRow)) {
|
||
|
|
case 'R':
|
||
|
|
$imageAlign = 68;
|
||
|
|
break;
|
||
|
|
|
||
|
|
case 'L':
|
||
|
|
$imageAlign = 0;
|
||
|
|
break;
|
||
|
|
|
||
|
|
default:
|
||
|
|
break;
|
||
|
|
}
|
||
|
|
$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));
|
||
|
|
if ($startOffset == NULL && CRM_Utils_Array::value('height_participant_image', $formattedRow)) {
|
||
|
|
$startOffset = CRM_Utils_Array::value('height_participant_image', $formattedRow);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
$this->pdf->SetLineStyle(array(
|
||
|
|
'width' => 0.1,
|
||
|
|
'cap' => 'round',
|
||
|
|
'join' => 'round',
|
||
|
|
'dash' => '2,2',
|
||
|
|
'color' => array(0, 0, 200),
|
||
|
|
));
|
||
|
|
|
||
|
|
$rowCount = CRM_Badge_Form_Layout::FIELD_ROWCOUNT;
|
||
|
|
for ($i = 1; $i <= $rowCount; $i++) {
|
||
|
|
if (!empty($formattedRow['token'][$i]['token'])) {
|
||
|
|
$value = '';
|
||
|
|
if ($formattedRow['token'][$i]['token'] != 'spacer') {
|
||
|
|
$value = $formattedRow['token'][$i]['value'];
|
||
|
|
}
|
||
|
|
|
||
|
|
$xAlign = $x;
|
||
|
|
$rowWidth = $this->pdf->width;
|
||
|
|
if (!empty($formattedRow['participant_image']) && !empty($formattedRow['width_participant_image'])) {
|
||
|
|
$rowWidth = $this->pdf->width - $formattedRow['width_participant_image'];
|
||
|
|
if ($formattedRow['alignment_participant_image'] == 'L') {
|
||
|
|
$xAlign = $x + $formattedRow['width_participant_image'] + $imageAlign;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
$offset = $this->pdf->getY() + $startOffset + $cellspacing;
|
||
|
|
|
||
|
|
$this->pdf->SetFont($formattedRow['token'][$i]['font_name'], $formattedRow['token'][$i]['font_style'],
|
||
|
|
$formattedRow['token'][$i]['font_size']);
|
||
|
|
$this->pdf->MultiCell($rowWidth, 0, $value,
|
||
|
|
$this->border, $formattedRow['token'][$i]['text_alignment'], 0, 1, $xAlign, $offset);
|
||
|
|
|
||
|
|
// set this to zero so that it is added only for first element
|
||
|
|
$startOffset = 0;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
if (!empty($formattedRow['barcode'])) {
|
||
|
|
$data = $formattedRow['values'];
|
||
|
|
|
||
|
|
if ($formattedRow['barcode']['type'] == 'barcode') {
|
||
|
|
$data['current_value'] = $formattedRow['values']['contact_id'] . '-' . $formattedRow['values']['participant_id'];
|
||
|
|
}
|
||
|
|
else {
|
||
|
|
// view participant url
|
||
|
|
$data['current_value'] = CRM_Utils_System::url('civicrm/contact/view/participant',
|
||
|
|
'action=view&reset=1&cid=' . $formattedRow['values']['contact_id'] . '&id='
|
||
|
|
. $formattedRow['values']['participant_id'],
|
||
|
|
TRUE,
|
||
|
|
NULL,
|
||
|
|
FALSE
|
||
|
|
);
|
||
|
|
}
|
||
|
|
|
||
|
|
// call hook alterBarcode
|
||
|
|
CRM_Utils_Hook::alterBarcode($data, $formattedRow['barcode']['type']);
|
||
|
|
|
||
|
|
if ($formattedRow['barcode']['type'] == 'barcode') {
|
||
|
|
// barcode position
|
||
|
|
$xAlign = $x;
|
||
|
|
|
||
|
|
switch ($formattedRow['barcode']['alignment']) {
|
||
|
|
case 'L':
|
||
|
|
$xAlign += -14;
|
||
|
|
break;
|
||
|
|
|
||
|
|
case 'R':
|
||
|
|
$xAlign += 27;
|
||
|
|
break;
|
||
|
|
|
||
|
|
case 'C':
|
||
|
|
$xAlign += 9;
|
||
|
|
break;
|
||
|
|
}
|
||
|
|
|
||
|
|
$style = array(
|
||
|
|
'position' => '',
|
||
|
|
'align' => '',
|
||
|
|
'stretch' => FALSE,
|
||
|
|
'fitwidth' => TRUE,
|
||
|
|
'cellfitalign' => '',
|
||
|
|
'border' => FALSE,
|
||
|
|
'hpadding' => 13.5,
|
||
|
|
'vpadding' => 'auto',
|
||
|
|
'fgcolor' => array(0, 0, 0),
|
||
|
|
'bgcolor' => FALSE,
|
||
|
|
'text' => FALSE,
|
||
|
|
'font' => 'helvetica',
|
||
|
|
'fontsize' => 8,
|
||
|
|
'stretchtext' => 0,
|
||
|
|
);
|
||
|
|
|
||
|
|
$this->pdf->write1DBarcode($data['current_value'], 'C128', $xAlign, $y + $this->pdf->height - 10, '70',
|
||
|
|
12, 0.4, $style, 'B');
|
||
|
|
}
|
||
|
|
else {
|
||
|
|
// qr code position
|
||
|
|
$xAlign = $x;
|
||
|
|
|
||
|
|
switch ($formattedRow['barcode']['alignment']) {
|
||
|
|
case 'L':
|
||
|
|
$xAlign += -5;
|
||
|
|
break;
|
||
|
|
|
||
|
|
case 'R':
|
||
|
|
$xAlign += 56;
|
||
|
|
break;
|
||
|
|
|
||
|
|
case 'C':
|
||
|
|
$xAlign += 29;
|
||
|
|
break;
|
||
|
|
}
|
||
|
|
|
||
|
|
$style = array(
|
||
|
|
'border' => FALSE,
|
||
|
|
'hpadding' => 13.5,
|
||
|
|
'vpadding' => 'auto',
|
||
|
|
'fgcolor' => array(0, 0, 0),
|
||
|
|
'bgcolor' => FALSE,
|
||
|
|
'position' => '',
|
||
|
|
);
|
||
|
|
|
||
|
|
$this->pdf->write2DBarcode($data['current_value'], 'QRCODE,H', $xAlign, $y + $this->pdf->height - 26, 30,
|
||
|
|
30, $style, 'B');
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Helper function to print images.
|
||
|
|
*
|
||
|
|
* @param string $img
|
||
|
|
* Image url.
|
||
|
|
*
|
||
|
|
* @param string $x
|
||
|
|
* @param string $y
|
||
|
|
* @param null $w
|
||
|
|
* @param null $h
|
||
|
|
*/
|
||
|
|
public function printImage($img, $x = '', $y = '', $w = NULL, $h = NULL) {
|
||
|
|
if (!$x) {
|
||
|
|
$x = $this->pdf->GetAbsX();
|
||
|
|
}
|
||
|
|
|
||
|
|
if (!$y) {
|
||
|
|
$y = $this->pdf->GetY();
|
||
|
|
}
|
||
|
|
|
||
|
|
$this->imgRes = 300;
|
||
|
|
|
||
|
|
if ($img) {
|
||
|
|
list($w, $h) = self::getImageProperties($img, $this->imgRes, $w, $h);
|
||
|
|
$this->pdf->Image($img, $x, $y, $w, $h, '', '', '', FALSE, 72, '', FALSE,
|
||
|
|
FALSE, $this->debug, FALSE, FALSE, FALSE);
|
||
|
|
}
|
||
|
|
$this->pdf->SetXY($x, $y);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param $img
|
||
|
|
* @param int $imgRes
|
||
|
|
* @param null $w
|
||
|
|
* @param null $h
|
||
|
|
*
|
||
|
|
* @return array
|
||
|
|
*/
|
||
|
|
public static function getImageProperties($img, $imgRes = 300, $w = NULL, $h = NULL) {
|
||
|
|
$imgsize = getimagesize($img);
|
||
|
|
$f = $imgRes / 25.4;
|
||
|
|
$w = !empty($w) ? $w : $imgsize[0] / $f;
|
||
|
|
$h = !empty($h) ? $h : $imgsize[1] / $f;
|
||
|
|
return array($w, $h);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Build badges parameters before actually creating badges.
|
||
|
|
*
|
||
|
|
* @param array $params
|
||
|
|
* Associated array of submitted values.
|
||
|
|
* @param CRM_Core_Form $form
|
||
|
|
*/
|
||
|
|
public static function buildBadges(&$params, &$form) {
|
||
|
|
// get name badge layout info
|
||
|
|
$layoutInfo = CRM_Badge_BAO_Layout::buildLayout($params);
|
||
|
|
|
||
|
|
// split/get actual field names from token and individual contact image URLs
|
||
|
|
$returnProperties = array();
|
||
|
|
if (!empty($layoutInfo['data']['token'])) {
|
||
|
|
foreach ($layoutInfo['data']['token'] as $index => $value) {
|
||
|
|
$element = '';
|
||
|
|
if ($value) {
|
||
|
|
$token = CRM_Utils_Token::getTokens($value);
|
||
|
|
if (key($token) == 'contact') {
|
||
|
|
$element = $token['contact'][0];
|
||
|
|
}
|
||
|
|
elseif (key($token) == 'event') {
|
||
|
|
$element = $token['event'][0];
|
||
|
|
//FIX ME - we need to standardize event token names
|
||
|
|
if (substr($element, 0, 6) != 'event_') {
|
||
|
|
$element = 'event_' . $element;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
elseif (key($token) == 'participant') {
|
||
|
|
$element = $token['participant'][0];
|
||
|
|
}
|
||
|
|
|
||
|
|
// build returnproperties for query
|
||
|
|
$returnProperties[$element] = 1;
|
||
|
|
}
|
||
|
|
|
||
|
|
// add actual field name to row element
|
||
|
|
$layoutInfo['data']['rowElements'][$index] = $element;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
// add additional required fields for query execution
|
||
|
|
$additionalFields = array('participant_register_date', 'participant_id', 'event_id', 'contact_id', 'image_URL');
|
||
|
|
foreach ($additionalFields as $field) {
|
||
|
|
$returnProperties[$field] = 1;
|
||
|
|
}
|
||
|
|
|
||
|
|
if ($form->_single) {
|
||
|
|
$queryParams = NULL;
|
||
|
|
}
|
||
|
|
else {
|
||
|
|
$queryParams = $form->get('queryParams');
|
||
|
|
}
|
||
|
|
|
||
|
|
$query = new CRM_Contact_BAO_Query($queryParams, $returnProperties, NULL, FALSE, FALSE,
|
||
|
|
CRM_Contact_BAO_Query::MODE_EVENT
|
||
|
|
);
|
||
|
|
|
||
|
|
list($select, $from, $where, $having) = $query->query();
|
||
|
|
if (empty($where)) {
|
||
|
|
$where = "WHERE {$form->_componentClause}";
|
||
|
|
}
|
||
|
|
else {
|
||
|
|
$where .= " AND {$form->_componentClause}";
|
||
|
|
}
|
||
|
|
|
||
|
|
$sortOrder = NULL;
|
||
|
|
if ($form->get(CRM_Utils_Sort::SORT_ORDER)) {
|
||
|
|
$sortOrder = $form->get(CRM_Utils_Sort::SORT_ORDER);
|
||
|
|
if (!empty($sortOrder)) {
|
||
|
|
$sortOrder = " ORDER BY $sortOrder";
|
||
|
|
}
|
||
|
|
}
|
||
|
|
$queryString = "$select $from $where $having $sortOrder";
|
||
|
|
|
||
|
|
$dao = CRM_Core_DAO::executeQuery($queryString);
|
||
|
|
$rows = array();
|
||
|
|
while ($dao->fetch()) {
|
||
|
|
$query->convertToPseudoNames($dao);
|
||
|
|
$rows[$dao->participant_id] = array();
|
||
|
|
foreach ($returnProperties as $key => $dontCare) {
|
||
|
|
$value = isset($dao->$key) ? $dao->$key : NULL;
|
||
|
|
// Format custom fields
|
||
|
|
if (strstr($key, 'custom_') && isset($value)) {
|
||
|
|
$value = CRM_Core_BAO_CustomField::displayValue($value, substr($key, 7), $dao->contact_id);
|
||
|
|
}
|
||
|
|
$rows[$dao->participant_id][$key] = $value;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
$eventBadgeClass = new CRM_Badge_BAO_Badge();
|
||
|
|
$eventBadgeClass->createLabels($rows, $layoutInfo);
|
||
|
|
}
|
||
|
|
|
||
|
|
}
|