From d4dd1e854cd16b16a9924a603d059e44de748260 Mon Sep 17 00:00:00 2001 From: Tim Otten Date: Tue, 6 Jan 2015 11:41:08 -0800 Subject: [PATCH] INFRA-132 - CRM/Event - Convert single-line @param to multi-line --- CRM/Event/BAO/Event.php | 130 +++++++++++------ CRM/Event/BAO/Participant.php | 137 ++++++++++++------ CRM/Event/BAO/ParticipantPayment.php | 9 +- CRM/Event/Badge.php | 2 +- CRM/Event/Form/ManageEvent/EventInfo.php | 3 +- CRM/Event/Form/ManageEvent/Fee.php | 3 +- CRM/Event/Form/ManageEvent/Location.php | 3 +- CRM/Event/Form/ManageEvent/Registration.php | 15 +- CRM/Event/Form/ManageEvent/Repeat.php | 6 +- CRM/Event/Form/Participant.php | 3 +- CRM/Event/Form/Registration.php | 9 +- .../Registration/AdditionalParticipant.php | 6 +- CRM/Event/Form/Registration/Register.php | 35 +++-- CRM/Event/Form/Task.php | 3 +- CRM/Event/Form/Task/AddToGroup.php | 3 +- CRM/Event/Form/Task/PickProfile.php | 3 +- CRM/Event/Import/Form/MapField.php | 3 +- CRM/Event/Import/Parser/Participant.php | 15 +- CRM/Event/PseudoConstant.php | 3 +- CRM/Event/Selector/Search.php | 39 +++-- CRM/Event/StateMachine/Search.php | 3 +- 21 files changed, 286 insertions(+), 147 deletions(-) diff --git a/CRM/Event/BAO/Event.php b/CRM/Event/BAO/Event.php index 8d627dd6ff..513838596a 100644 --- a/CRM/Event/BAO/Event.php +++ b/CRM/Event/BAO/Event.php @@ -44,8 +44,10 @@ class CRM_Event_BAO_Event extends CRM_Event_DAO_Event { /** * Fetch object based on array of properties * - * @param array $params (reference ) an assoc array of name/value pairs - * @param array $defaults (reference ) an assoc array to hold the flattened values + * @param array $params + * (reference ) an assoc array of name/value pairs. + * @param array $defaults + * (reference ) an assoc array to hold the flattened values. * * @return CRM_Event_BAO_ManageEvent object * @static @@ -63,8 +65,10 @@ class CRM_Event_BAO_Event extends CRM_Event_DAO_Event { /** * Update the is_active flag in the db * - * @param int $id id of the database record - * @param boolean $is_active value we want to set the is_active field + * @param int $id + * Id of the database record. + * @param bool $is_active + * Value we want to set the is_active field. * * @return Object DAO object on sucess, null otherwise * @static @@ -76,7 +80,8 @@ class CRM_Event_BAO_Event extends CRM_Event_DAO_Event { /** * Add the event * - * @param array $params reference array contains the values submitted by the form + * @param array $params + * Reference array contains the values submitted by the form. * * @static * @@ -115,7 +120,8 @@ class CRM_Event_BAO_Event extends CRM_Event_DAO_Event { /** * Create the event * - * @param array $params reference array contains the values submitted by the form + * @param array $params + * Reference array contains the values submitted by the form. * * @return object * @static @@ -173,7 +179,8 @@ class CRM_Event_BAO_Event extends CRM_Event_DAO_Event { /** * Delete the event * - * @param int $id event id + * @param int $id + * Event id. * * @return mixed|null * @static @@ -223,8 +230,10 @@ class CRM_Event_BAO_Event extends CRM_Event_DAO_Event { * Delete the location block associated with an event, * if not being used by any other event. * - * @param $locBlockId location block id to be deleted - * @param int $eventId event with which loc block is associated + * @param $locBlockId + * Location block id to be deleted. + * @param int $eventId + * Event with which loc block is associated. * * @static */ @@ -245,12 +254,15 @@ class CRM_Event_BAO_Event extends CRM_Event_DAO_Event { /** * Get current/future Events * - * @param $all int 0 returns current and future events + * @param $all + * Int 0 returns current and future events. * 1 if events all are required * 2 returns events since 3 months ago - * @param bool|int $id int id of a specific event to return - * @param $isActive boolean true if you need only active events - * @param $checkPermission boolean true if you need to check permission else false + * @param bool|int $id int id of a specific event to return + * @param $isActive + * Boolean true if you need only active events. + * @param $checkPermission + * Boolean true if you need to check permission else false. * * @return array * @static @@ -572,10 +584,14 @@ $event_summary_limit * Get participant count * * @param int $eventId - * @param boolean $considerStatus consider status for participant count. - * @param boolean $status consider counted participant. - * @param boolean $considerRole consider role for participant count. - * @param boolean $role consider counted( is filter role) participant. + * @param boolean $considerStatus + * Consider status for participant count. + * @param boolean $status + * Consider counted participant. + * @param boolean $considerRole + * Consider role for participant count. + * @param boolean $role + * Consider counted( is filter role) participant. * * * @return array array with count of participants for each event based on status/role @@ -631,7 +647,8 @@ $event_summary_limit /** * Get the information to map a event * - * @param int $id for which we want map info + * @param int $id + * For which we want map info. * * @return null|string title of the event * @static @@ -694,11 +711,16 @@ WHERE civicrm_address.geo_code_1 IS NOT NULL /** * Get the complete information for one or more events * - * @param date $start get events with start date >= this date - * @param integer $type get events on the a specific event type (by event_type_id) - * @param integer $eventId return a single event - by event id - * @param date $end also get events with end date >= this date - * @param boolean $onlyPublic include public events only, default TRUE + * @param date $start + * Get events with start date >= this date. + * @param integer $type + * Get events on the a specific event type (by event_type_id). + * @param integer $eventId + * Return a single event - by event id. + * @param date $end + * Also get events with end date >= this date. + * @param boolean $onlyPublic + * Include public events only, default TRUE. * * @return array $all array of all the events that are searched * @static @@ -881,7 +903,8 @@ WHERE civicrm_event.is_active = 1 * This function is to make a copy of a Event, including * all the fields in the event Wizard * - * @param int $id the event id to copy + * @param int $id + * The event id to copy. * obj $newEvent object of CRM_Event_DAO_Event * boolean $afterCreate call to copy after the create function * @param null $newEvent @@ -1404,10 +1427,14 @@ WHERE civicrm_event.is_active = 1 /** * Build the array for display the profile fields * - * @param array $params key value. - * @param int $gid profile Id - * @param array $groupTitle Profile Group Title. - * @param array $values formatted array of key value + * @param array $params + * Key value. + * @param int $gid + * Profile Id. + * @param array $groupTitle + * Profile Group Title. + * @param array $values + * Formatted array of key value. * * @param array $profileFields * @@ -1667,11 +1694,16 @@ WHERE id = $cfID /** * Build the array for Additional participant's information array of priamry and additional Ids * - * @param int $participantId id of Primary participant - * @param array $values key/value event info - * @param int $contactId contact id of Primary participant - * @param boolean $isTest whether test or live transaction - * @param boolean $isIdsArray to return an array of Ids + * @param int $participantId + * Id of Primary participant. + * @param array $values + * Key/value event info. + * @param int $contactId + * Contact id of Primary participant. + * @param bool $isTest + * Whether test or live transaction. + * @param bool $isIdsArray + * To return an array of Ids. * * @param bool $skipCancel * @@ -1835,7 +1867,7 @@ WHERE ce.loc_block_id = $locBlockId"; * Check if event registration is valid according to permissions AND Dates * * @param array $values - * @param integer $eventID + * @param int $eventID * @return boolean */ public static function validRegistrationRequest($values, $eventID) { @@ -1874,7 +1906,8 @@ WHERE ce.loc_block_id = $locBlockId"; /* Function to Show - Hide the Registration Link. * - * @param array $values key/value event info + * @param array $values + * Key/value event info. * @return boolean true if allow registration otherwise false */ /** @@ -1910,7 +1943,8 @@ WHERE ce.loc_block_id = $locBlockId"; /* Function to check if given contact is already registered. * - * @param array $params key/value participant info + * @param array $params + * Key/value participant info. * @return boolean $alreadyRegistered true/false */ /** @@ -2006,7 +2040,8 @@ WHERE ce.loc_block_id = $locBlockId"; * Build From Email as the combination of all the email ids of the logged in user, * the domain email id and the email id configured for the event * - * @param int $eventId the id of the event + * @param int $eventId + * The id of the event. * * @return array an array of email ids * @static @@ -2038,8 +2073,10 @@ WHERE ce.loc_block_id = $locBlockId"; /** * Calculate event total seats occupied. * - * @param int $eventId event id. - * @param sting $extraWhereClause extra filter on participants. + * @param int $eventId + * Event id. + * @param sting $extraWhereClause + * Extra filter on participants. * * @return int event total seats w/ given criteria. * @static @@ -2084,7 +2121,8 @@ LEFT JOIN civicrm_price_field_value value ON ( value.id = lineItem.price_field * Retrieve event template default values to be set * as default values for current new event. * - * @param int $templateId event template id. + * @param int $templateId + * Event template id. * * @return array of custom data defaults. */ @@ -2123,8 +2161,10 @@ LEFT JOIN civicrm_price_field_value value ON ( value.id = lineItem.price_field /** * Update the Campaign Id of all the participants of the given event * - * @param int $eventID event id. - * @param int $eventCampaignID campaign id of that event + * @param int $eventID + * Event id. + * @param int $eventCampaignID + * Campaign id of that event. */ public static function updateParticipantCampaignID($eventID, $eventCampaignID) { $params = array(); @@ -2144,9 +2184,9 @@ LEFT JOIN civicrm_price_field_value value ON ( value.id = lineItem.price_field * Get options for a given field. * @see CRM_Core_DAO::buildOptions * - * @param String $fieldName - * @param String $context: @see CRM_Core_DAO::buildOptionsContext - * @param Array $props: whatever is known about this dao object + * @param string $fieldName + * @param string $context: @see CRM_Core_DAO::buildOptionsContext + * @param array $props: whatever is known about this dao object * * @return array|bool */ diff --git a/CRM/Event/BAO/Participant.php b/CRM/Event/BAO/Participant.php index 7f0c43d7d1..44af511657 100644 --- a/CRM/Event/BAO/Participant.php +++ b/CRM/Event/BAO/Participant.php @@ -81,7 +81,8 @@ class CRM_Event_BAO_Participant extends CRM_Event_DAO_Participant { * participant object. the params array could contain additional unused name/value * pairs * - * @param array $params (reference ) an assoc array of name/value pairs + * @param array $params + * (reference ) an assoc array of name/value pairs. * * @return CRM_Event_BAO_Participant object * @static @@ -157,8 +158,10 @@ class CRM_Event_BAO_Participant extends CRM_Event_DAO_Participant { * Given the list of params in the params array, fetch the object * and store the values in the values array * - * @param array $params input parameters to find object - * @param array $values output values of the object + * @param array $params + * Input parameters to find object. + * @param array $values + * Output values of the object. * * @param $ids * @@ -184,7 +187,8 @@ class CRM_Event_BAO_Participant extends CRM_Event_DAO_Participant { /** * Takes an associative array and creates a participant object * - * @param array $params (reference ) an assoc array of name/value pairs + * @param array $params + * (reference ) an assoc array of name/value pairs. * * @return CRM_Event_BAO_Participant object * @static @@ -335,9 +339,12 @@ class CRM_Event_BAO_Participant extends CRM_Event_DAO_Participant { * Check whether the event is full for participation and return as * per requirements. * - * @param int $eventId event id. - * @param boolean $returnEmptySeats are we require number if empty seats. - * @param boolean $includeWaitingList consider waiting list in event full + * @param int $eventId + * Event id. + * @param bool $returnEmptySeats + * Are we require number if empty seats. + * @param bool $includeWaitingList + * Consider waiting list in event full. * calculation or not. (it is for cron job purpose) * * @param bool $returnWaitingCount @@ -478,8 +485,10 @@ SELECT event.event_full_text, * Return the array of all price set field options, * with total participant count that field going to carry. * - * @param int $eventId event id. - * @param array $skipParticipantIds an array of participant ids those we should skip. + * @param int $eventId + * Event id. + * @param array $skipParticipantIds + * An array of participant ids those we should skip. * @param bool $considerCounted * @param bool $considerWaiting * @param bool $considerTestParticipants @@ -559,7 +568,8 @@ INNER JOIN civicrm_price_field field ON ( value.price_field_id = field.id * Get the empty spaces for event those we can allocate * to pending participant to become confirm. * - * @param int $eventId event id. + * @param int $eventId + * Event id. * * @return int $spaces Number of Empty Seats/null. * @static @@ -770,7 +780,8 @@ GROUP BY participant.event_id /** * Get the event name/sort name for a particular participation / participant * - * @param int $participantId id of the participant + * @param int $participantId + * Id of the participant. * * @return array $name associated array with sort_name and event title @@ -799,8 +810,10 @@ WHERE civicrm_participant.id = {$participantId} /** * Get the values for pseudoconstants for name->value and reverse. * - * @param array $defaults (reference) the default values, some of which need to be resolved. - * @param boolean $reverse true if we want to resolve the values in the reverse direction (value -> name) + * @param array $defaults + * (reference) the default values, some of which need to be resolved. + * @param bool $reverse + * True if we want to resolve the values in the reverse direction (value -> name). * * @return void * @static @@ -843,7 +856,8 @@ WHERE civicrm_participant.id = {$participantId} /** * Delete the record that are associated with this participation * - * @param int $id id of the participation to delete + * @param int $id + * Id of the participation to delete. * * @return void * @static @@ -903,8 +917,10 @@ WHERE civicrm_participant.id = {$participantId} /** * Checks duplicate participants * - * @param array $duplicates (reference ) an assoc array of name/value pairs - * @param array $input an assosiative array of name /value pairs + * @param array $duplicates + * (reference ) an assoc array of name/value pairs. + * @param array $input + * An assosiative array of name /value pairs. * from other function * * @return CRM_Contribute_BAO_Contribution object @@ -950,7 +966,8 @@ WHERE civicrm_participant.id = {$participantId} * separated string. We need to change that string to comma * separated string before using fee_level in view mode. * - * @param string $eventLevel event_leval string from db + * @param string $eventLevel + * Event_leval string from db. * * @static * @@ -981,8 +998,10 @@ WHERE civicrm_participant.id = {$participantId} /** * Get the additional participant ids. * - * @param int $primaryParticipantId primary partycipant Id - * @param boolean $excludeCancel do not include participant those are cancelled. + * @param int $primaryParticipantId + * Primary partycipant Id. + * @param bool $excludeCancel + * Do not include participant those are cancelled. * * @param int $oldStatusId * @@ -1023,8 +1042,10 @@ WHERE civicrm_participant.id = {$participantId} * Get the event fee info for given participant ids * either from line item table / participant table. * - * @param array $participantIds participant ids. - * @param boolean $hasLineItems do fetch from line items. + * @param array $participantIds + * Participant ids. + * @param bool $hasLineItems + * Do fetch from line items. * * @return array $feeDetails * @static @@ -1088,7 +1109,8 @@ INNER JOIN civicrm_price_field_value value ON ( value.id = lineItem.price_field_ * Retrieve additional participants display-names and URL to view their participant records. * (excludes cancelled participants automatically) * - * @param int $primaryParticipantID id of primary participant record + * @param int $primaryParticipantID + * Id of primary participant record. * * @return array $additionalParticipants $displayName => $viewUrl * @static @@ -1116,7 +1138,8 @@ INNER JOIN civicrm_price_field_value value ON ( value.id = lineItem.price_field_ /** * Function for update primary and additional participant status * - * @param int $participantID primary participant's id + * @param int $participantID + * Primary participant's id. * @param int $oldStatusID * @param int $newStatusID * @param bool $updatePrimaryStatus @@ -1151,8 +1174,10 @@ INNER JOIN civicrm_price_field_value value ON ( value.id = lineItem.price_field_ /** * Function for update status for given participant ids * - * @param int $participantIds array of participant ids - * @param int $statusId status id for participant + * @param int $participantIds + * Array of participant ids. + * @param int $statusId + * Status id for participant. * @param bool $updateRegisterDate * * @return void @@ -1187,9 +1212,12 @@ UPDATE civicrm_participant * update status from $fromStatusId to $toStatusId * and send mail + create activities. * - * @param array $participantIds participant ids. - * @param int $toStatusId update status id. - * @param int $fromStatusId from status id + * @param array $participantIds + * Participant ids. + * @param int $toStatusId + * Update status id. + * @param int $fromStatusId + * From status id. * * return void * @param bool $returnResult @@ -1417,12 +1445,18 @@ UPDATE civicrm_participant * Send mail and create activity * when participant status changed. * - * @param int $participantId participant id. - * @param array $participantValues participant detail values. status id for participants - * @param array $eventDetails required event details - * @param array $contactDetails required contact details - * @param array $domainValues required domain values. - * @param string $mailType (eg 'approval', 'confirm', 'expired' ) + * @param int $participantId + * Participant id. + * @param array $participantValues + * Participant detail values. status id for participants. + * @param array $eventDetails + * Required event details. + * @param array $contactDetails + * Required contact details. + * @param array $domainValues + * Required domain values. + * @param string $mailType + * (eg 'approval', 'confirm', 'expired' ). * * return void * @@ -1641,9 +1675,12 @@ UPDATE civicrm_participant /** * Get additional participant Ids for cascading with primary participant status * - * @param int $participantId participant id. - * @param int $oldStatusId previous status - * @param int $newStatusId new status + * @param int $participantId + * Participant id. + * @param int $oldStatusId + * Previous status. + * @param int $newStatusId + * New status. * * @return true if allowed */ @@ -1685,8 +1722,10 @@ WHERE civicrm_participant.contact_id = {$contactID} AND /** * Get participant ids by contribution id * - * @param int $contributionId Contribution Id - * @param bool $excludeCancelled Exclude cancelled additional participant + * @param int $contributionId + * Contribution Id. + * @param bool $excludeCancelled + * Exclude cancelled additional participant. * * @return array $participantsId * @static @@ -1716,7 +1755,8 @@ WHERE civicrm_participant.contact_id = {$contactID} AND /** * Get additional Participant edit & view url . * - * @param array $participantIds an array of additional participant ids. + * @param array $participantIds + * An array of additional participant ids. * * @return array of Urls. * @static @@ -1740,8 +1780,10 @@ WHERE civicrm_participant.contact_id = {$contactID} AND /** * To create trxn entry if an event has discount. * - * @param int $eventID event id - * @param array $contributionParams contribution params. + * @param int $eventID + * Event id. + * @param array $contributionParams + * Contribution params. * * @param $feeLevel * @@ -1779,7 +1821,8 @@ WHERE cpf.price_set_id = %1 AND cpfv.label LIKE %2"; * * CRM-12155 * - * @param integer $contactId contact id + * @param int $contactId + * Contact id. * * @static */ @@ -2113,9 +2156,11 @@ WHERE (li.entity_table = 'civicrm_participant' AND li.entity_id = {$participantI * Get options for a given field. * @see CRM_Core_DAO::buildOptions * - * @param String $fieldName - * @param String $context : @see CRM_Core_DAO::buildOptionsContext - * @param Array $props : whatever is known about this dao object + * @param string $fieldName + * @param string $context + * : @see CRM_Core_DAO::buildOptionsContext. + * @param array $props + * : whatever is known about this dao object. * * @return Array|bool */ diff --git a/CRM/Event/BAO/ParticipantPayment.php b/CRM/Event/BAO/ParticipantPayment.php index 0f6dae79c7..e92ce28871 100644 --- a/CRM/Event/BAO/ParticipantPayment.php +++ b/CRM/Event/BAO/ParticipantPayment.php @@ -38,8 +38,10 @@ class CRM_Event_BAO_ParticipantPayment extends CRM_Event_DAO_ParticipantPayment /** * Creates or updates a participant payment record * - * @param $params array of values to initialize the record with - * @param $ids array with one values of id for this participantPayment record (for update) + * @param $params + * Array of values to initialize the record with. + * @param $ids + * Array with one values of id for this participantPayment record (for update). * * @return object the partcipant payment record * @static @@ -86,7 +88,8 @@ class CRM_Event_BAO_ParticipantPayment extends CRM_Event_DAO_ParticipantPayment * Delete the record that are associated with this ParticipantPayment * Also deletes the associated contribution for this participant * - * @param array $params associative array whose values match the record to be deleted + * @param array $params + * Associative array whose values match the record to be deleted. * * @return boolean true if deleted false otherwise * @static diff --git a/CRM/Event/Badge.php b/CRM/Event/Badge.php index 758b0e2a68..b0e6911686 100644 --- a/CRM/Event/Badge.php +++ b/CRM/Event/Badge.php @@ -73,7 +73,7 @@ class CRM_Event_Badge { * Create the labels (pdf) * It assumes the participants are from the same event * - * @param array $participants + * @param array $participants * * @return null */ diff --git a/CRM/Event/Form/ManageEvent/EventInfo.php b/CRM/Event/Form/ManageEvent/EventInfo.php index 419744cea4..729945437e 100644 --- a/CRM/Event/Form/ManageEvent/EventInfo.php +++ b/CRM/Event/Form/ManageEvent/EventInfo.php @@ -346,7 +346,8 @@ class CRM_Event_Form_ManageEvent_EventInfo extends CRM_Event_Form_ManageEvent { * Retrieve event template custom data values * and set as default values for current new event. * - * @param int $templateId event template id. + * @param int $templateId + * Event template id. * * @return array of custom data defaults. */ diff --git a/CRM/Event/Form/ManageEvent/Fee.php b/CRM/Event/Form/ManageEvent/Fee.php index ae17d5a1f6..76797422dc 100644 --- a/CRM/Event/Form/ManageEvent/Fee.php +++ b/CRM/Event/Form/ManageEvent/Fee.php @@ -404,7 +404,8 @@ class CRM_Event_Form_ManageEvent_Fee extends CRM_Event_Form_ManageEvent { /** * Global validation rules for the form * - * @param array $values posted values of the form + * @param array $values + * Posted values of the form. * * @return array list of errors to be posted back to the form * @static diff --git a/CRM/Event/Form/ManageEvent/Location.php b/CRM/Event/Form/ManageEvent/Location.php index 15d003ee95..bf06870257 100644 --- a/CRM/Event/Form/ManageEvent/Location.php +++ b/CRM/Event/Form/ManageEvent/Location.php @@ -138,7 +138,8 @@ class CRM_Event_Form_ManageEvent_Location extends CRM_Event_Form_ManageEvent { /** * Global validation rules for the form * - * @param array $fields posted values of the form + * @param array $fields + * Posted values of the form. * * @return array list of errors to be posted back to the form * @static diff --git a/CRM/Event/Form/ManageEvent/Registration.php b/CRM/Event/Form/ManageEvent/Registration.php index 0949e7bd50..765e813c82 100644 --- a/CRM/Event/Form/ManageEvent/Registration.php +++ b/CRM/Event/Form/ManageEvent/Registration.php @@ -204,7 +204,8 @@ class CRM_Event_Form_ManageEvent_Registration extends CRM_Event_Form_ManageEvent /** * Fix what blocks to show/hide based on the default values set * - * @param array $defaults the array of default values + * @param array $defaults + * The array of default values. * * @return void */ @@ -346,10 +347,14 @@ class CRM_Event_Form_ManageEvent_Registration extends CRM_Event_Form_ManageEvent * depends on getProfileSelectorTypes * * @param array &$form - * @param int $count unique index - * @param string $prefix dom element ID prefix - * @param string $label Label - * @param array $configs Optional, for addProfileSelector(), defaults to using getProfileSelectorTypes() + * @param int $count + * Unique index. + * @param string $prefix + * Dom element ID prefix. + * @param string $label + * Label. + * @param array $configs + * Optional, for addProfileSelector(), defaults to using getProfileSelectorTypes(). **/ public function buildMultipleProfileBottom(&$form, $count, $prefix = '', $label = 'Include Profile', $configs = null) { extract( ( is_null($configs) ) ? self::getProfileSelectorTypes() : $configs ); diff --git a/CRM/Event/Form/ManageEvent/Repeat.php b/CRM/Event/Form/ManageEvent/Repeat.php index af66498d79..d943e4b896 100644 --- a/CRM/Event/Form/ManageEvent/Repeat.php +++ b/CRM/Event/Form/ManageEvent/Repeat.php @@ -162,7 +162,8 @@ class CRM_Event_Form_ManageEvent_Repeat extends CRM_Event_Form_ManageEvent { /** * This function gets the number of participant count for the list of related event ids * - * @param array $listOfRelatedEntities list of related event ids + * @param array $listOfRelatedEntities + * List of related event ids . * * @static * @@ -194,7 +195,8 @@ class CRM_Event_Form_ManageEvent_Repeat extends CRM_Event_Form_ManageEvent { /** * This function checks if there was any registraion for related event ids, * and returns array of ids with no regsitrations - * @param type $eventID Event ID + * @param type $eventID + * Event ID . * @return type */ public static function checkRegistrationForEvents($eventID) { diff --git a/CRM/Event/Form/Participant.php b/CRM/Event/Form/Participant.php index 7eadc6553c..3cc7039ee8 100644 --- a/CRM/Event/Form/Participant.php +++ b/CRM/Event/Form/Participant.php @@ -786,7 +786,8 @@ class CRM_Event_Form_Participant extends CRM_Contribute_Form_AbstractEditPayment /** * Global validation rules for the form * - * @param array $values posted values of the form + * @param array $values + * Posted values of the form. * @param $files * @param $self * diff --git a/CRM/Event/Form/Registration.php b/CRM/Event/Form/Registration.php index 5dc08cd6c9..3ccadb3ca3 100644 --- a/CRM/Event/Form/Registration.php +++ b/CRM/Event/Form/Registration.php @@ -924,7 +924,8 @@ WHERE v.option_group_id = g.id /* Calculate the total participant count as per params. * - * @param array $params user params. + * @param array $params + * User params. * * @return $totalCount total participant count. */ @@ -1021,7 +1022,8 @@ WHERE v.option_group_id = g.id /* Format user submitted price set params. * Convert price set each param as an array. * - * @param $params an array of user submitted params. + * @param $params + * An array of user submitted params. * * * @return array $formatted, formatted price set params. @@ -1070,7 +1072,8 @@ WHERE v.option_group_id = g.id /* Calculate total count for each price set options. * those are currently selected by user. * - * @param $form form object. + * @param $form + * Form object. * * * @return array $optionsCount, array of each option w/ count total. diff --git a/CRM/Event/Form/Registration/AdditionalParticipant.php b/CRM/Event/Form/Registration/AdditionalParticipant.php index 783728674e..b085e00e3c 100644 --- a/CRM/Event/Form/Registration/AdditionalParticipant.php +++ b/CRM/Event/Form/Registration/AdditionalParticipant.php @@ -363,8 +363,10 @@ class CRM_Event_Form_Registration_AdditionalParticipant extends CRM_Event_Form_R /** * Global form rule * - * @param array $fields the input form values - * @param array $files the uploaded files if any + * @param array $fields + * The input form values. + * @param array $files + * The uploaded files if any. * @param $self * * diff --git a/CRM/Event/Form/Registration/Register.php b/CRM/Event/Form/Registration/Register.php index 68df77abfe..4cc735bdbb 100644 --- a/CRM/Event/Form/Registration/Register.php +++ b/CRM/Event/Form/Registration/Register.php @@ -542,9 +542,12 @@ class CRM_Event_Form_Registration_Register extends CRM_Event_Form_Registration { /** * Build the radio/text form elements for the amount field * - * @param CRM_Core_Form $form form object - * @param boolean $required true if you want to add formRule - * @param int $discountId discount id for the event + * @param CRM_Core_Form $form + * Form object. + * @param bool $required + * True if you want to add formRule. + * @param int $discountId + * Discount id for the event. * * @return void * @static @@ -791,8 +794,10 @@ class CRM_Event_Form_Registration_Register extends CRM_Event_Form_Registration { /** * Global form rule * - * @param array $fields the input form values - * @param array $files the uploaded files if any + * @param array $fields + * The input form values. + * @param array $files + * The uploaded files if any. * @param $self * * @@ -1198,8 +1203,9 @@ class CRM_Event_Form_Registration_Register extends CRM_Event_Form_Registration { /* * process Registration of free event * - * @param array $param Form valuess - * @param int contactID + * @param array $param + * Form valuess. + * @param int contactID * * @return void * access public @@ -1384,11 +1390,16 @@ class CRM_Event_Form_Registration_Register extends CRM_Event_Form_Registration { * Method to check if the user is already registered for the event * and if result found redirect to the event info page * - * @param array $fields the input form values(anonymous user) - * @param array $self event data - * @param boolean $isAdditional treat isAdditional participants a bit differently - * @param boolean $returnContactId just find and return the contactID match to use - * @param boolean $useDedupeRules force usage of dedupe rules + * @param array $fields + * The input form values(anonymous user). + * @param array $self + * Event data. + * @param bool $isAdditional + * Treat isAdditional participants a bit differently. + * @param bool $returnContactId + * Just find and return the contactID match to use. + * @param bool $useDedupeRules + * Force usage of dedupe rules. * * @return void */ diff --git a/CRM/Event/Form/Task.php b/CRM/Event/Form/Task.php index 2db1f3be3d..95eee70f72 100644 --- a/CRM/Event/Form/Task.php +++ b/CRM/Event/Form/Task.php @@ -158,7 +158,8 @@ class CRM_Event_Form_Task extends CRM_Core_Form { * Simple shell that derived classes can call to add buttons to * the form with a customized title for the main Submit * - * @param string $title title of the main button + * @param string $title + * Title of the main button. * @param string $nextType * @param string $backType * @param bool $submitOnce diff --git a/CRM/Event/Form/Task/AddToGroup.php b/CRM/Event/Form/Task/AddToGroup.php index c2f4d17ef9..82c48c3875 100644 --- a/CRM/Event/Form/Task/AddToGroup.php +++ b/CRM/Event/Form/Task/AddToGroup.php @@ -177,7 +177,8 @@ class CRM_Event_Form_Task_AddToGroup extends CRM_Event_Form_Task { /** * Global validation rules for the form * - * @param array $fields posted values of the form + * @param array $fields + * Posted values of the form. * * @return array list of errors to be posted back to the form * @static diff --git a/CRM/Event/Form/Task/PickProfile.php b/CRM/Event/Form/Task/PickProfile.php index 92e542c160..8cf6ee03f6 100644 --- a/CRM/Event/Form/Task/PickProfile.php +++ b/CRM/Event/Form/Task/PickProfile.php @@ -119,7 +119,8 @@ class CRM_Event_Form_Task_PickProfile extends CRM_Event_Form_Task { /** * Global validation rules for the form * - * @param array $fields posted values of the form + * @param array $fields + * Posted values of the form. * * @return array list of errors to be posted back to the form * @static diff --git a/CRM/Event/Import/Form/MapField.php b/CRM/Event/Import/Form/MapField.php index 1f7f1520f8..1a6150b608 100644 --- a/CRM/Event/Import/Form/MapField.php +++ b/CRM/Event/Import/Form/MapField.php @@ -280,7 +280,8 @@ class CRM_Event_Import_Form_MapField extends CRM_Import_Form_MapField { /** * Global validation rules for the form * - * @param array $fields posted values of the form + * @param array $fields + * Posted values of the form. * * @param $files * @param $self diff --git a/CRM/Event/Import/Parser/Participant.php b/CRM/Event/Import/Parser/Participant.php index 89f9020250..f0b8a96840 100644 --- a/CRM/Event/Import/Parser/Participant.php +++ b/CRM/Event/Import/Parser/Participant.php @@ -125,7 +125,8 @@ class CRM_Event_Import_Parser_Participant extends CRM_Event_Import_Parser { /** * Handle the values in mapField mode * - * @param array $values the array of values belonging to this line + * @param array $values + * The array of values belonging to this line. * * @return boolean */ @@ -136,7 +137,8 @@ class CRM_Event_Import_Parser_Participant extends CRM_Event_Import_Parser { /** * Handle the values in preview mode * - * @param array $values the array of values belonging to this line + * @param array $values + * The array of values belonging to this line. * * @return boolean the result of this processing */ @@ -147,7 +149,8 @@ class CRM_Event_Import_Parser_Participant extends CRM_Event_Import_Parser { /** * Handle the values in summary mode * - * @param array $values the array of values belonging to this line + * @param array $values + * The array of values belonging to this line. * * @return boolean the result of this processing */ @@ -262,8 +265,10 @@ class CRM_Event_Import_Parser_Participant extends CRM_Event_Import_Parser { /** * Handle the values in import mode * - * @param int $onDuplicate the code for what action to take on duplicates - * @param array $values the array of values belonging to this line + * @param int $onDuplicate + * The code for what action to take on duplicates. + * @param array $values + * The array of values belonging to this line. * * @return boolean the result of this processing */ diff --git a/CRM/Event/PseudoConstant.php b/CRM/Event/PseudoConstant.php index 1b3250d066..90b79fcbcc 100644 --- a/CRM/Event/PseudoConstant.php +++ b/CRM/Event/PseudoConstant.php @@ -134,7 +134,8 @@ class CRM_Event_PseudoConstant extends CRM_Core_PseudoConstant { * * @param int $id * @param null $cond - * @param string $retColumn tells populate() whether to return 'name' (default) or 'label' values + * @param string $retColumn + * Tells populate() whether to return 'name' (default) or 'label' values. * * @return array - array reference of all participant statuses if any * @static diff --git a/CRM/Event/Selector/Search.php b/CRM/Event/Selector/Search.php index 678fd32486..9adad8e768 100644 --- a/CRM/Event/Selector/Search.php +++ b/CRM/Event/Selector/Search.php @@ -145,11 +145,15 @@ class CRM_Event_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co /** * Class constructor * - * @param array $queryParams array of parameters for query + * @param array $queryParams + * Array of parameters for query. * @param \const|int $action - action of search basic or advanced. - * @param string $eventClause if the caller wants to further restrict the search (used in participations) - * @param boolean $single are we dealing only with one contact? - * @param int $limit how many participations do we want returned + * @param string $eventClause + * If the caller wants to further restrict the search (used in participations). + * @param bool $single + * Are we dealing only with one contact?. + * @param int $limit + * How many participations do we want returned. * * @param string $context * @param null $compContext @@ -192,7 +196,8 @@ class CRM_Event_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co /** * Can be used to alter the number of participation returned from a buildForm hook * - * @param int $limit how many participations do we want returned + * @param int $limit + * How many participations do we want returned. * */ public function setLimit($limit) { @@ -291,11 +296,16 @@ class CRM_Event_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co /** * Returns all the rows in the given offset and rowCount * - * @param enum $action the action being performed - * @param int $offset the row number to start from - * @param int $rowCount the number of rows to return - * @param string $sort the sql string that describes the sort order - * @param enum $output what should the result set include (web/email/csv) + * @param enum $action + * The action being performed. + * @param int $offset + * The row number to start from. + * @param int $rowCount + * The number of rows to return. + * @param string $sort + * The sql string that describes the sort order. + * @param enum $output + * What should the result set include (web/email/csv). * * @return array rows in the given offset and rowCount */ @@ -433,8 +443,10 @@ class CRM_Event_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co * Returns the column headers as an array of tuples: * (name, sortName (key to the sort array)) * - * @param string $action the action being performed - * @param enum $output what should the result set include (web/email/csv) + * @param string $action + * The action being performed. + * @param enum $output + * What should the result set include (web/email/csv). * * @return array the column headers that need to be displayed */ @@ -510,7 +522,8 @@ class CRM_Event_Selector_Search extends CRM_Core_Selector_Base implements CRM_Co /** * Name of export file. * - * @param string $output type of output + * @param string $output + * Type of output. * * @return string name of the file */ diff --git a/CRM/Event/StateMachine/Search.php b/CRM/Event/StateMachine/Search.php index 48c47639a7..8dc470c689 100644 --- a/CRM/Event/StateMachine/Search.php +++ b/CRM/Event/StateMachine/Search.php @@ -74,7 +74,8 @@ class CRM_Event_StateMachine_Search extends CRM_Core_StateMachine { * to avoid using conditional state machine, much more efficient * and simpler * - * @param CRM_Core_Controller $controller the controller object + * @param CRM_Core_Controller $controller + * The controller object. * * @param string $formName * -- 2.25.1