Commit 66f9e52b authored by Eileen McNaughton's avatar Eileen McNaughton

INFRA-132 add full stops

parent f9e31d7f
......@@ -23,7 +23,7 @@
| GNU Affero General Public License or the licensing of CiviCRM, |
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
+--------------------------------------------------------------------+
*/
*/
/**
*
......
......@@ -85,7 +85,7 @@
class CRM_Core_Transaction {
/**
* These constants represent phases at which callbacks can be invoked
* These constants represent phases at which callbacks can be invoked.
*/
const PHASE_PRE_COMMIT = 1;
const PHASE_POST_COMMIT = 2;
......@@ -99,7 +99,7 @@ class CRM_Core_Transaction {
private $_pseudoCommitted = FALSE;
/**
* Ensure that an SQL transaction is started
* Ensure that an SQL transaction is started.
*
* This is a thin wrapper around __construct() which allows more fluent coding.
*
......@@ -114,7 +114,7 @@ class CRM_Core_Transaction {
}
/**
* Ensure that an SQL transaction is started
* Ensure that an SQL transaction is started.
*
* @param bool $nest
* Determines what to do if there's currently an active transaction:.
......@@ -130,7 +130,7 @@ class CRM_Core_Transaction {
}
/**
* Immediately commit or rollback
* Immediately commit or rollback.
*
* (Note: Prior to 4.6, return void)
*
......@@ -218,7 +218,7 @@ class CRM_Core_Transaction {
}
/**
* Determine whether there is a pending transaction
* Determine whether there is a pending transaction.
*/
static public function isActive() {
$frame = \Civi\Core\Transaction\Manager::singleton()->getFrame();
......@@ -226,7 +226,7 @@ class CRM_Core_Transaction {
}
/**
* Add a transaction callback
* Add a transaction callback.
*
* Note: It's conceivable to add callbacks to the main/overall transaction
* (aka $manager->getBaseFrame()) or to the innermost nested transaction
......
......@@ -35,14 +35,14 @@
class CRM_Event_BAO_Event extends CRM_Event_DAO_Event {
/**
* Class constructor
* Class constructor.
*/
public function __construct() {
parent::__construct();
}
/**
* Fetch object based on array of properties
* Fetch object based on array of properties.
*
* @param array $params
* (reference ) an assoc array of name/value pairs.
......@@ -77,7 +77,7 @@ class CRM_Event_BAO_Event extends CRM_Event_DAO_Event {
}
/**
* Add the event
* Add the event.
*
* @param array $params
* Reference array contains the values submitted by the form.
......@@ -116,7 +116,7 @@ class CRM_Event_BAO_Event extends CRM_Event_DAO_Event {
}
/**
* Create the event
* Create the event.
*
* @param array $params
* Reference array contains the values submitted by the form.
......@@ -173,7 +173,7 @@ class CRM_Event_BAO_Event extends CRM_Event_DAO_Event {
}
/**
* Delete the event
* Delete the event.
*
* @param int $id
* Event id.
......@@ -311,7 +311,7 @@ WHERE ( civicrm_event.is_template IS NULL OR civicrm_event.is_template = 0 )";
}
/**
* Get events Summary
* Get events Summary.
*
*
* @return array
......@@ -576,7 +576,7 @@ $event_summary_limit
}
/**
* Get participant count
* Get participant count.
*
* @param int $eventId
* @param bool $considerStatus consider status for participant count.
......@@ -642,7 +642,7 @@ $event_summary_limit
}
/**
* Get the information to map a event
* Get the information to map a event.
*
* @param int $id
* For which we want map info.
......@@ -709,7 +709,7 @@ WHERE civicrm_address.geo_code_1 IS NOT NULL
}
/**
* Get the complete information for one or more events
* Get the complete information for one or more events.
*
* @param date $start
* Get events with start date >= this date.
......@@ -1431,7 +1431,7 @@ WHERE civicrm_event.is_active = 1
}
/**
* Build the array for display the profile fields
* Build the array for display the profile fields.
*
* @param array $params
* Key value.
......@@ -1881,7 +1881,7 @@ WHERE ce.loc_block_id = $locBlockId";
}
/**
* Check if event registration is valid according to permissions AND Dates
* Check if event registration is valid according to permissions AND Dates.
*
* @param array $values
* @param int $eventID
......@@ -1992,7 +1992,7 @@ WHERE ce.loc_block_id = $locBlockId";
}
/**
* Make sure that the user has permission to access this event
* Make sure that the user has permission to access this event.
*
* @param int $eventId
* @param int $type
......@@ -2137,7 +2137,7 @@ LEFT JOIN civicrm_price_field_value value ON ( value.id = lineItem.price_field
}
/**
* Retrieve event template default values to be set
* Retrieve event template default values to be set.
* as default values for current new event.
*
* @param int $templateId
......@@ -2179,7 +2179,7 @@ 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
* Update the Campaign Id of all the participants of the given event.
*
* @param int $eventID
* Event id.
......
......@@ -37,21 +37,21 @@
class CRM_Event_BAO_Participant extends CRM_Event_DAO_Participant {
/**
* Static field for all the participant information that we can potentially import
* Static field for all the participant information that we can potentially import.
*
* @var array
*/
static $_importableFields = NULL;
/**
* Static field for all the participant information that we can potentially export
* Static field for all the participant information that we can potentially export.
*
* @var array
*/
static $_exportableFields = NULL;
/**
* Static array for valid status transitions rules
* Static array for valid status transitions rules.
*
* @var array
*/
......@@ -71,7 +71,7 @@ class CRM_Event_BAO_Participant extends CRM_Event_DAO_Participant {
}
/**
* Takes an associative array and creates a participant object
* Takes an associative array and creates a participant object.
*
* the function extract all the params it needs to initialize the create a
* participant object. the params array could contain additional unused name/value
......@@ -183,7 +183,7 @@ class CRM_Event_BAO_Participant extends CRM_Event_DAO_Participant {
}
/**
* Takes an associative array and creates a participant object
* Takes an associative array and creates a participant object.
*
* @param array $params
* (reference ) an assoc array of name/value pairs.
......@@ -335,7 +335,7 @@ class CRM_Event_BAO_Participant extends CRM_Event_DAO_Participant {
}
/**
* Check whether the event is full for participation and return as
* Check whether the event is full for participation and return as.
* per requirements.
*
* @param int $eventId
......@@ -614,7 +614,7 @@ GROUP BY participant.event_id
}
/**
* Combine all the importable fields from the lower levels object
* Combine all the importable fields from the lower levels object.
*
* @param string $contactType
* @param bool $status
......@@ -728,7 +728,7 @@ GROUP BY participant.event_id
}
/**
* Combine all the exportable fields from the lower levels object
* Combine all the exportable fields from the lower levels object.
*
* @return array
* array of exportable Fields
......@@ -854,7 +854,7 @@ WHERE civicrm_participant.id = {$participantId}
}
/**
* Delete the record that are associated with this participation
* Delete the record that are associated with this participation.
*
* @param int $id
* Id of the participation to delete.
......@@ -914,7 +914,7 @@ WHERE civicrm_participant.id = {$participantId}
}
/**
* Checks duplicate participants
* Checks duplicate participants.
*
* @param array $input
* An assosiative array of name /value pairs.
......@@ -958,7 +958,7 @@ WHERE civicrm_participant.id = {$participantId}
}
/**
* Fix the event level
* Fix the event level.
*
* When price sets are used as event fee, fee_level is set as ^A
* separated string. We need to change that string to comma
......@@ -1141,7 +1141,7 @@ INNER JOIN civicrm_price_field_value value ON ( value.id = lineItem.price_field_
}
/**
* Function for update primary and additional participant status
* Function for update primary and additional participant status.
*
* @param int $participantID
* Primary participant's id.
......@@ -1176,7 +1176,7 @@ INNER JOIN civicrm_price_field_value value ON ( value.id = lineItem.price_field_
}
/**
* Function for update status for given participant ids
* Function for update status for given participant ids.
*
* @param int $participantIds
* Array of participant ids.
......@@ -1655,7 +1655,7 @@ UPDATE civicrm_participant
}
/**
* Check for whether participant is primary or not
* Check for whether participant is primary or not.
*
* @param int $participantId
*
......@@ -1674,7 +1674,7 @@ UPDATE civicrm_participant
}
/**
* Get additional participant Ids for cascading with primary participant status
* Get additional participant Ids for cascading with primary participant status.
*
* @param int $participantId
* Participant id.
......@@ -1706,7 +1706,7 @@ UPDATE civicrm_participant
}
/**
* Get participant record count for a Contact
* Get participant record count for a Contact.
*
* @param int $contactID
*
......@@ -1722,7 +1722,7 @@ WHERE civicrm_participant.contact_id = {$contactID} AND
}
/**
* Get participant ids by contribution id
* Get participant ids by contribution id.
*
* @param int $contributionId
* Contribution Id.
......@@ -1822,7 +1822,7 @@ WHERE cpf.price_set_id = %1 AND cpfv.label LIKE %2";
}
/**
* Delete participants of contact
* Delete participants of contact.
*
* CRM-12155
*
......
......@@ -36,7 +36,7 @@
class CRM_Event_BAO_ParticipantPayment extends CRM_Event_DAO_ParticipantPayment {
/**
* Creates or updates a participant payment record
* Creates or updates a participant payment record.
*
* @param array $params
* of values to initialize the record with.
......@@ -93,7 +93,7 @@ class CRM_Event_BAO_ParticipantPayment extends CRM_Event_DAO_ParticipantPayment
}
/**
* Delete the record that are associated with this ParticipantPayment
* Delete the record that are associated with this ParticipantPayment.
* Also deletes the associated contribution for this participant
*
* @param array $params
......
......@@ -55,7 +55,7 @@ class CRM_Event_BAO_Query {
}
/**
* Build select for CiviEvent
* Build select for CiviEvent.
*
* @param $query
*
......@@ -457,7 +457,7 @@ class CRM_Event_BAO_Query {
}
/**
* Getter for the qill object
* Getter for the qill object.
*
* @return string
*/
......
......@@ -34,7 +34,7 @@ class CRM_Event_Cart_BAO_MerParticipant extends CRM_Event_BAO_Participant {
public $cart = NULL;
/**
* XXX
* XXX.
* @param null $participant
*/
public function __construct($participant = NULL) {
......
......@@ -108,7 +108,7 @@ class CRM_Event_Cart_Form_MerParticipant extends CRM_Core_Form {
}
/**
* XXX poor name
* XXX poor name.
* @param $participant
*
* @return CRM_Event_Cart_Form_MerParticipant
......
......@@ -40,7 +40,7 @@
class CRM_Event_Form_EventFees {
/**
* Set variables up before form is built
* Set variables up before form is built.
*
* @param CRM_Core_Form $form
*
......@@ -340,7 +340,7 @@ SELECT id, html_type
}
/**
* Build the form object
* Build the form object.
*
* @param CRM_Core_Form $form
*
......
......@@ -40,7 +40,7 @@
class CRM_Event_Form_ManageEvent extends CRM_Core_Form {
/**
* The id of the event we are proceessing
* The id of the event we are proceessing.
*
* @var int
*/
......@@ -83,12 +83,12 @@ class CRM_Event_Form_ManageEvent extends CRM_Core_Form {
protected $_campaignID = NULL;
/**
* Check if repeating event
* Check if repeating event.
*/
protected $_isRepeatingEvent;
/**
* Set variables up before form is built
* Set variables up before form is built.
*
* @return void
*/
......@@ -257,7 +257,7 @@ class CRM_Event_Form_ManageEvent extends CRM_Core_Form {
}
/**
* Build the form object
* Build the form object.
*
* @return void
*/
......
......@@ -40,7 +40,7 @@
class CRM_Event_Form_ManageEvent_Conference extends CRM_Event_Form_ManageEvent {
/**
* Page action
* Page action.
*/
public $_action;
......@@ -70,7 +70,7 @@ class CRM_Event_Form_ManageEvent_Conference extends CRM_Event_Form_ManageEvent {
}
/**
* Build the form object
* Build the form object.
*
* @return void
*/
......
......@@ -39,14 +39,14 @@
class CRM_Event_Form_ManageEvent_Delete extends CRM_Event_Form_ManageEvent {
/**
* Page title
* Page title.
*
* @var string
*/
protected $_title;
/**
* Set variables up before form is built
* Set variables up before form is built.
*
* @return void
*/
......@@ -66,7 +66,7 @@ class CRM_Event_Form_ManageEvent_Delete extends CRM_Event_Form_ManageEvent {
}
/**
* Build the form object
* Build the form object.
*
* @return void
*/
......@@ -88,7 +88,7 @@ class CRM_Event_Form_ManageEvent_Delete extends CRM_Event_Form_ManageEvent {
}
/**
* Process the form when submitted
* Process the form when submitted.
*
* @return void
*/
......
......@@ -41,12 +41,12 @@
class CRM_Event_Form_ManageEvent_EventInfo extends CRM_Event_Form_ManageEvent {
/**
* Event type
* Event type.
*/
protected $_eventType = NULL;
/**
* Set variables up before form is built
* Set variables up before form is built.
*
* @return void
*/
......@@ -148,7 +148,7 @@ class CRM_Event_Form_ManageEvent_EventInfo extends CRM_Event_Form_ManageEvent {
}
/**
* Build the form object
* Build the form object.
*
* @return void
*/
......@@ -236,7 +236,7 @@ class CRM_Event_Form_ManageEvent_EventInfo extends CRM_Event_Form_ManageEvent {
}
/**
* Global validation rules for the form
* Global validation rules for the form.
*
* @param array $values
*
......@@ -268,7 +268,7 @@ class CRM_Event_Form_ManageEvent_EventInfo extends CRM_Event_Form_ManageEvent {
}
/**
* Process the form submission
* Process the form submission.
*
*
* @return void
......@@ -343,7 +343,7 @@ class CRM_Event_Form_ManageEvent_EventInfo extends CRM_Event_Form_ManageEvent {
}
/**
* Retrieve event template custom data values
* Retrieve event template custom data values.
* and set as default values for current new event.
*
* @param int $templateId
......
......@@ -50,17 +50,17 @@ class CRM_Event_Form_ManageEvent_Fee extends CRM_Event_Form_ManageEvent {
const NUM_DISCOUNT = 6;
/**
* Page action
* Page action.
*/
public $_action;
/**
* In Date
* In Date.
*/
private $_inDate;
/**
* Set variables up before form is built
* Set variables up before form is built.
*
* @return void
*/
......@@ -246,7 +246,7 @@ class CRM_Event_Form_ManageEvent_Fee extends CRM_Event_Form_ManageEvent {
}
/**
* Build the form object
* Build the form object.
*
* @return void
*/
......@@ -392,7 +392,7 @@ class CRM_Event_Form_ManageEvent_Fee extends CRM_Event_Form_ManageEvent {
}
/**
* Add local and global form rules
* Add local and global form rules.
*
*
* @return void
......@@ -402,7 +402,7 @@ class CRM_Event_Form_ManageEvent_Fee extends CRM_Event_Form_ManageEvent {
}
/**
* Global validation rules for the form
* Global validation rules for the form.
*
* @param array $values
* Posted values of the form.
......@@ -549,7 +549,7 @@ class CRM_Event_Form_ManageEvent_Fee extends CRM_Event_Form_ManageEvent {
}
/**
* Process the form
* Process the form.
*
* @return void
*/
......
......@@ -63,12 +63,12 @@ class CRM_Event_Form_ManageEvent_Location extends CRM_Event_Form_ManageEvent {
protected $_oldLocBlockId = 0;
/**
* Get the db values for this form
* Get the db values for this form.
*/
public $_values = array();
/**
* Set variables up before form is built
* Set variables up before form is built.
*
* @return void
*/
......@@ -125,7 +125,7 @@ class CRM_Event_Form_ManageEvent_Location extends CRM_Event_Form_ManageEvent {
}
/**
* Add local and global form rules
* Add local and global form rules.
*
*
* @return void
......@@ -135,7 +135,7 @@ class CRM_Event_Form_ManageEvent_Location extends CRM_Event_Form_ManageEvent {
}
/**
* Global validation rules for the form
* Global validation rules for the form.
*
* @param array $fields
* Posted values of the form.
......@@ -151,7 +151,7 @@ class CRM_Event_Form_ManageEvent_Location extends CRM_Event_Form_ManageEvent {
}
/**
* function to build location block
* function to build location block.
*
* @return void
*/
......@@ -213,7 +213,7 @@ class CRM_Event_Form_ManageEvent_Location extends CRM_Event_Form_ManageEvent {
}
/**
* Process the form submission
* Process the form submission.
*
*
* @return void
......
......@@ -51,7 +51,7 @@ class CRM_Event_Form_ManageEvent_Registration extends CRM_Event_Form_ManageEvent
protected $_profilePostMultipleAdd = array();
/**
* Set variables up before form is built
* Set variables up before form is built.
*
* @return void
*/
......@@ -221,7 +221,7 @@ class CRM_Event_Form_ManageEvent_Registration extends CRM_Event_Form_ManageEvent
}
/**
* Build the form object
* Build the form object.
*
* @return void
*/
......@@ -308,7 +308,7 @@ class CRM_Event_Form_ManageEvent_Registration extends CRM_Event_Form_ManageEvent
}
/**
* Build Registration Block
* Build Registration Block.
*
* @param CRM_Core_Form $form
*
......@@ -336,7 +336,7 @@ class CRM_Event_Form_ManageEvent_Registration extends CRM_Event_Form_ManageEvent
}
/**
* Subroutine to insert a Profile Editor widget
* Subroutine to insert a Profile Editor widget.
* depends on getProfileSelectorTypes
*
* @param array &$form
......@@ -357,7 +357,7 @@ class CRM_Event_Form_ManageEvent_Registration extends CRM_Event_Form_ManageEvent
}
/**
* Create initializers for addprofileSelector
* Create initializers for addprofileSelector.
*
* @return array
* ['allowCoreTypes' => array, 'allowSubTypes' => array, 'profileEntities' => array]
......@@ -394,7 +394,7 @@ class CRM_Event_Form_ManageEvent_Registration extends CRM_Event_Form_ManageEvent
}
/**
* Build Confirmation Block
* Build Confirmation Block.
*
* @param CRM_Core_Form $form
*
......@@ -421,7 +421,7 @@ class CRM_Event_Form_ManageEvent_Registration extends CRM_Event_Form_ManageEvent
}
/**
* Build Email Block
* Build Email Block.
*
* @param CRM_Core_Form $form
*
......@@ -459,7 +459,7 @@ class CRM_Event_Form_ManageEvent_Registration extends CRM_Event_Form_ManageEvent
}
/**
* Add local and global form rules
* Add local and global form rules.
*
*
* @return void
......@@ -472,7 +472,7 @@ class CRM_Event_Form_ManageEvent_Registration extends CRM_Event_Form_ManageEvent
}
/**
* Global validation rules for the form
* Global validation rules for the form.
*
* @param array $values
* @param $files
......@@ -663,7 +663,7 @@ class CRM_Event_Form_ManageEvent_Registration extends CRM_Event_Form_ManageEvent
}
/**
* Collect all email fields for an array of profile ids
* Collect all email fields for an array of profile ids.
*
* @param $profileIds
* @return bool
......@@ -684,7 +684,7 @@ class CRM_Event_Form_ManageEvent_Registration extends CRM_Event_Form_ManageEvent
}
/**
* Check if a profile contains required fields
* Check if a profile contains required fields.
*
* @param $profileIds
* @return bool
......@@ -718,7 +718,7 @@ class CRM_Event_Form_ManageEvent_Registration extends CRM_Event_Form_ManageEvent
}
/**
* Check if the profiles collect enough information to dedupe
* Check if the profiles collect enough information to dedupe.
*
* @param $profileIds
* @param int $rgId
......@@ -810,7 +810,7 @@ class CRM_Event_Form_ManageEvent_Registration extends CRM_Event_Form_ManageEvent
}
/**
* Process the form submission
* Process the form submission.
*
*
* @return void
......
......@@ -41,7 +41,7 @@
class CRM_Event_Form_ManageEvent_ScheduleReminders extends CRM_Event_Form_ManageEvent {