CRM/Event add comments
authorEileen McNaughton <eileen@fuzion.co.nz>
Sat, 24 May 2014 02:30:24 +0000 (14:30 +1200)
committerEileen McNaughton <eileen@fuzion.co.nz>
Sat, 24 May 2014 02:30:24 +0000 (14:30 +1200)
46 files changed:
CRM/Event/BAO/Event.php
CRM/Event/BAO/Participant.php
CRM/Event/BAO/ParticipantStatusType.php
CRM/Event/BAO/Query.php
CRM/Event/Badge.php
CRM/Event/Badge/Logo.php
CRM/Event/Badge/Logo5395.php
CRM/Event/Badge/NameTent.php
CRM/Event/Badge/Simple.php
CRM/Event/Cart/BAO/Cart.php
CRM/Event/Cart/BAO/Conference.php
CRM/Event/Cart/BAO/EventInCart.php
CRM/Event/Cart/BAO/MerParticipant.php
CRM/Event/Cart/Controller/Checkout.php
CRM/Event/Cart/Form/Cart.php
CRM/Event/Cart/Form/Checkout/ConferenceEvents.php
CRM/Event/Cart/Form/Checkout/ParticipantsAndPrices.php
CRM/Event/Cart/Form/Checkout/Payment.php
CRM/Event/Cart/Form/Checkout/ThankYou.php
CRM/Event/Cart/Form/MerParticipant.php
CRM/Event/Cart/Page/AddToCart.php
CRM/Event/Cart/Page/CheckoutAJAX.php
CRM/Event/Cart/Page/RemoveFromCart.php
CRM/Event/Cart/Page/ViewCart.php
CRM/Event/Cart/StateMachine/Checkout.php
CRM/Event/Form/ManageEvent.php
CRM/Event/Form/ManageEvent/EventInfo.php
CRM/Event/Form/ManageEvent/Registration.php
CRM/Event/Form/ManageEvent/TabHeader.php
CRM/Event/Form/ParticipantFeeSelection.php
CRM/Event/Form/Registration.php
CRM/Event/Form/Registration/AdditionalParticipant.php
CRM/Event/Form/Registration/Confirm.php
CRM/Event/Form/Registration/Register.php
CRM/Event/Form/Search.php
CRM/Event/Form/SearchEvent.php
CRM/Event/Form/Task.php
CRM/Event/Form/Task/Batch.php
CRM/Event/Import/Field.php
CRM/Event/Import/Parser.php
CRM/Event/Info.php
CRM/Event/Page/EventInfo.php
CRM/Event/Page/ManageEvent.php
CRM/Event/Page/ParticipantListing/NameStatusAndDate.php
CRM/Event/Page/ParticipantListing/Simple.php
CRM/Event/Selector/Search.php

index 99128fa82f948d8649bfe0625109267575eef7bd..c7261128ec291cf772dce6ec4fe8475e11540c47 100644 (file)
@@ -1772,6 +1772,9 @@ WHERE  id = $cfID
    *
    * @return array $events array of all events.
    */
+  /**
+   * @return array
+   */
   static function getLocationEvents() {
     $events = array();
 
@@ -1792,6 +1795,11 @@ ORDER BY sp.name, ca.city, ca.street_address ASC
     return $events;
   }
 
