/**
* 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
/**
* 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
/**
* 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
*
/**
* 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
/**
* Delete the event
*
- * @param int $id event id
+ * @param int $id
+ * Event id.
*
* @return mixed|null
* @static
* 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
*/
/**
* 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
* 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
/**
* 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
/**
* 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
* 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
/**
* 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
*
/**
* 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
*
* 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) {
/* 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
*/
/**
/* 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
*/
/**
* 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
/**
* 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
* 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.
*/
/**
* 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();
* 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
*/
* 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
* 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
*
/**
* 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
* 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
* 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
* 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
/**
* 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
/**
* 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
/**
* 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
/**
* 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
* 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
*
/**
* 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
*
* 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
* 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
/**
* 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
/**
* 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
* 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
* 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
*
/**
* 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
*/
/**
* 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
/**
* 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
/**
* 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
*
*
* CRM-12155
*
- * @param integer $contactId contact id
+ * @param int $contactId
+ * Contact id.
*
* @static
*/
* 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
*/
/**
* 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
* 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
* Create the labels (pdf)
* It assumes the participants are from the same event
*
- * @param array $participants
+ * @param array $participants
*
* @return null
*/
* 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.
*/
/**
* 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
/**
* 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
/**
* 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
*/
* 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 );
/**\r
* This function gets the number of participant count for the list of related event ids\r
*\r
- * @param array $listOfRelatedEntities list of related event ids\r
+ * @param array $listOfRelatedEntities
+ * List of related event ids .
*\r
* @static\r
*\r
/**\r
* This function checks if there was any registraion for related event ids,\r
* and returns array of ids with no regsitrations\r
- * @param type $eventID Event ID\r
+ * @param type $eventID
+ * Event ID .
* @return type\r
*/\r
public static function checkRegistrationForEvents($eventID) {\r
/**
* 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
*
/* Calculate the total participant count as per params.
*
- * @param array $params user params.
+ * @param array $params
+ * User params.
*
* @return $totalCount total participant count.
*/
/* 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.
/* 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.
/**
* 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
*
*
/**
* 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
/**
* 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
*
*
/*
* 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
* 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
*/
* 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
/**
* 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
/**
* 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
/**
* 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
/**
* 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
*/
/**
* 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
*/
/**
* 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
*/
/**
* 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
*/
*
* @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
/**
* 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
/**
* 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) {
/**
* 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
*/
* 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
*/
/**
* Name of export file.
*
- * @param string $output type of output
+ * @param string $output
+ * Type of output.
*
* @return string name of the file
*/
* 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
*
projects / civicrm-core.git / commitdiff