Merge pull request #4917 from eileenmcnaughton/minor-tidies

[civicrm-core.git] / CRM / Event / BAO / Participant.php

diff --git a/CRM/Event/BAO/Participant.php b/CRM/Event/BAO/Participant.php
index 55aaf9cb79540f01186c63c0bec0197ea3e09dde..fb282d354f1ac77d9e54983c6057cd36574a6f21 100644 (file)
--- a/CRM/Event/BAO/Participant.php
+++ b/CRM/Event/BAO/Participant.php
@@ -40,7 +40,6 @@ class CRM_Event_BAO_Participant extends CRM_Event_DAO_Participant {
    * Static field for all the participant information that we can potentially import
    *
    * @var array
-   * @static
    */
   static $_importableFields = NULL;
 
@@ -48,7 +47,6 @@ class CRM_Event_BAO_Participant extends CRM_Event_DAO_Participant {
    * Static field for all the participant information that we can potentially export
    *
    * @var array
-   * @static
    */
   static $_exportableFields = NULL;
 
@@ -56,7 +54,6 @@ class CRM_Event_BAO_Participant extends CRM_Event_DAO_Participant {
    * Static array for valid status transitions rules
    *
    * @var array
-   * @static
    */
   static $_statusTransitionsRules = array(
     'Pending from pay later' => array('Registered', 'Cancelled'),
@@ -83,8 +80,7 @@ class CRM_Event_BAO_Participant extends CRM_Event_DAO_Participant {
    * @param array $params
    *   (reference ) an assoc array of name/value pairs.
    *
-   * @return CRM_Event_BAO_Participant object
-   * @static
+   * @return CRM_Event_BAO_Participant
    */
   public static function &add(&$params) {
 
@@ -169,7 +165,6 @@ class CRM_Event_BAO_Participant extends CRM_Event_DAO_Participant {
    * @param $ids
    *
    * @return CRM_Event_BAO_Participant|null the found object or null
-   * @static
    */
   public static function getValues(&$params, &$values, &$ids) {
     if (empty($params)) {
@@ -193,8 +188,7 @@ class CRM_Event_BAO_Participant extends CRM_Event_DAO_Participant {
    * @param array $params
    *   (reference ) an assoc array of name/value pairs.
    *
-   * @return CRM_Event_BAO_Participant object
-   * @static
+   * @return CRM_Event_BAO_Participant
    */
   public static function create(&$params) {
 
@@ -355,8 +349,8 @@ class CRM_Event_BAO_Participant extends CRM_Event_DAO_Participant {
    * @param bool $returnWaitingCount
    * @param bool $considerTestParticipant
    *
-   * @return bool|int|null|string 1. false                 => If event having some empty spaces.
-   * @static
+   * @return bool|int|null|string
+   *   1. false                 => If event having some empty spaces.
    */
   static function eventFull(
     $eventId,
@@ -501,7 +495,6 @@ SELECT  event.event_full_text,
    *
    * @return array
    *   an array of each option id and total count
-   * @static
    */
   static function priceSetOptionsCount(
     $eventId,
@@ -580,7 +573,6 @@ INNER JOIN  civicrm_price_field field       ON ( value.price_field_id = field.id
    *
    * @return int
    *   $spaces  Number of Empty Seats/null.
-   * @static
    */
   public static function pendingToConfirmSpaces($eventId) {
     $emptySeats = 0;
@@ -630,7 +622,6 @@ GROUP BY  participant.event_id
    *
    * @return array
    *   array of importable Fields
-   * @static
    */
   public static function &importableFields($contactType = 'Individual', $status = TRUE, $onlyParticipant = FALSE) {
     if (!self::$_importableFields) {
@@ -743,7 +734,6 @@ GROUP BY  participant.event_id
    *
    * @return array
    *   array of exportable Fields
-   * @static
    */
   public static function &exportableFields() {
     if (!self::$_exportableFields) {
@@ -796,7 +786,6 @@ GROUP BY  participant.event_id
    *
    * @return array
    *   associated array with sort_name and event title
-   * @static
    */
   public static function participantDetails($participantId) {
     $query = "
@@ -827,7 +816,6 @@ WHERE  civicrm_participant.id = {$participantId}
    *   True if we want to resolve the values in the reverse direction (value -> name).
    *
    * @return void
-   * @static
    */
   public static function resolveDefaults(&$defaults, $reverse = FALSE) {
     self::lookupValue($defaults, 'event', CRM_Event_PseudoConstant::event(), $reverse);
@@ -871,7 +859,6 @@ WHERE  civicrm_participant.id = {$participantId}
    *   Id of the participation to delete.
    *
    * @return void
-   * @static
    */
   public static function deleteParticipant($id) {
     CRM_Utils_Hook::pre('delete', 'Participant', $id, CRM_Core_DAO::$_nullArray);
@@ -932,10 +919,9 @@ WHERE  civicrm_participant.id = {$participantId}
    *   (reference ) an assoc array of name/value pairs.
    * @param array $input
    *   An assosiative array of name /value pairs.
-   * from other function
+   *   from other function
    *
-   * @return CRM_Contribute_BAO_Contribution object
-   * @static
+   * @return CRM_Contribute_BAO_Contribution
    */
   public static function checkDuplicate($input, &$duplicates) {
     $eventId = CRM_Utils_Array::value('event_id', $input);
@@ -980,7 +966,6 @@ WHERE  civicrm_participant.id = {$participantId}
    * @param string $eventLevel
    *   Event_leval string from db.
    *
-   * @static
    *
    * @return void
    */
@@ -1017,7 +1002,6 @@ WHERE  civicrm_participant.id = {$participantId}
    * @param int $oldStatusId
    *
    * @return array
-   * @static
    */
   public static function getAdditionalParticipantIds($primaryParticipantId, $excludeCancel = TRUE, $oldStatusId = NULL) {
     $additionalParticipantIds = array();
@@ -1059,7 +1043,6 @@ WHERE  civicrm_participant.id = {$participantId}
    *   Do fetch from line items.
    *
    * @return array
-   * @static
    */
   public function getFeeDetails($participantIds, $hasLineItems = FALSE) {
     $feeDetails = array();
@@ -1135,7 +1118,6 @@ INNER JOIN civicrm_price_field_value value ON ( value.id = lineItem.price_field_
    *
    * @return array
    *   $displayName => $viewUrl
-   * @static
    */
   public static function getAdditionalParticipants($primaryParticipantID) {
     $additionalParticipantIDs = array();
@@ -1167,7 +1149,6 @@ INNER JOIN civicrm_price_field_value value ON ( value.id = lineItem.price_field_
    * @param bool $updatePrimaryStatus
    *
    * @return bool|void
-   * @static
    */
   public static function updateParticipantStatus($participantID, $oldStatusID, $newStatusID = NULL, $updatePrimaryStatus = FALSE) {
     if (!$participantID || !$oldStatusID) {
@@ -1204,7 +1185,6 @@ INNER JOIN civicrm_price_field_value value ON ( value.id = lineItem.price_field_
    *
    * @return void
    *
-   * @static
    */
   public static function updateStatus($participantIds, $statusId, $updateRegisterDate = FALSE) {
     if (!is_array($participantIds) || empty($participantIds) || !$statusId) {
@@ -1240,13 +1220,10 @@ UPDATE  civicrm_participant
    *   Update status id.
    * @param int $fromStatusId
    *   From status id.
-   *
-   * return  void
    * @param bool $returnResult
    * @param bool $skipCascadeRule
    *
    * @return array
-   * @static
    */
   static function transitionParticipants(
     $participantIds, $toStatusId,
@@ -1482,10 +1459,7 @@ UPDATE  civicrm_participant
    * @param string $mailType
    *   (eg 'approval', 'confirm', 'expired' ).
    *
-   * return  void
-   *
    * @return bool
-   * @static
    */
   static function sendTransitionParticipantMail(
     $participantId,
@@ -1684,7 +1658,8 @@ UPDATE  civicrm_participant
    *
    * @param int $participantId
    *
-   * @return true if participant is primary
+   * @return bool
+   *   true if participant is primary
    */
   public static function isPrimaryParticipant($participantId) {
 
@@ -1707,7 +1682,8 @@ UPDATE  civicrm_participant
    * @param int $newStatusId
    *   New status.
    *
-   * @return true if allowed
+   * @return bool
+   *   true if allowed
    */
   public static function getValidAdditionalIds($participantId, $oldStatusId, $newStatusId) {
 
@@ -1735,7 +1711,6 @@ UPDATE  civicrm_participant
    *
    * @return int
    *   count of participant records
-   * @static
    */
   public static function getContactParticipantCount($contactID) {
     $query = "SELECT count(*)
@@ -1754,7 +1729,6 @@ WHERE    civicrm_participant.contact_id = {$contactID} AND
    *   Exclude cancelled additional participant.
    *
    * @return array
-   * @static
    */
   public static function getParticipantIds($contributionId, $excludeCancelled = FALSE) {
 
@@ -1786,8 +1760,7 @@ WHERE    civicrm_participant.contact_id = {$contactID} AND
    *   An array of additional participant ids.
    *
    * @return array
-   *   of Urls.
-   * @static
+   *   Array of Urls.
    */
   public static function getAdditionalParticipantUrl($participantIds) {
     foreach ($participantIds as $value) {
@@ -1815,7 +1788,6 @@ WHERE    civicrm_participant.contact_id = {$contactID} AND
    *
    * @param $feeLevel
    *
-   * @static
    */
   public static function createDiscountTrxn($eventID, $contributionParams, $feeLevel) {
     // CRM-11124
@@ -1854,7 +1826,6 @@ WHERE cpf.price_set_id = %1 AND cpfv.label LIKE %2";
    * @param int $contactId
    *   Contact id.
    *
-   * @static
    */
   public static function deleteContactParticipant($contactId) {
     $participant = new CRM_Event_DAO_Participant();
@@ -2189,9 +2160,9 @@ WHERE (li.entity_table = 'civicrm_participant' AND li.entity_id = {$participantI
    *
    * @param string $fieldName
    * @param string $context
-   *   : @see CRM_Core_DAO::buildOptionsContext.
+   *   @see CRM_Core_DAO::buildOptionsContext.
    * @param array $props
-   *   : whatever is known about this dao object.
+   *   whatever is known about this dao object.
    *
    * @return Array|bool
    */