+  /**
+   * @param $locBlockId
+   *
+   * @return int|null|string
+   */
   static function countEventsUsingLocBlockId($locBlockId) {
     if (!$locBlockId) {
       return 0;
@@ -1822,6 +1830,11 @@ WHERE  ce.loc_block_id = $locBlockId";
     return $hasPermission && self::validRegistrationDate($values);
   }
 
+  /**
+   * @param $values
+   *
+   * @return bool
+   */
   static function validRegistrationDate(&$values) {
     // make sure that we are between  registration start date and registration end date
     $startDate = CRM_Utils_Date::unixTime(CRM_Utils_Array::value('registration_start_date', $values));
@@ -1848,6 +1861,11 @@ WHERE  ce.loc_block_id = $locBlockId";
    * @return boolean true if allow registration otherwise false
    * @access public
    */
+  /**
+   * @param $values
+   *
+   * @return bool
+   */
   static function showHideRegistrationLink($values) {
 
     $session           = CRM_Core_Session::singleton();
@@ -1880,6 +1898,11 @@ WHERE  ce.loc_block_id = $locBlockId";
    * @return boolean $alreadyRegistered true/false
    * @access public
    */
+  /**
+   * @param $params
+   *
+   * @return bool
+   */
   static function checkRegistration($params) {
     $alreadyRegistered = FALSE;
     if (empty($params['contact_id'])) {
@@ -2056,6 +2079,11 @@ LEFT  JOIN  civicrm_price_field_value value ON ( value.id = lineItem.price_field
    *
    * @return $defaults an array of custom data defaults.
    */
+  /**
+   * @param $templateId
+   *
+   * @return array
+   */
   static function getTemplateDefaultValues($templateId) {
     $defaults = array();
     if (!$templateId) {
@@ -2077,6 +2105,11 @@ LEFT  JOIN  civicrm_price_field_value value ON ( value.id = lineItem.price_field
     return $defaults;
   }
 
+  /**
+   * @param $event_id
+   *
+   * @return object
+   */
   static function get_sub_events($event_id) {
     $params = array('parent_event_id' => $event_id);
     $defaults = array();
@@ -2090,6 +2123,10 @@ LEFT  JOIN  civicrm_price_field_value value ON ( value.id = lineItem.price_field
    * @params int $eventCampaignID campaign id of that event
    *
    */
+  /**
+   * @param $eventID
+   * @param $eventCampaignID
+   */
   static function updateParticipantCampaignID($eventID, $eventCampaignID) {
     $params = array();
     $params[1] = array($eventID, 'Integer');
index 9ae755a99e4cd92074f9fc414fb1343460548b54..1348cb0bc5dacd2a9ed853347bd0152a7f12a94d 100644 (file)
@@ -66,6 +66,10 @@ class CRM_Event_BAO_Participant extends CRM_Event_DAO_Participant {
     'Awaiting approval' => array('Cancelled', 'Pending from approval'),
     'Pending from approval' => array('Registered', 'Cancelled'),
   );
+
+  /**
+   *
+   */
   function __construct() {
     parent::__construct();
   }
@@ -1811,6 +1815,15 @@ WHERE cpf.price_set_id = %1 AND cpfv.label LIKE %2";
     }
   }
 
+  /**
+   * @param $params
+   * @param $participantId
+   * @param $contributionId
+   * @param $feeBlock
+   * @param $lineItems
+   * @param $paidAmount
+   * @param $priceSetId
+   */
   static function changeFeeSelections($params, $participantId, $contributionId, $feeBlock, $lineItems, $paidAmount, $priceSetId) {
     $contributionStatuses = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
     $partiallyPaidStatusId = array_search('Partially paid', $contributionStatuses);
@@ -1945,6 +1958,11 @@ WHERE (li.entity_table = 'civicrm_participant' AND li.entity_id = {$participantI
     self::addActivityForSelection($participantId, 'Change Registration');
   }
 
+  /**
+   * @param $updatedAmount
+   * @param $paidAmount
+   * @param $contributionId
+   */
   static function recordAdjustedAmt($updatedAmount, $paidAmount, $contributionId) {
     $balanceAmt = $updatedAmount - $paidAmount;
     $contributionStatuses = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
@@ -1996,6 +2014,12 @@ WHERE (li.entity_table = 'civicrm_participant' AND li.entity_id = {$participantI
     }
   }
 
+  /**
+   * @param $participantId
+   * @param $activityType
+   *
+   * @throws CRM_Core_Exception
+   */
   static function addActivityForSelection($participantId, $activityType) {
     $eventId = CRM_Core_DAO::getFieldValue('CRM_Event_BAO_Participant', $participantId, 'event_id');
     $contactId = CRM_Core_DAO::getFieldValue('CRM_Event_BAO_Participant', $participantId, 'contact_id');
index 3d15d36677dbb4b1fe2e6194eb0549df5a523eea..599150ec9991eb80e3b4c0ed41b89b45326a3dca 100644 (file)
  *
  */
 class CRM_Event_BAO_ParticipantStatusType extends CRM_Event_DAO_ParticipantStatusType {
+  /**
+   * @param $params
+   *
+   * @return $this|null
+   */
   static function add(&$params) {
     if (empty($params)) {
       return NULL;
@@ -42,6 +47,11 @@ class CRM_Event_BAO_ParticipantStatusType extends CRM_Event_DAO_ParticipantStatu
     return $dao->save();
   }
 
+  /**
+   * @param $params
+   *
+   * @return $this|null
+   */
   static function &create(&$params) {
     $transaction = new CRM_Core_Transaction();
     $statusType = self::add($params);
@@ -53,6 +63,11 @@ class CRM_Event_BAO_ParticipantStatusType extends CRM_Event_DAO_ParticipantStatu
     return $statusType;
   }
 
+  /**
+   * @param $id
+   *
+   * @return bool
+   */
   static function deleteParticipantStatusType($id) {
     // return early if there are participants with this status
     $participant = new CRM_Event_DAO_Participant;
@@ -70,6 +85,12 @@ class CRM_Event_BAO_ParticipantStatusType extends CRM_Event_DAO_ParticipantStatu
     return TRUE;
   }
 
+  /**
+   * @param $params
+   * @param $defaults
+   *
+   * @return CRM_Event_DAO_ParticipantStatusType|null
+   */
   static function retrieve(&$params, &$defaults) {
     $result = NULL;
 
@@ -83,10 +104,21 @@ class CRM_Event_BAO_ParticipantStatusType extends CRM_Event_DAO_ParticipantStatu
     return $result;
   }
 
+  /**
+   * @param $id
+   * @param $isActive
+   *
+   * @return bool
+   */
   static function setIsActive($id, $isActive) {
     return CRM_Core_DAO::setFieldValue('CRM_Event_BAO_ParticipantStatusType', $id, 'is_active', $isActive);
   }
 
+  /**
+   * @param $params
+   *
+   * @return array
+   */
   public function process($params) {
 
     $returnMessages = array();
index af6392201892ea181fe956709d2207234377fa83..707e535b79738f599593f8e7ef42a836c4fe055c 100644 (file)
@@ -35,6 +35,9 @@
  */
 class CRM_Event_BAO_Query {
 
+  /**
+   * @return array
+   */
   static function &getFields() {
     $fields = array();
     $fields = array_merge($fields, CRM_Event_DAO_Event::import());
@@ -44,6 +47,9 @@ class CRM_Event_BAO_Query {
     return $fields;
   }
 
+  /**
+   * @return array
+   */
   static function &getParticipantFields() {
     $fields = CRM_Event_BAO_Participant::importableFields('Individual', TRUE, TRUE);
     return $fields;
@@ -201,6 +207,9 @@ class CRM_Event_BAO_Query {
     }
   }
 
+  /**
+   * @param $query
+   */
   static function where(&$query) {
     $grouping = NULL;
     foreach (array_keys($query->_params) as $id) {
@@ -219,6 +228,10 @@ class CRM_Event_BAO_Query {
     }
   }
 
+  /**
+   * @param $values
+   * @param $query
+   */
   static function whereClauseSingle(&$values, &$query) {
     list($name, $op, $value, $grouping, $wildcard) = $values;
     switch ($name) {
@@ -445,6 +458,13 @@ class CRM_Event_BAO_Query {
     }
   }
 
+  /**
+   * @param $name
+   * @param $mode
+   * @param $side
+   *
+   * @return null|string
+   */
   static function from($name, $mode, $side) {
     $from = NULL;
     switch ($name) {
@@ -494,6 +514,12 @@ class CRM_Event_BAO_Query {
     return (isset($this->_qill)) ? $this->_qill : "";
   }
 
+  /**
+   * @param $mode
+   * @param bool $includeCustomFields
+   *
+   * @return array|null
+   */
   static function defaultReturnProperties($mode,
     $includeCustomFields = TRUE
   ) {
@@ -610,8 +636,15 @@ class CRM_Event_BAO_Query {
     $form->setDefaults(array('participant_test' => 0));
   }
 
+  /**
+   * @param $row
+   * @param $id
+   */
   static function searchAction(&$row, $id) {}
 
+  /**
+   * @param $tables
+   */
   static function tableNames(&$tables) {
     //add participant table
     if (!empty($tables['civicrm_event'])) {
index 0f75239f05bf3fceac40b4955059768bb1027875..104bcff1740dbf2b4764c28f5c3d41dd8425a3f3 100644 (file)
@@ -43,6 +43,9 @@
  *
  */
 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';
@@ -52,6 +55,9 @@ class CRM_Event_Badge {
     $this->setDebug(FALSE);
   }
 
+  /**
+   * @param bool $debug
+   */
   function setDebug($debug = TRUE) {
     if (!$debug) {
       $this->debug = FALSE;
@@ -82,6 +88,11 @@ class CRM_Event_Badge {
     CRM_Utils_System::civiExit(1);
   }
 
+  /**
+   * @param $eventID
+   *
+   * @return CRM_Event_BAO_Event|null
+   */
   protected function retrieveEvent($eventID) {
     $bao = new CRM_Event_BAO_Event();
     if ($bao->get('id', $eventID)) {
@@ -90,6 +101,12 @@ class CRM_Event_Badge {
     return NULL;
   }
 
+  /**
+   * @param $eventID
+   * @param bool $img
+   *
+   * @return string
+   */
   function getImageFileName($eventID, $img = FALSE) {
     global $civicrm_root;
     $path = "CRM/Event/Badge";
@@ -119,6 +136,9 @@ class CRM_Event_Badge {
     return $imgFile;
   }
 
+  /**
+   * @param bool $img
+   */
   function printBackground($img = FALSE) {
     $x = $this->pdf->GetAbsX();
     $y = $this->pdf->GetY();
index 4e101ad6ad743ba5b2e4da4c3f9bef093e2ceb3b..92e6bd12b5ddf75b4b5df410535c4ca92c3aadaf 100644 (file)
@@ -1,5 +1,12 @@
 <?php
+
+/**
+ * Class CRM_Event_Badge_Logo
+ */
 class CRM_Event_Badge_Logo extends CRM_Event_Badge {
+  /**
+   *
+   */
   function __construct() {
     parent::__construct();
     // A4
@@ -17,6 +24,9 @@ class CRM_Event_Badge_Logo extends CRM_Event_Badge {
     //      $this->setDebug ();
   }
 
+  /**
+   * @param $participant
+   */
   public function generateLabel($participant) {
     $x = $this->pdf->GetAbsX();
     $y = $this->pdf->GetY();
index ebf43edb6efe3ba7e7c44c6d23a0f58402f7be2d..6d7352edf06386751906e319e74107a74e321018 100644 (file)
@@ -1,5 +1,12 @@
 <?php
+
+/**
+ * Class CRM_Event_Badge_Logo5395
+ */
 class CRM_Event_Badge_Logo5395 extends CRM_Event_Badge {
+  /**
+   *
+   */
   function __construct() {
     parent::__construct();
     // A4
@@ -17,6 +24,9 @@ class CRM_Event_Badge_Logo5395 extends CRM_Event_Badge {
     //      $this->setDebug ();
   }
 
+  /**
+   * @param $participant
+   */
   public function generateLabel($participant) {
     $x = $this->pdf->GetAbsX();
     $y = $this->pdf->GetY();
index d99801e1701077ea652c3b45ee299a77bf3a2f6a..0fad78bce79bef142b691aa0545f4afed7014da2 100644 (file)
@@ -38,6 +38,9 @@
  *
  */
 class CRM_Event_Badge_NameTent extends CRM_Event_Badge {
+  /**
+   *
+   */
   function __construct() {
     parent::__construct();
     // A4
@@ -59,6 +62,9 @@ class CRM_Event_Badge_NameTent extends CRM_Event_Badge {
     $this->pdf->setPageFormat('A4', 'L');
   }
 
+  /**
+   * @param $participant
+   */
   protected function writeOneSide(&$participant) {
     $this->pdf->SetXY(0, $this->pdf->height / 2);
     $this->printBackground(TRUE);
@@ -71,6 +77,9 @@ class CRM_Event_Badge_NameTent extends CRM_Event_Badge {
     $this->pdf->Write(0, $participant['current_employer'], NULL, NULL, 'C');
   }
 
+  /**
+   * @param $participant
+   */
   public function generateLabel($participant) {
     $this->writeOneSide($participant);
     $this->pdf->StartTransform();
index e9223174a6aca7ebec915a0a3c10e884566f5204..73d4adc9708e104321ad5fc2eecbe2f6cd58b077 100644 (file)
@@ -39,6 +39,9 @@
  */
 class CRM_Event_Badge_Simple extends CRM_Event_Badge {
 
+  /**
+   * @param $participant
+   */
   public function generateLabel($participant) {
     $date = CRM_Utils_Date::customFormat($participant['event_start_date'], "%e %b");
     $this->pdf->SetFontSize(8);
index e719ced0e513e28b0549e994c4bc0971a62905c7..6241ee2a8d270396fb40b4c1bf77d4f686c74e59 100644 (file)
@@ -1,10 +1,19 @@
 <?php
+
+/**
+ * Class CRM_Event_Cart_BAO_Cart
+ */
 class CRM_Event_Cart_BAO_Cart extends CRM_Event_Cart_DAO_Cart {
   public $associations_loaded = FALSE;
     /* event_in_cart_id => $event_in_cart */
   public $events_in_carts = array(
     );
 
+  /**
+   * @param $params
+   *
+   * @return $this
+   */
   public static function add(&$params) {
     $cart = new CRM_Event_Cart_BAO_Cart();
     $cart->copyValues($params);
@@ -12,6 +21,11 @@ class CRM_Event_Cart_BAO_Cart extends CRM_Event_Cart_DAO_Cart {
     return $result;
   }
 
+  /**
+   * @param $event_id
+   *
+   * @return mixed
+   */
   public function add_event($event_id) {
     $this->load_associations();
     $event_in_cart = $this->get_event_in_cart_by_event_id($event_id);
@@ -29,6 +43,9 @@ class CRM_Event_Cart_BAO_Cart extends CRM_Event_Cart_DAO_Cart {
     return $this->events_in_carts[$event_in_cart->event_id];
   }
 
+  /**
+   * @param $participant
+   */
   function add_participant_to_cart($participant) {
     $event_in_cart = $this->get_event_in_cart_by_event_id($participant->event_id);
     if (!$event_in_cart) {
@@ -38,6 +55,12 @@ class CRM_Event_Cart_BAO_Cart extends CRM_Event_Cart_DAO_Cart {
     $event_in_cart->save();
   }
 
+  /**
+   * @param $params
+   *
+   * @return $this
+   * @throws Exception
+   */
   public static function create($params) {
     $transaction = new CRM_Core_Transaction();
 
@@ -53,10 +76,20 @@ class CRM_Event_Cart_BAO_Cart extends CRM_Event_Cart_DAO_Cart {
     return $cart;
   }
 
+  /**
+   * @param $id
+   *
+   * @return bool|CRM_Event_Cart_BAO_Cart
+   */
   public static function find_by_id($id) {
     return self::find_by_params(array('id' => $id));
   }
 
+  /**
+   * @param $params
+   *
+   * @return bool|CRM_Event_Cart_BAO_Cart
+   */
   public static function find_by_params($params) {
     $cart = new CRM_Event_Cart_BAO_Cart();
     $cart->copyValues($params);
@@ -68,6 +101,9 @@ class CRM_Event_Cart_BAO_Cart extends CRM_Event_Cart_DAO_Cart {
     }
   }
 
+  /**
+   * @return $this|bool|CRM_Event_Cart_BAO_Cart
+   */
   public static function find_or_create_for_current_session() {
     $session       = CRM_Core_Session::singleton();
     $event_cart_id = $session->get('event_cart_id');
@@ -105,14 +141,27 @@ class CRM_Event_Cart_BAO_Cart extends CRM_Event_Cart_DAO_Cart {
     return $cart;
   }
 
+  /**
+   * @param $id
+   *
+   * @return bool|CRM_Event_Cart_BAO_Cart
+   */
   public static function find_uncompleted_by_id($id) {
     return self::find_by_params(array('id' => $id, 'completed' => 0));
   }
 
+  /**
+   * @param $user_id
+   *
+   * @return bool|CRM_Event_Cart_BAO_Cart
+   */
   public static function find_uncompleted_by_user_id($user_id) {
     return self::find_by_params(array('user_id' => $user_id, 'completed' => 0));
   }
 
+  /**
+   * @return array
+   */
   public function get_main_events_in_carts() {
     //return CRM_Event_Cart_BAO_EventInCart::find_all_by_params( array('main_conference_event_id'
     $all = array();
@@ -124,6 +173,11 @@ class CRM_Event_Cart_BAO_Cart extends CRM_Event_Cart_DAO_Cart {
     return $all;
   }
 
+  /**
+   * @param $main_conference_event_id
+   *
+   * @return array
+   */
   public function get_events_in_carts_by_main_event_id($main_conference_event_id) {
     $all = array();
     if (!$main_conference_event_id) {
@@ -138,6 +192,12 @@ class CRM_Event_Cart_BAO_Cart extends CRM_Event_Cart_DAO_Cart {
     return $all;
   }
 
+  /**
+   * @param $event_in_cart_1
+   * @param $event_in_cart_2
+   *
+   * @return int
+   */
   static function compare_event_dates($event_in_cart_1, $event_in_cart_2) {
     $date_1 = CRM_Utils_Date::unixTime($event_in_cart_1->event->start_date);
     $date_2 = CRM_Utils_Date::unixTime($event_in_cart_2->event->start_date);
@@ -150,6 +210,11 @@ class CRM_Event_Cart_BAO_Cart extends CRM_Event_Cart_DAO_Cart {
     return ($date_1 < $date_2) ? -1 : 1;
   }
 
+  /**
+   * @param $main_participant
+   *
+   * @return array
+   */
   public function get_subparticipants($main_participant) {
     $subparticipants = array();
     foreach ($this->events_in_carts as $event_in_cart) {
@@ -165,10 +230,20 @@ class CRM_Event_Cart_BAO_Cart extends CRM_Event_Cart_DAO_Cart {
     return $subparticipants;
   }
 
+  /**
+   * @param $event_id
+   *
+   * @return mixed
+   */
   public function get_event_in_cart_by_event_id($event_id) {
     return CRM_Utils_Array::value($event_id, $this->events_in_carts);
   }
 
+  /**
+   * @param $event_in_cart_id
+   *
+   * @return null
+   */
   public function &get_event_in_cart_by_id($event_in_cart_id) {
     foreach ($this->events_in_carts as $event_in_cart) {
       if ($event_in_cart->id == $event_in_cart_id) {
@@ -178,6 +253,9 @@ class CRM_Event_Cart_BAO_Cart extends CRM_Event_Cart_DAO_Cart {
     return NULL;
   }
 
+  /**
+   * @return array
+   */
   public function get_main_event_participants() {
     $participants = array();
     foreach ($this->get_main_events_in_carts() as $event_in_cart) {
@@ -198,6 +276,11 @@ class CRM_Event_Cart_BAO_Cart extends CRM_Event_Cart_DAO_Cart {
     $this->save();
   }
 
+  /**
+   * @param $event_in_cart_id
+   *
+   * @return bool|CRM_Event_Cart_BAO_EventInCart
+   */
   public function remove_event_in_cart($event_in_cart_id) {
     $event_in_cart = CRM_Event_Cart_BAO_EventInCart::find_by_id($event_in_cart_id);
     if ($event_in_cart) {
@@ -211,6 +294,11 @@ class CRM_Event_Cart_BAO_Cart extends CRM_Event_Cart_DAO_Cart {
     return $event_in_cart;
   }
 
+  /**
+   * @param $participant_id
+   *
+   * @return int
+   */
   function get_participant_index_from_id($participant_id) {
     foreach ($this->events_in_carts as $event_in_cart) {
       $index = 0;
@@ -224,6 +312,13 @@ class CRM_Event_Cart_BAO_Cart extends CRM_Event_Cart_DAO_Cart {
     return - 1;
   }
 
+  /**
+   * @param $params
+   * @param $values
+   *
+   * @return mixed
+   * @throws Exception
+   */
   public static function retrieve(&$params, &$values) {
     $cart = self::find_by_params($params);
     if ($cart === FALSE) {
@@ -234,6 +329,9 @@ class CRM_Event_Cart_BAO_Cart extends CRM_Event_Cart_DAO_Cart {
   }
 
 
+  /**
+   * @param $from_cart_id
+   */
   public function adopt_participants($from_cart_id) {
     $params = array(
       1 => array($this->id, 'Integer'),
index 71f9ad7f829bff93f0c4c8ab00d558b29e765ebe..6b4f7a44b8ff11552e9cc442730f5cb9f22556af 100644 (file)
@@ -1,4 +1,8 @@
 <?php
+
+/**
+ * Class CRM_Event_Cart_BAO_Conference
+ */
 class CRM_Event_Cart_BAO_Conference {
   //XXX assumes we don't allow a contact to register for the same conference more than once
   //XXX flattens the object tree for convenient templating
index e650453e1efe7de182dc51de7ee6e8e6613006c8..4b047aa59cf5342ee0c45b88f3db41b850481f88 100644 (file)
@@ -1,4 +1,8 @@
 <?php
+
+/**
+ * Class CRM_Event_Cart_BAO_EventInCart
+ */
 class CRM_Event_Cart_BAO_EventInCart extends CRM_Event_Cart_DAO_EventInCart implements ArrayAccess {
   public $assocations_loaded = FALSE;
   public $event;
@@ -7,14 +11,26 @@ class CRM_Event_Cart_BAO_EventInCart extends CRM_Event_Cart_DAO_EventInCart impl
   public $participants = array(
     );
 
+  /**
+   *
+   */
   function __construct() {
     parent::__construct();
   }
 
+  /**
+   * @param $participant
+   */
   public function add_participant($participant) {
     $this->participants[$participant->id] = $participant;
   }
 
+  /**
+   * @param $params
+   *
+   * @return $this|CRM_Event_Cart_BAO_EventInCart
+   * @throws Exception
+   */
   public static function create(&$params) {
     $transaction = new CRM_Core_Transaction();
     $event_in_cart = new CRM_Event_Cart_BAO_EventInCart();
@@ -31,6 +47,9 @@ class CRM_Event_Cart_BAO_EventInCart extends CRM_Event_Cart_DAO_EventInCart impl
     return $event_in_cart;
   }
 
+  /**
+   * @param bool $useWhere
+   */
   function delete($useWhere = false) {
     $this->load_associations();
     $contacts_to_delete = array();
@@ -50,10 +69,20 @@ class CRM_Event_Cart_BAO_EventInCart extends CRM_Event_Cart_DAO_EventInCart impl
     parent::delete();
   }
 
+  /**
+   * @param $event_cart_id
+   *
+   * @return array
+   */
   public static function find_all_by_event_cart_id($event_cart_id) {
     return self::find_all_by_params(array('event_cart_id' => $event_cart_id));
   }
 
+  /**
+   * @param $params
+   *
+   * @return array
+   */
   public static function find_all_by_params($params) {
     $event_in_cart = new CRM_Event_Cart_BAO_EventInCart();
     $event_in_cart->copyValues($params);
@@ -66,10 +95,20 @@ class CRM_Event_Cart_BAO_EventInCart extends CRM_Event_Cart_DAO_EventInCart impl
     return $result;
   }
 
+  /**
+   * @param $id
+   *
+   * @return bool|CRM_Event_Cart_BAO_EventInCart
+   */
   public static function find_by_id($id) {
     return self::find_by_params(array('id' => $id));
   }
 
+  /**
+   * @param $params
+   *
+   * @return bool|CRM_Event_Cart_BAO_EventInCart
+   */
   public static function find_by_params($params) {
     $event_in_cart = new CRM_Event_Cart_BAO_EventInCart();
     $event_in_cart->copyValues($params);
@@ -81,6 +120,9 @@ class CRM_Event_Cart_BAO_EventInCart extends CRM_Event_Cart_DAO_EventInCart impl
     }
   }
 
+  /**
+   * @param $contact_id
+   */
   public function remove_participant_by_contact_id($contact_id) {
     $to_remove = array();
     foreach ($this->participants as $participant) {
@@ -92,19 +134,35 @@ class CRM_Event_Cart_BAO_EventInCart extends CRM_Event_Cart_DAO_EventInCart impl
     $this->participants = array_diff_key($this->participants, $to_remove);
   }
 
+  /**
+   * @param $participant_id
+   *
+   * @return mixed
+   */
   public function get_participant_by_id($participant_id) {
     return $this->participants[$participant_id];
   }
 
+  /**
+   * @param $participant_id
+   */
   public function remove_participant_by_id($participant_id) {
     $this->get_participant_by_id($participant_id)->delete();
     unset($this->participants[$participant_id]);
   }
 
+  /**
+   * @param $participant
+   *
+   * @return mixed
+   */
   static function part_key($participant) {
     return $participant->id;
   }
 
+  /**
+   * @param null $event_cart
+   */
   public function load_associations($event_cart = NULL) {
     if ($this->assocations_loaded) {
       return;
@@ -136,6 +194,9 @@ class CRM_Event_Cart_BAO_EventInCart extends CRM_Event_Cart_DAO_EventInCart impl
     }
   }
 
+  /**
+   * @return array
+   */
   public function not_waiting_participants() {
     $result = array();
     foreach ($this->participants as $participant) {
@@ -146,19 +207,35 @@ class CRM_Event_Cart_BAO_EventInCart extends CRM_Event_Cart_DAO_EventInCart impl
     return $result;
   }
 
+  /**
+   * @return int
+   */
   public function num_not_waiting_participants() {
     return count($this->not_waiting_participants());
   }
 
+  /**
+   * @return int
+   */
   public function num_waiting_participants() {
     return count($this->waiting_participants());
   }
 
 
+  /**
+   * @param mixed $offset
+   *
+   * @return bool
+   */
   public function offsetExists($offset) {
     return array_key_exists(array_merge($this->fields(), array('main_conference_event_id')), $offset);
   }
 
+  /**
+   * @param mixed $offset
+   *
+   * @return int
+   */
   public function offsetGet($offset) {
     if ($offset == 'event') {
       return $this->event->toArray();
@@ -173,10 +250,20 @@ class CRM_Event_Cart_BAO_EventInCart extends CRM_Event_Cart_DAO_EventInCart impl
     return $fields[$offset];
   }
 
+  /**
+   * @param mixed $offset
+   * @param mixed $value
+   */
   public function offsetSet($offset, $value) {}
 
+  /**
+   * @param mixed $offset
+   */
   public function offsetUnset($offset) {}
 
+  /**
+   * @return array
+   */
   public function waiting_participants() {
     $result = array();
     foreach ($this->participants as $participant) {
@@ -187,6 +274,11 @@ class CRM_Event_Cart_BAO_EventInCart extends CRM_Event_Cart_DAO_EventInCart impl
     return $result;
   }
 
+  /**
+   * @param $event_id
+   *
+   * @return array
+   */
   static function get_registration_link($event_id) {
     $cart = CRM_Event_Cart_BAO_Cart::find_or_create_for_current_session();
     $cart->load_associations();
@@ -208,10 +300,18 @@ class CRM_Event_Cart_BAO_EventInCart extends CRM_Event_Cart_DAO_EventInCart impl
     }
   }
 
+  /**
+   * @return bool
+   */
   function is_parent_event() {
     return (NULL !== (CRM_Event_BAO_Event::get_sub_events($this->event_id)));
   }
 
+  /**
+   * @param null $parent_event_id
+   *
+   * @return bool
+   */
   function is_child_event($parent_event_id = NULL) {
     if ($parent_event_id == NULL) {
       return $this->event->parent_event_id;
index adb259fc435fcb4b7fe5ea7b1be214152d67a59d..3ab862bef1a673bd9aad709377fbefcf30c1b0e4 100644 (file)
 +--------------------------------------------------------------------+
 */
 
+/**
+ * Class CRM_Event_Cart_BAO_MerParticipant
+ */
 class CRM_Event_Cart_BAO_MerParticipant extends CRM_Event_BAO_Participant {
   public $email = NULL;
   public $contribution_id = NULL;
   public $cart = NULL;
 
   //XXX
+  /**
+   * @param null $participant
+   */
   function __construct($participant = NULL) {
     parent::__construct();
     $a = (array)$participant;
@@ -39,6 +45,12 @@ class CRM_Event_Cart_BAO_MerParticipant extends CRM_Event_BAO_Participant {
     $this->email = CRM_Utils_Array::value('email', $participant);
   }
 
+  /**
+   * @param array $params
+   *
+   * @return CRM_Event_Cart_BAO_MerParticipant
+   * @throws Exception
+   */
   public static function &create($params) {
     $participantParams = array(
       'id' => CRM_Utils_Array::value('id', $params),
@@ -63,18 +75,29 @@ class CRM_Event_Cart_BAO_MerParticipant extends CRM_Event_BAO_Participant {
     return $mer_participant;
   }
 
+  /**
+   * @return mixed
+   */
   static function get_attendee_role_id() {
     $roles = CRM_Event_PseudoConstant::participantRole(NULL, "v.label='Attendee'");
     $role_names = array_keys($roles);
     return end($role_names);
   }
 
+  /**
+   * @return mixed
+   */
   static function get_pending_in_cart_status_id() {
     $status_types = CRM_Event_PseudoConstant::participantStatus(NULL, "name='Pending in cart'");
     $status_names = array_keys($status_types);
     return end($status_names);
   }
 
+  /**
+   * @param $event_cart_id
+   *
+   * @return array|null
+   */
   public static function find_all_by_cart_id($event_cart_id) {
     if ($event_cart_id == NULL) {
       return NULL;
@@ -82,6 +105,12 @@ class CRM_Event_Cart_BAO_MerParticipant extends CRM_Event_BAO_Participant {
     return self::find_all_by_params(array('cart_id' => $event_cart_id));
   }
 
+  /**
+   * @param $event_id
+   * @param $event_cart_id
+   *
+   * @return array|null
+   */
   public static function find_all_by_event_and_cart_id($event_id, $event_cart_id) {
     if ($event_cart_id == NULL) {
       return NULL;
@@ -89,6 +118,11 @@ class CRM_Event_Cart_BAO_MerParticipant extends CRM_Event_BAO_Participant {
     return self::find_all_by_params(array('event_id' => $event_id, 'cart_id' => $event_cart_id));
   }
 
+  /**
+   * @param $params
+   *
+   * @return array
+   */
   public static function find_all_by_params($params) {
     $participant = new CRM_Event_BAO_Participant();
     $participant->copyValues($params);
@@ -101,6 +135,11 @@ class CRM_Event_Cart_BAO_MerParticipant extends CRM_Event_BAO_Participant {
     return $result;
   }
 
+  /**
+   * @param $id
+   *
+   * @return mixed
+   */
   public static function get_by_id($id) {
     $results = self::find_all_by_params(array('id' => $id));
     return array_pop($results);
@@ -111,6 +150,9 @@ class CRM_Event_Cart_BAO_MerParticipant extends CRM_Event_BAO_Participant {
     $this->email = $contact_details[1];
   }
 
+  /**
+   * @return int
+   */
   function get_participant_index() {
     if (!$this->cart) {
       $this->cart = CRM_Event_Cart_BAO_Cart::find_by_id($this->cart_id);
@@ -120,6 +162,11 @@ class CRM_Event_Cart_BAO_MerParticipant extends CRM_Event_BAO_Participant {
     return $index + 1;
   }
 
+  /**
+   * @param $contact
+   *
+   * @return null
+   */
   static function billing_address_from_contact($contact) {
     foreach ($contact->address as $loc) {
       if ($loc['is_billing']) {
@@ -134,6 +181,9 @@ class CRM_Event_Cart_BAO_MerParticipant extends CRM_Event_BAO_Participant {
     return NULL;
   }
 
+  /**
+   * @return CRM_Event_Cart_Form_MerParticipant
+   */
   function get_form() {
     return new CRM_Event_Cart_Form_MerParticipant($this);
   }
index 66d1c6d23e97b5459a5a8701d8f3f501d97b1bc3..fe861bbab791b674828ee3173206e91e8e7f0e43 100644 (file)
@@ -1,5 +1,14 @@
 <?php
+
+/**
+ * Class CRM_Event_Cart_Controller_Checkout
+ */
 class CRM_Event_Cart_Controller_Checkout extends CRM_Core_Controller {
+  /**
+   * @param null $title
+   * @param bool|int $action
+   * @param bool $modal
+   */
   function __construct($title = NULL, $action = CRM_Core_Action::NONE, $modal = TRUE) {
     parent::__construct($title, $modal);
 
index 89e323257a587e6a336d31cef0c09566ea9f155e..04a17a9959dfed47ac545ffad041e34b4f9a5e83 100644 (file)
@@ -1,4 +1,8 @@
 <?php
+
+/**
+ * Class CRM_Event_Cart_Form_Cart
+ */
 class CRM_Event_Cart_Form_Cart extends CRM_Core_Form {
   public $cart;
 
@@ -72,6 +76,11 @@ class CRM_Event_Cart_Form_Cart extends CRM_Core_Form {
     }
   }
 
+  /**
+   * @param $event_id
+   *
+   * @return bool|int|null|string
+   */
   function checkEventCapacity($event_id) {
     $empty_seats = CRM_Event_BAO_Participant::eventFull($event_id, TRUE);
     if (is_numeric($empty_seats)) {
@@ -85,11 +94,17 @@ class CRM_Event_Cart_Form_Cart extends CRM_Core_Form {
     }
   }
 
+  /**
+   * @return bool
+   */
   static function is_administrator() {
     global $user;
     return CRM_Core_Permission::check('administer CiviCRM');
   }
 
+  /**
+   * @return mixed
+   */
   function getContactID() {
     //XXX when do we query 'cid' ?
     $tempID = CRM_Utils_Request::retrieve('cid', 'Positive', $this);
@@ -109,6 +124,11 @@ class CRM_Event_Cart_Form_Cart extends CRM_Core_Form {
     return $session->get('userID');
   }
 
+  /**
+   * @param $fields
+   *
+   * @return mixed|null
+   */
   static function find_contact($fields) {
     $dedupe_params = CRM_Dedupe_Finder::formatParams($fields, 'Individual');
     $dedupe_params['check_permission'] = FALSE;
@@ -119,6 +139,12 @@ class CRM_Event_Cart_Form_Cart extends CRM_Core_Form {
     else return NULL;
   }
 
+  /**
+   * @param null $registeringContactID
+   * @param array $fields
+   *
+   * @return int|mixed|null
+   */
   static function find_or_create_contact($registeringContactID = NULL, $fields = array(
     )) {
     $contact_id = self::find_contact($fields);
@@ -140,6 +166,11 @@ class CRM_Event_Cart_Form_Cart extends CRM_Core_Form {
     return $contact_id;
   }
 
+  /**
+   * @param $page_name
+   *
+   * @return mixed
+   */
   function getValuesForPage($page_name) {
     $container = $this->controller->container();
     return $container['values'][$page_name];
index d96b08be7c275c7568bb43b199b567a012704731..c165c99a9d84b8e204aea8564d77857384ce6697 100644 (file)
@@ -1,4 +1,8 @@
 <?php
+
+/**
+ * Class CRM_Event_Cart_Form_Checkout_ConferenceEvents
+ */
 class CRM_Event_Cart_Form_Checkout_ConferenceEvents extends CRM_Event_Cart_Form_Cart {
   public $conference_event = NULL;
   public $events_by_slot = array();
index 9391cd2c54a1b826bbc52567ec8a2bccc22fdc74..79530170b811435aff7ec5f02a9ebd62f3ce13e5 100644 (file)
@@ -1,4 +1,8 @@
 <?php
+
+/**
+ * Class CRM_Event_Cart_Form_Checkout_ParticipantsAndPrices
+ */
 class CRM_Event_Cart_Form_Checkout_ParticipantsAndPrices extends CRM_Event_Cart_Form_Cart {
   public $price_fields_for_event;
   public $_values = NULL;
@@ -46,6 +50,11 @@ class CRM_Event_Cart_Form_Checkout_ParticipantsAndPrices extends CRM_Event_Cart_
     }
   }
 
+  /**
+   * @param $contact
+   *
+   * @return null
+   */
   static function primary_email_from_contact($contact) {
     foreach ($contact->email as $email) {
       if ($email['is_primary']) {
@@ -56,6 +65,11 @@ class CRM_Event_Cart_Form_Checkout_ParticipantsAndPrices extends CRM_Event_Cart_
     return NULL;
   }
 
+  /**
+   * @param $event
+   *
+   * @return array
+   */
   function build_price_options($event) {
     $price_fields_for_event = array();
     $base_field_name = "event_{$event->id}_amount";
@@ -74,6 +88,9 @@ class CRM_Event_Cart_Form_Checkout_ParticipantsAndPrices extends CRM_Event_Cart_
     return $price_fields_for_event;
   }
 
+  /**
+   * @return bool
+   */
   function validate() {
     parent::validate();
     if ($this->_errors) {
@@ -135,6 +152,9 @@ class CRM_Event_Cart_Form_Checkout_ParticipantsAndPrices extends CRM_Event_Cart_
     return empty($this->_errors);
   }
 
+  /**
+   * @return array
+   */
   public function setDefaultValues() {
     $this->loadCart();
 
index 8f601bd1e0d2e4cd58b163e87da0b7d8a5689ad2..decef950de6b61e9d4522365b80028ce89afae28 100644 (file)
@@ -1,4 +1,8 @@
 <?php
+
+/**
+ * Class CRM_Event_Cart_Form_Checkout_Payment
+ */
 class CRM_Event_Cart_Form_Checkout_Payment extends CRM_Event_Cart_Form_Cart {
   public $all_participants;
   public $financial_type_id;
@@ -13,6 +17,13 @@ class CRM_Event_Cart_Form_Checkout_Payment extends CRM_Event_Cart_Form_Cart {
   public $is_pay_later = FALSE;
   public $pay_later_receipt;
 
+  /**
+   * @param $params
+   * @param $participant
+   * @param $event
+   *
+   * @return mixed
+   */
   function registerParticipant($params, &$participant, $event) {
     $transaction = new CRM_Core_Transaction();
 
@@ -224,6 +235,10 @@ class CRM_Event_Cart_Form_Checkout_Payment extends CRM_Event_Cart_Form_Cart {
     }
   }
 
+  /**
+   * @param $event_in_cart
+   * @param null $class
+   */
   function process_event_line_item(&$event_in_cart, $class = NULL) {
     $cost         = 0;
     $price_set_id = CRM_Price_BAO_PriceSet::getFor("civicrm_event", $event_in_cart->event_id);
@@ -254,6 +269,10 @@ class CRM_Event_Cart_Form_Checkout_Payment extends CRM_Event_Cart_Form_Cart {
     $this->add_line_item($event_in_cart, $class);
   }
 
+  /**
+   * @param $event_in_cart
+   * @param null $class
+   */
   function add_line_item($event_in_cart, $class = NULL) {
     $amount = 0;
     $cost = 0;
@@ -285,11 +304,18 @@ class CRM_Event_Cart_Form_Checkout_Payment extends CRM_Event_Cart_Form_Cart {
     $this->sub_total += $amount;
   }
 
+  /**
+   * @return mixed
+   */
   function getDefaultFrom() {
     $values = CRM_Core_OptionGroup::values('from_email_address');
     return $values[1];
   }
 
+  /**
+   * @param $events_in_cart
+   * @param $params
+   */
   function emailReceipt($events_in_cart, $params) {
     $contact_details    = CRM_Contact_BAO_Contact::getContactDetails($this->payer_contact_id);
     $state_province     = new CRM_Core_DAO_StateProvince();
@@ -356,6 +382,13 @@ class CRM_Event_Cart_Form_Checkout_Payment extends CRM_Event_Cart_Form_Cart {
     CRM_Core_BAO_MessageTemplate::sendTemplate($send_template_params);
   }
 
+  /**
+   * @param $fields
+   * @param $files
+   * @param $self
+   *
+   * @return array|bool
+   */
   static function formRule($fields, $files, $self) {
     $errors = array();
 
@@ -374,6 +407,9 @@ class CRM_Event_Cart_Form_Checkout_Payment extends CRM_Event_Cart_Form_Cart {
     return empty($errors) ? TRUE : $errors;
   }
 
+  /**
+   * @return bool
+   */
   function validate() {
     if ($this->is_pay_later) {
       $this->_fields['credit_card_number']['is_required'] = FALSE;
@@ -524,6 +560,12 @@ class CRM_Event_Cart_Form_Checkout_Payment extends CRM_Event_Cart_Form_Cart {
     $transaction->commit();
   }
 
+  /**
+   * @param $params
+   *
+   * @return array
+   * @throws Exception
+   */
   function make_payment(&$params) {
     $config = CRM_Core_Config::singleton();
     if (isset($params["billing_state_province_id-{$this->_bltID}"]) && $params["billing_state_province_id-{$this->_bltID}"]) {
@@ -558,6 +600,14 @@ class CRM_Event_Cart_Form_Checkout_Payment extends CRM_Event_Cart_Form_Cart {
     return $trxnDetails;
   }
 
+  /**
+   * @param $mer_participant
+   * @param $params
+   * @param $event
+   *
+   * @return object
+   * @throws Exception
+   */
   function record_contribution(&$mer_participant, &$params, $event) {
     if (self::is_administrator() && !empty($params['payment_type'])) {
       $params['payment_instrument_id'] = $params['payment_type'];
@@ -623,6 +673,9 @@ class CRM_Event_Cart_Form_Checkout_Payment extends CRM_Event_Cart_Form_Cart {
     $this->set('total', $this->total);
   }
 
+  /**
+   * @return array
+   */
   function setDefaultValues() {
 
     $defaults = parent::setDefaultValues();
index f653d3e3b9ecd4b9f3458fa0bdf22e6cf13f3c5a..63fe344aae31077eb17452ee66e67e09e8d335f0 100644 (file)
@@ -1,4 +1,8 @@
 <?php
+
+/**
+ * Class CRM_Event_Cart_Form_Checkout_ThankYou
+ */
 class CRM_Event_Cart_Form_Checkout_ThankYou extends CRM_Event_Cart_Form_Cart {
   public $line_items = NULL;
   public $sub_total = 0;
index a50326057a231adcb9b437aa11ef47fae271a44c..ea26611a3d797cd67b363a640a4c2ad83ad022ba 100644 (file)
@@ -1,13 +1,23 @@
 <?php
+
+/**
+ * Class CRM_Event_Cart_Form_MerParticipant
+ */
 class CRM_Event_Cart_Form_MerParticipant extends CRM_Core_Form {
   public $participant = NULL;
 
+  /**
+   * @param null|object $participant
+   */
   function __construct($participant) {
     parent::__construct();
     //XXX
     $this->participant = $participant;
   }
 
+  /**
+   * @param $form
+   */
   function appendQuickForm(&$form) {
     $textarea_size = array('size' => 30, 'maxlength' => 60);
     $form->add('text', $this->email_field_name(), ts('Email Address'), $textarea_size, TRUE);
@@ -31,6 +41,11 @@ class CRM_Event_Cart_Form_MerParticipant extends CRM_Core_Form {
         )));
   }
 
+  /**
+   * @param $event_id
+   *
+   * @return array
+   */
   function get_profile_groups($event_id) {
     $ufJoinParams = array(
       'entity_table' => 'civicrm_event',
@@ -41,6 +56,9 @@ class CRM_Event_Cart_Form_MerParticipant extends CRM_Core_Form {
     return $group_ids;
   }
 
+  /**
+   * @return array
+   */
   function get_participant_custom_data_fields() {
     list($custom_pre_id, $custom_post_id) = self::get_profile_groups($this->participant->event_id);
 
@@ -55,27 +73,53 @@ class CRM_Event_Cart_Form_MerParticipant extends CRM_Core_Form {
     return array($pre_fields, $post_fields);
   }
 
+  /**
+   * @return string
+   */
   function email_field_name() {
     return $this->html_field_name("email");
   }
 
+  /**
+   * @param $event_id
+   * @param $participant_id
+   * @param $field_name
+   *
+   * @return string
+   */
   static function full_field_name($event_id, $participant_id, $field_name) {
     return "event[$event_id][participant][$participant_id][$field_name]";
   }
 
+  /**
+   * @param $field_name
+   *
+   * @return string
+   */
   function html_field_name($field_name) {
     return self::full_field_name($this->participant->event_id, $this->participant->id, $field_name);
   }
 
+  /**
+   * @return string
+   */
   function name() {
     return "Participant {$this->participant->get_participant_index()}";
   }
 
   //XXX poor name
+  /**
+   * @param $participant
+   *
+   * @return CRM_Event_Cart_Form_MerParticipant
+   */
   static public function get_form($participant) {
     return new CRM_Event_Cart_Form_MerParticipant($participant);
   }
 
+  /**
+   * @return array
+   */
   function setDefaultValues() {
     $defaults = array(
       $this->html_field_name('email') => $this->participant->email,
index f22f3fd480221b25dfb7e4390b0d4de972e36698..8218a2b2f2d701b6fc5ae41f58589041f4bb420e 100644 (file)
@@ -1,4 +1,8 @@
 <?php
+
+/**
+ * Class CRM_Event_Cart_Page_AddToCart
+ */
 class CRM_Event_Cart_Page_AddToCart extends CRM_Core_Page {
   function run() {
     $transaction = new CRM_Core_Transaction();
index 590ecc005d25f44fb039c5bc172b514669c2ba98..bef47d294f07a7d831810bfee47a671f6ea5d61c 100644 (file)
@@ -1,4 +1,8 @@
 <?php
+
+/**
+ * Class CRM_Event_Cart_Page_CheckoutAJAX
+ */
 class CRM_Event_Cart_Page_CheckoutAJAX {
   function add_participant_to_cart() {
     require 'CRM/Core/Transaction.php';
index 63a08cfcc414a5da0b7dbfca50a7b11fd11809f3..519dcaee4360449dfd099afe7fc4fe6d97b040c7 100644 (file)
@@ -1,4 +1,8 @@
 <?php
+
+/**
+ * Class CRM_Event_Cart_Page_RemoveFromCart
+ */
 class CRM_Event_Cart_Page_RemoveFromCart extends CRM_Core_Page {
   function run() {
     $transaction = new CRM_Core_Transaction();
index 4cf44ffc245d8f2522126ad67e9e417afbf674b5..70654afbe33ce45fd7f64642f485624c325bda9d 100644 (file)
@@ -1,5 +1,12 @@
 <?php
+
+/**
+ * Class CRM_Event_Cart_Page_ViewCart
+ */
 class CRM_Event_Cart_Page_ViewCart extends CRM_Core_Page {
+  /**
+   * @return string
+   */
   function run() {
     $transaction = new CRM_Core_Transaction();
 
index bcec8e3af9e1ecfdeffb2f01806413630773c543..8e2a42847154c12f5e832cb246c5b41df59ed00d 100644 (file)
@@ -1,5 +1,13 @@
 <?php
+
+/**
+ * Class CRM_Event_Cart_StateMachine_Checkout
+ */
 class CRM_Event_Cart_StateMachine_Checkout extends CRM_Core_StateMachine {
+  /**
+   * @param object $controller
+   * @param const|int $action
+   */
   function __construct($controller, $action = CRM_Core_Action::NONE) {
     parent::__construct($controller, $action);
 
index 59da12181321886d17e166ecd4250f845aea5014..6473a0ad34b5dc0df54f62fed4b6d25dcd150276 100644 (file)
@@ -367,6 +367,9 @@ class CRM_Event_Form_ManageEvent extends CRM_Core_Form {
     }
   }
 
+  /**
+   * @return string
+   */
   function getTemplateFileName() {
     if ($this->controller->getPrint() || $this->getVar('_id') <= 0 || $this->_action & CRM_Core_Action::DELETE) {
       return parent::getTemplateFileName();
index ab4b017397bfc626c0a76779f160c510ab6ced04..cc998e868c6d3970590333d5cff6b40f1fbb3c65 100644 (file)
@@ -357,6 +357,11 @@ class CRM_Event_Form_ManageEvent_EventInfo extends CRM_Event_Form_ManageEvent {
      * @return $defaults an array of custom data defaults.
      */
 
+  /**
+   * @param $templateId
+   *
+   * @return array
+   */
   public function templateCustomDataValues($templateId) {
     $defaults = array();
     if (!$templateId) {
index 245055e7cee2aa02f60181ed6eb9714d8aaef918..5a1ef70c4bc1811d31784d1786473b3c7a492a6e 100644 (file)
@@ -437,6 +437,9 @@ class CRM_Event_Form_ManageEvent_Registration extends CRM_Event_Form_ManageEvent
     $form->addRule('confirm_from_email', ts('Email is not valid.'), 'email');
   }
 
+  /**
+   * @param $form
+   */
   function buildThankYouBlock(&$form) {
     $attributes = CRM_Core_DAO::getAttribute('CRM_Event_DAO_Event');
     $attributes['thankyou_text']['click_wysiwyg'] = true;
index a22c87ae4d551281555653b0222730b4395ca198..3bf3823b77ec1b343d90e06002b473461ce52f60 100644 (file)
  */
 class CRM_Event_Form_ManageEvent_TabHeader {
 
+  /**
+   * @param $form
+   *
+   * @return array
+   */
   static function build(&$form) {
     $tabs = $form->get('tabHeader');
     if (!$tabs || empty($_GET['reset'])) {
@@ -62,6 +67,12 @@ class CRM_Event_Form_ManageEvent_TabHeader {
     return $tabs;
   }
 
+  /**
+   * @param $form
+   *
+   * @return array
+   * @throws Exception
+   */
   static function process(&$form) {
     if ($form->getVar('_id') <= 0) {
       return NULL;
@@ -98,7 +109,7 @@ class CRM_Event_Form_ManageEvent_TabHeader {
 
     $eventID = $form->getVar('_id');
     if ($eventID) {
-      // disable tabs based on their configuration status 
+      // disable tabs based on their configuration status
       $sql = "
 SELECT     e.loc_block_id as is_location, e.is_online_registration, e.is_monetary, taf.is_active, pcp.is_active as is_pcp, sch.id as is_reminder
 FROM       civicrm_event e
@@ -187,11 +198,19 @@ WHERE      e.id = %1
     return $tabs;
   }
 
+  /**
+   * @param $form
+   */
   static function reset(&$form) {
     $tabs = self::process($form);
     $form->set('tabHeader', $tabs);
   }
 
+  /**
+   * @param $tabs
+   *
+   * @return int|string
+   */
   static function getCurrentTab($tabs) {
     static $current = FALSE;
 
index 1573307296a55a4bd74797c59d4de3d079fd9091..7ff20fb1ac92e1ec2d55535f496cdaf36343aaf6 100644 (file)
@@ -213,6 +213,13 @@ class CRM_Event_Form_ParticipantFeeSelection extends CRM_Core_Form {
     $this->addFormRule(array('CRM_Event_Form_ParticipantFeeSelection', 'formRule'), $this);
   }
 
+  /**
+   * @param $fields
+   * @param $files
+   * @param $self
+   *
+   * @return array
+   */
   static function formRule($fields, $files, $self) {
     $errors = array();
     return $errors;
@@ -256,6 +263,11 @@ class CRM_Event_Form_ParticipantFeeSelection extends CRM_Core_Form {
     }
   }
 
+  /**
+   * @param $params
+   *
+   * @return mixed
+   */
   function emailReceipt(&$params) {
     $updatedLineItem = CRM_Price_BAO_LineItem::getLineItems($this->_participantId, 'participant', NULL, FALSE);
     $lineItem = array();
index 1072a9efec5a5ded1ba40cb887db9390c6d31fdc..37a9074bb896d17a3d80058b4603f547a43c1921 100644 (file)
@@ -678,6 +678,12 @@ class CRM_Event_Form_Registration extends CRM_Core_Form {
     }
   }
 
+  /**
+   * @param $form
+   * @param $eventID
+   *
+   * @throws Exception
+   */
   static function initEventFee(&$form, $eventID) {
     // get price info
 
@@ -940,6 +946,13 @@ WHERE  v.option_group_id = g.id
    * @return $totalCount total participant count.
    * @access public
    */
+  /**
+   * @param $form
+   * @param $params
+   * @param bool $skipCurrent
+   *
+   * @return int|string
+   */
   public static function getParticipantCount(&$form, $params, $skipCurrent = FALSE) {
     $totalCount = 0;
     if (!is_array($params) || empty($params)) {
@@ -1032,6 +1045,12 @@ WHERE  v.option_group_id = g.id
    * @return array $formatted, formatted price set params.
    * @access public
    */
+  /**
+   * @param $form
+   * @param $params
+   *
+   * @return mixed
+   */
   public static function formatPriceSetParams(&$form, $params) {
     if (!is_array($params) || empty($params)) {
       return $params;
@@ -1076,6 +1095,11 @@ WHERE  v.option_group_id = g.id
    * @return array $optionsCount, array of each option w/ count total.
    * @access public
    */
+  /**
+   * @param $form
+   *
+   * @return array
+   */
   public static function getPriceSetOptionCount(&$form) {
     $params     = $form->get('params');
     $priceSet   = $form->get('priceSet');
@@ -1141,6 +1165,11 @@ WHERE  v.option_group_id = g.id
     return $optionsCount;
   }
 
+  /**
+   * @param string $suffix
+   *
+   * @return null|string
+   */
   function checkTemplateFileExists($suffix = '') {
     if ($this->_eventId) {
       $templateName = $this->_name;
@@ -1157,11 +1186,17 @@ WHERE  v.option_group_id = g.id
     return NULL;
   }
 
+  /**
+   * @return null|string
+   */
   function getTemplateFileName() {
     $fileName = $this->checkTemplateFileExists();
     return $fileName ? $fileName : parent::getTemplateFileName();
   }
 
+  /**
+   * @return null|string
+   */
   function overrideExtraTemplateFileName() {
     $fileName = $this->checkTemplateFileExists('extra.');
     return $fileName ? $fileName : parent::overrideExtraTemplateFileName();
@@ -1307,6 +1342,9 @@ WHERE  v.option_group_id = g.id
   }
 
   // set the first participant ID if not set, CRM-10032
+  /**
+   * @param $participantID
+   */
   function processFirstParticipant($participantID) {
     $this->_participantId = $participantID;
     $this->set('participantId', $this->_participantId);
index 68dab3a3990d8283c352263658f2b24ca63e350d..bc4a6148c8736926e4c0ef01cd3d8a789b20ad0e 100644 (file)
@@ -513,6 +513,12 @@ class CRM_Event_Form_Registration_AdditionalParticipant extends CRM_Event_Form_R
     return $errors;
   }
 
+  /**
+   * @param $self
+   * @param $fields
+   *
+   * @return bool
+   */
   function validatePaymentValues($self, $fields) {
 
     if (!empty($self->_params[0]['bypass_payment']) ||
@@ -725,6 +731,11 @@ class CRM_Event_Form_Registration_AdditionalParticipant extends CRM_Event_Form_R
     }
   }
 
+  /**
+   * @param $additionalParticipant
+   *
+   * @return array
+   */
   public static function &getPages($additionalParticipant) {
     $details = array();
     for ($i = 1; $i <= $additionalParticipant; $i++) {
@@ -812,6 +823,10 @@ class CRM_Event_Form_Registration_AdditionalParticipant extends CRM_Event_Form_R
     }
   }
 
+  /**
+   * @param $elementName
+   * @param array $optionIds
+   */
   function resetSubmittedValue($elementName, $optionIds = array(
     )) {
     if (empty($elementName) ||
index 4905bc8f1a3ebc57d257434842a88912b4b46ac1..f5946e31e3948b1c4ee900606cdb1a414d177e65 100644 (file)
@@ -1086,6 +1086,9 @@ class CRM_Event_Form_Registration_Confirm extends CRM_Event_Form_Registration {
     return $contactID;
   }
 
+  /**
+   * @param $form
+   */
   public static function assignProfiles(&$form) {
     $addParticipantProfile = $form->get('addParticipantProfile');
     $primaryParticipantProfile = $form->get('primaryParticipantProfile');
index a0285f00e80a57a7a81179f0376c32ecba4b8195..8b0f44eb3bd6abf10e0920f2766be4314281ea71 100644 (file)
@@ -692,6 +692,9 @@ class CRM_Event_Form_Registration_Register extends CRM_Event_Form_Registration {
     }
   }
 
+  /**
+   * @param $form
+   */
   public static function formatFieldsForOptionFull(&$form) {
     $priceSet = $form->get('priceSet');
     $priceSetId = $form->get('priceSetId');
@@ -1205,6 +1208,10 @@ class CRM_Event_Form_Registration_Register extends CRM_Event_Form_Registration {
    * access public
    *
    */
+  /**
+   * @param $params
+   * @param null $contactID
+   */
   public function processRegistration($params, $contactID = NULL) {
     $session = CRM_Core_Session::singleton();
     $this->_participantInfo = array();
index e4be22736d02a0a43abab8e61674158bfde1f5b3..6c66f3673b7b2f9f0499813e94116827b21b4965 100644 (file)
@@ -528,6 +528,9 @@ class CRM_Event_Form_Search extends CRM_Core_Form_Search {
     }
   }
 
+  /**
+   * @return null
+   */
   function getFormValues() {
     return NULL;
   }
index 4df0277619fed6fd44eb8b3ffa892bfef517e479..af55dc0f182059c66198e87185699655ee237835 100644 (file)
@@ -34,6 +34,9 @@
  */
 class CRM_Event_Form_SearchEvent extends CRM_Core_Form {
 
+  /**
+   * @return array
+   */
   function setDefaultValues() {
     $defaults = array();
     $defaults['eventsByDates'] = 0;
index f32c5091fcea1cfccf3918e1109ac66caeed2be0..efde2567ba3652f44c552d8e45e2f2c2f8ed75c9 100644 (file)
@@ -79,6 +79,10 @@ class CRM_Event_Form_Task extends CRM_Core_Form {
     self::preProcessCommon($this);
   }
 
+  /**
+   * @param $form
+   * @param bool $useTable
+   */
   static function preProcessCommon(&$form, $useTable = FALSE) {
     $form->_participantIds = array();
 
index b3f02b96b7592fb3a07ba2c02d9d837956c1747a..e0078ef21c32cd7f4f42612caa5725af3a643930 100644 (file)
@@ -339,6 +339,12 @@ class CRM_Event_Form_Task_Batch extends CRM_Event_Form_Task {
   }
   //end of function
 
+  /**
+   * @param $participantId
+   * @param $statusId
+   *
+   * @return Ambigous|void
+   */
   static function updatePendingOnlineContribution($participantId, $statusId) {
     if (!$participantId || !$statusId) {
       return;
index 3befefa8493add002fd7f16e4c63d48b65d48d59..d3195467bb7333e5ec3c7feb0cb657a55cbf0334 100644 (file)
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
 */
+
+/**
+ * Class CRM_Event_Import_Field
+ */
 class CRM_Event_Import_Field {
 
   /**#@+
@@ -64,6 +68,14 @@ class CRM_Event_Import_Field {
    * @var object
    */
   public $_value;
+
+  /**
+   * @param $name
+   * @param $title
+   * @param int $type
+   * @param string $headerPattern
+   * @param string $dataPattern
+   */
   function __construct($name, $title, $type = CRM_Utils_Type::T_INT, $headerPattern = '//', $dataPattern = '//') {
     $this->_name = $name;
     $this->_title = $title;
@@ -86,6 +98,9 @@ class CRM_Event_Import_Field {
     $this->_value = $value;
   }
 
+  /**
+   * @return bool
+   */
   function validate() {
     if (CRM_Utils_System::isNull($this->_value)) {
       return TRUE;
index 904ed039d5b1a37d58dce1279ee5621435b68967..24c9629add272ddbfd78513ff2c4a6f515d8162b 100644 (file)
@@ -65,6 +65,18 @@ abstract class CRM_Event_Import_Parser extends CRM_Import_Parser {
    */
   protected $_haveColumnHeader;
 
+  /**
+   * @param $fileName
+   * @param string $seperator
+   * @param $mapper
+   * @param bool $skipColumnHeader
+   * @param int $mode
+   * @param int $contactType
+   * @param int $onDuplicate
+   *
+   * @return mixed
+   * @throws Exception
+   */
   function run($fileName,
     $seperator = ',',
     &$mapper,
@@ -317,6 +329,13 @@ abstract class CRM_Event_Import_Parser extends CRM_Import_Parser {
     return $params;
   }
 
+  /**
+   * @param $name
+   * @param $title
+   * @param int $type
+   * @param string $headerPattern
+   * @param string $dataPattern
+   */
   function addField($name, $title, $type = CRM_Utils_Type::T_INT, $headerPattern = '//', $dataPattern = '//') {
     if (empty($name)) {
       $this->_fields['doNotImport'] = new CRM_Event_Import_Field($name, $title, $type, $headerPattern, $dataPattern);
index ac38639c02ffccd30003c72a2615ad435cf351f8..1d6d2d0f05beb6cd139b990a7f3748d71efd9660 100644 (file)
@@ -41,6 +41,9 @@ class CRM_Event_Info extends CRM_Core_Component_Info {
   protected $keyword = 'event';
 
   // docs inherited from interface
+  /**
+   * @return array
+   */
   public function getInfo() {
     return array(
       'name' => 'CiviEvent',
@@ -52,6 +55,11 @@ class CRM_Event_Info extends CRM_Core_Component_Info {
   }
 
   // docs inherited from interface
+  /**
+   * @param bool $getAllUnconditionally
+   *
+   * @return array
+   */
   public function getPermissions($getAllUnconditionally = FALSE) {
     return array(
       'access CiviEvent',
@@ -64,6 +72,9 @@ class CRM_Event_Info extends CRM_Core_Component_Info {
     );
   }
 
+  /**
+   * @return array
+   */
   public function getAnonymousPermissionWarnings() {
     return array(
       'access CiviEvent',
@@ -71,6 +82,9 @@ class CRM_Event_Info extends CRM_Core_Component_Info {
   }
 
   // docs inherited from interface
+  /**
+   * @return array
+   */
   public function getUserDashboardElement() {
     return array('name' => ts('Events'),
       'title' => ts('Your Event(s)'),
@@ -80,6 +94,9 @@ class CRM_Event_Info extends CRM_Core_Component_Info {
   }
 
   // docs inherited from interface
+  /**
+   * @return array
+   */
   public function registerTab() {
     return array('title' => ts('Events'),
       'id' => 'participant',
@@ -89,6 +106,9 @@ class CRM_Event_Info extends CRM_Core_Component_Info {
   }
 
   // docs inherited from interface
+  /**
+   * @return array
+   */
   public function registerAdvancedSearchPane() {
     return array('title' => ts('Events'),
       'weight' => 40,
@@ -96,6 +116,9 @@ class CRM_Event_Info extends CRM_Core_Component_Info {
   }
 
   // docs inherited from interface
+  /**
+   * @return array
+   */
   public function getActivityTypes() {
     $types = array();
     $types['Event'] = array('title' => ts('Event'),
@@ -105,6 +128,10 @@ class CRM_Event_Info extends CRM_Core_Component_Info {
   }
 
   // add shortcut to Create New
+  /**
+   * @param $shortCuts
+   * @param $newCredit
+   */
   public function creatNewShortcut(&$shortCuts, $newCredit) {
     if (CRM_Core_Permission::check('access CiviEvent') &&
       CRM_Core_Permission::check('edit event participants')
index 1e9723564e46642e3e3e88515ba1df2a062a62fa..e5011dcc8a06c5e25ff5915e2a9f5f1c98d47b98 100644 (file)
@@ -122,7 +122,7 @@ class CRM_Event_Page_EventInfo extends CRM_Core_Page {
           // CRM-14492 Admin price fields should show up on event registration if user has 'administer CiviCRM' permissions
           $adminFieldVisible = false;
           if (CRM_Core_Permission::check('administer CiviCRM')) {
-            $adminFieldVisible = true; 
+            $adminFieldVisible = true;
           }
 
           foreach ($priceSetFields as $fid => $fieldValues) {
@@ -335,6 +335,9 @@ class CRM_Event_Page_EventInfo extends CRM_Core_Page {
     return parent::run();
   }
 
+  /**
+   * @return string
+   */
   function getTemplateFileName() {
     if ($this->_id) {
       $templateFile = "CRM/Event/Page/{$this->_id}/EventInfo.tpl";
index 85b2ab12f739ecd679a021967314c526d4f6a394..3183936fedb8261c039c1ab542e7f6d382c61598 100644 (file)
@@ -416,6 +416,13 @@ ORDER BY start_date desc
     $form->run();
   }
 
+  /**
+   * @param $params
+   * @param bool $sortBy
+   * @param $force
+   *
+   * @return string
+   */
   function whereClause(&$params, $sortBy = TRUE, $force) {
     $values    = array();
     $clauses   = array();
@@ -504,6 +511,10 @@ ORDER BY start_date desc
     return !empty($clauses) ? implode(' AND ', $clauses) : '(1)';
   }
 
+  /**
+   * @param $whereClause
+   * @param $whereParams
+   */
   function pager($whereClause, $whereParams) {
 
     $params['status'] = ts('Event %%StatusMessage%%');
@@ -526,6 +537,10 @@ SELECT count(id)
     $this->assign_by_ref('pager', $this->_pager);
   }
 
+  /**
+   * @param $whereClause
+   * @param $whereParams
+   */
   function pagerAtoZ($whereClause, $whereParams) {
 
     $query = "
index 81b7b753b67419f9e5f5ec9cb08e9784f6ac582b..eb498070c80461cdb4dea4aeb7c07e095ee1a353 100644 (file)
@@ -65,6 +65,9 @@ class CRM_Event_Page_ParticipantListing_NameStatusAndDate extends CRM_Core_Page
     $this->assign('displayRecent', FALSE);
   }
 
+  /**
+   * @return string
+   */
   function run() {
     $this->preProcess();
 
@@ -117,6 +120,11 @@ LIMIT    $offset, $rowCount";
     return parent::run();
   }
 
+  /**
+   * @param $fromClause
+   * @param $whereClause
+   * @param $whereParams
+   */
   function pager($fromClause, $whereClause, $whereParams) {
 
     $params = array();
@@ -140,6 +148,9 @@ SELECT count( civicrm_contact.id )
     $this->assign_by_ref('pager', $this->_pager);
   }
 
+  /**
+   * @return string
+   */
   function orderBy() {
     static $headers = NULL;
     if (!$headers) {
index 08ca67826937f55e141a133308cd0960aede6533..67a0aefa5f5462130373c7c9b1c5818d72c0fbef 100644 (file)
@@ -56,6 +56,9 @@ class CRM_Event_Page_ParticipantListing_Simple extends CRM_Core_Page {
     $this->assign('displayRecent', FALSE);
   }
 
+  /**
+   * @return string
+   */
   function run() {
     $this->preProcess();
 
@@ -104,6 +107,11 @@ LIMIT    $offset, $rowCount";
     return parent::run();
   }
 
+  /**
+   * @param $fromClause
+   * @param $whereClause
+   * @param $whereParams
+   */
   function pager($fromClause, $whereClause, $whereParams) {
 
     $params = array();
@@ -128,6 +136,9 @@ SELECT count( civicrm_contact.id )
     $this->assign_by_ref('pager', $this->_pager);
   }
 
+  /**
+   * @return string
+   */
   function orderBy() {
     static $headers = NULL;
     if (!$headers) {
index e3634558cc1fa3de40bc740ff3be195cc91627a2..c81664a5583665cb60e8c888de79c20076fd72e0 100644 (file)
@@ -510,10 +510,16 @@ class CRM_Event_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co
     return self::$_columnHeaders;
   }
 
+  /**
+   * @return mixed
+   */
   function alphabetQuery() {
     return $this->_query->searchQuery(NULL, NULL, NULL, FALSE, FALSE, TRUE);
   }
 
+  /**
+   * @return string
+   */
   function &getQuery() {
     return $this->_query;
   }