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 76c084bc570400b291d71f0068823838628c348a..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) {
 
@@ -110,6 +106,10 @@ class CRM_Event_BAO_Participant extends CRM_Event_DAO_Participant {
 
     // ensure that role ids are encoded as a string
     if (isset($params['role_id']) && is_array($params['role_id'])) {
+      if (in_array(key($params['role_id']), CRM_Core_DAO::acceptedSQLOperators())) {
+        $op = key($params['role_id']);
+        $params['role_id'] = $params['role_id'][$op];
+      }
       $params['role_id'] = implode(CRM_Core_DAO::VALUE_SEPARATOR, $params['role_id']);
     }
 
@@ -165,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)) {
@@ -189,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) {
 
@@ -353,7 +351,6 @@ class CRM_Event_BAO_Participant extends CRM_Event_DAO_Participant {
    *
    * @return bool|int|null|string
    *   1. false                 => If event having some empty spaces.
-   * @static
    */
   static function eventFull(
     $eventId,
@@ -498,7 +495,6 @@ SELECT  event.event_full_text,
    *
    * @return array
    *   an array of each option id and total count
-   * @static
    */
   static function priceSetOptionsCount(
     $eventId,
@@ -577,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;
@@ -627,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) {
@@ -740,7 +734,6 @@ GROUP BY  participant.event_id
    *
    * @return array
    *   array of exportable Fields
-   * @static
    */
   public static function &exportableFields() {
     if (!self::$_exportableFields) {
@@ -751,44 +744,31 @@ GROUP BY  participant.event_id
       $fields = array();
 
       $participantFields = CRM_Event_DAO_Participant::export();
+      $eventFields = CRM_Event_DAO_Event::export();
       $noteField = array(
         'participant_note' => array(
           'title' => 'Participant Note',
           'name' => 'participant_note',
-        ),
-      );
+          'type' => CRM_Utils_Type::T_STRING,
+        ));
 
       $participantStatus = array(
         'participant_status' => array(
           'title' => 'Participant Status',
           'name' => 'participant_status',
-        ),
-      );
+          'type' => CRM_Utils_Type::T_STRING,
+        ));
 
       $participantRole = array(
         'participant_role' => array(
           'title' => 'Participant Role',
           'name' => 'participant_role',
-        ),
-      );
-
-      //CRM-13595 add event id to participant export
-      $eventid = array(
-        'event_id' => array(
-          'title' => 'Event ID',
-          'name' => 'event_id',
-        ),
-      );
-      $eventtitle = array(
-        'event_title' => array(
-          'title' => 'Event Title',
-          'name' => 'event_title',
-        ),
-      );
+          'type' => CRM_Utils_Type::T_STRING,
+        ));
 
       $discountFields = CRM_Core_DAO_Discount::export();
 
-      $fields = array_merge($participantFields, $participantStatus, $participantRole, $eventid, $eventtitle, $noteField, $discountFields);
+      $fields = array_merge($participantFields, $participantStatus, $participantRole,  $eventFields, $noteField, $discountFields);
 
       // add custom data
       $fields = array_merge($fields, CRM_Core_BAO_CustomField::getFieldsForImport('Participant'));
@@ -806,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 = "
@@ -837,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);
@@ -881,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);
@@ -942,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);
@@ -990,7 +966,6 @@ WHERE  civicrm_participant.id = {$participantId}
    * @param string $eventLevel
    *   Event_leval string from db.
    *
-   * @static
    *
    * @return void
    */
@@ -1027,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();
@@ -1069,7 +1043,6 @@ WHERE  civicrm_participant.id = {$participantId}
    *   Do fetch from line items.
    *
    * @return array
-   * @static
    */
   public function getFeeDetails($participantIds, $hasLineItems = FALSE) {
     $feeDetails = array();
@@ -1145,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();
@@ -1177,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) {
@@ -1214,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) {
@@ -1250,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,
@@ -1492,10 +1459,7 @@ UPDATE  civicrm_participant
    * @param string $mailType
    *   (eg 'approval', 'confirm', 'expired' ).
    *
-   * return  void
-   *
    * @return bool
-   * @static
    */
   static function sendTransitionParticipantMail(
     $participantId,
@@ -1747,7 +1711,6 @@ UPDATE  civicrm_participant
    *
    * @return int
    *   count of participant records
-   * @static
    */
   public static function getContactParticipantCount($contactID) {
     $query = "SELECT count(*)
@@ -1766,7 +1729,6 @@ WHERE    civicrm_participant.contact_id = {$contactID} AND
    *   Exclude cancelled additional participant.
    *
    * @return array
-   * @static
    */
   public static function getParticipantIds($contributionId, $excludeCancelled = FALSE) {
 
@@ -1798,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) {
@@ -1827,7 +1788,6 @@ WHERE    civicrm_participant.contact_id = {$contactID} AND
    *
    * @param $feeLevel
    *
-   * @static
    */
   public static function createDiscountTrxn($eventID, $contributionParams, $feeLevel) {
     // CRM-11124
@@ -1866,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();
@@ -2201,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
    */