INFRA-132 - Batch #7

[civicrm-core.git] / CRM / Event / Badge.php

diff --git a/CRM/Event/Badge.php b/CRM/Event/Badge.php
index 104bcff1740dbf2b4764c28f5c3d41dd8425a3f3..f5e59dad35d39d94cf9814cb2e359dd55fb3f2fb 100644 (file)
--- a/CRM/Event/Badge.php
+++ b/CRM/Event/Badge.php
@@ -1,7 +1,7 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -44,21 +44,26 @@
  */
 class CRM_Event_Badge {
   /**
-   *
    */
-  function __construct() {
-    $this->style        = array('width' => 0.1, 'cap' => 'round', 'join' => 'round', 'dash' => '2,2', 'color' => array(0, 0, 200));
-    $this->format       = '5160';
+  public function __construct() {
+    $this->style = array(
+      'width' => 0.1,
+      'cap' => 'round',
+      'join' => 'round',
+      'dash' => '2,2',
+      'color' => array(0, 0, 200)
+    );
+    $this->format = '5160';
     $this->imgExtension = 'png';
-    $this->imgRes       = 300;
-    $this->event        = NULL;
+    $this->imgRes = 300;
+    $this->event = NULL;
     $this->setDebug(FALSE);
   }
 
   /**
    * @param bool $debug
    */
-  function setDebug($debug = TRUE) {
+  public function setDebug($debug = TRUE) {
     if (!$debug) {
       $this->debug = FALSE;
       $this->border = 0;
@@ -70,18 +75,17 @@ class CRM_Event_Badge {
   }
 
   /**
-   * function to create the labels (pdf)
+   * Create the labels (pdf)
    * It assumes the participants are from the same event
    *
-   * @param   array    $participants
+   * @param array $participants
    *
-   * @return  null
-   * @access  public
+   * @return null
    */
   public function run(&$participants) {
     // fetch the 1st participant, and take her event to retrieve its attributes
     $participant = reset($participants);
-    $eventID     = $participant['event_id'];
+    $eventID = $participant['event_id'];
     $this->event = self::retrieveEvent($eventID);
     //call function to create labels
     self::createLabels($participants);
@@ -89,7 +93,7 @@ class CRM_Event_Badge {
   }
 
   /**
-   * @param $eventID
+   * @param int $eventID
    *
    * @return CRM_Event_BAO_Event|null
    */
@@ -102,12 +106,12 @@ class CRM_Event_Badge {
   }
 
   /**
-   * @param $eventID
+   * @param int $eventID
    * @param bool $img
    *
    * @return string
    */
-  function getImageFileName($eventID, $img = FALSE) {
+  public function getImageFileName($eventID, $img = FALSE) {
     global $civicrm_root;
     $path = "CRM/Event/Badge";
     if ($img == FALSE) {
@@ -120,15 +124,16 @@ class CRM_Event_Badge {
     // CRM-13235 - leverage the Smarty path to get all templates directories
     $template = CRM_Core_Smarty::singleton();
     if (isset($template->template_dir) && $template->template_dir) {
-      $dirs = is_array( $template->template_dir ) ? $template->template_dir : array($template->template_dir);
+      $dirs = is_array($template->template_dir) ? $template->template_dir : array($template->template_dir);
       foreach ($dirs as $dir) {
-        foreach (array( "$dir/$path/$eventID/$img", "$dir/$path/$img") as $imgFile) {
+        foreach (array("$dir/$path/$eventID/$img", "$dir/$path/$img") as $imgFile) {
           if (file_exists($imgFile)) {
             return $imgFile;
           }
         }
       }
-    } else {
+    }
+    else {
       $imgFile = 'No template directories defined anywhere??';
     }
 
@@ -139,11 +144,19 @@ class CRM_Event_Badge {
   /**
    * @param bool $img
    */
-  function printBackground($img = FALSE) {
+  public function printBackground($img = FALSE) {
     $x = $this->pdf->GetAbsX();
     $y = $this->pdf->GetY();
     if ($this->debug) {
-      $this->pdf->Rect($x, $y, $this->pdf->width, $this->pdf->height, 'D', array('all' => array('width' => 1, 'cap' => 'round', 'join' => 'round', 'dash' => '2,10', 'color' => array(255, 0, 0))));
+      $this->pdf->Rect($x, $y, $this->pdf->width, $this->pdf->height, 'D', array(
+          'all' => array(
+            'width' => 1,
+            'cap' => 'round',
+            'join' => 'round',
+            'dash' => '2,10',
+            'color' => array(255, 0, 0)
+          )
+        ));
     }
     $img = $this->getImageFileName($this->event->id, $img);
     if ($img) {
@@ -158,7 +171,7 @@ class CRM_Event_Badge {
   }
 
   /**
-   * this is supposed to be overrided
+   * This is supposed to be overrided
    **/
   public function generateLabel($participant) {
     $txt = "{$this->event['title']}
@@ -168,20 +181,17 @@ class CRM_Event_Badge {
     $this->pdf->MultiCell($this->pdf->width, $this->pdf->lineHeight, $txt);
   }
 
-  function pdfExtraFormat() {}
+  public function pdfExtraFormat() {
+  }
 
   /**
-   * function to create labels (pdf)
-   *
-   * @param $participants
+   * Create labels (pdf)
    *
-   * @internal param array $contactRows assciated array of contact data
-   * @internal param string $format format in which labels needs to be printed
+   * @param array $participants
    *
-   * @return  null
-   * @access  public
+   * @return null
    */
-  function createLabels(&$participants) {
+  public function createLabels(&$participants) {
 
     $this->pdf = new CRM_Utils_PDF_Label($this->format, 'mm');
     $this->pdfExtraFormat();
@@ -199,4 +209,3 @@ class CRM_Event_Badge {
     $this->pdf->Output($this->event->title . '.pdf', 'D');
   }
 }
-