Merge pull request #4917 from eileenmcnaughton/minor-tidies

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

diff --git a/CRM/Event/BAO/Event.php b/CRM/Event/BAO/Event.php
index 8bbb8c8282bab3b0b4c182a921aaf44e86a5f4c9..64ebe160c7c6bd850ac0d04884cf733aaa3f3a96 100644 (file)
--- a/CRM/Event/BAO/Event.php
+++ b/CRM/Event/BAO/Event.php
@@ -49,8 +49,7 @@ class CRM_Event_BAO_Event extends CRM_Event_DAO_Event {
    * @param array $defaults
    *   (reference ) an assoc array to hold the flattened values.
    *
-   * @return CRM_Event_BAO_ManageEvent object
-   * @static
+   * @return CRM_Event_BAO_ManageEvent
    */
   public static function retrieve(&$params, &$defaults) {
     $event = new CRM_Event_DAO_Event();
@@ -72,7 +71,6 @@ class CRM_Event_BAO_Event extends CRM_Event_DAO_Event {
    *
    * @return Object
    *   DAO object on sucess, null otherwise
-   * @static
    */
   public static function setIsActive($id, $is_active) {
     return CRM_Core_DAO::setFieldValue('CRM_Event_DAO_Event', $id, 'is_active', $is_active);
@@ -84,7 +82,6 @@ class CRM_Event_BAO_Event extends CRM_Event_DAO_Event {
    * @param array $params
    *   Reference array contains the values submitted by the form.
    *
-   * @static
    *
    * @return object
    */
@@ -125,7 +122,6 @@ class CRM_Event_BAO_Event extends CRM_Event_DAO_Event {
    *   Reference array contains the values submitted by the form.
    *
    * @return object
-   * @static
    */
   public static function create(&$params) {
     $transaction = new CRM_Core_Transaction();
@@ -183,7 +179,6 @@ class CRM_Event_BAO_Event extends CRM_Event_DAO_Event {
    *   Event id.
    *
    * @return mixed|null
-   * @static
    */
   public static function del($id) {
     if (!$id) {
@@ -235,7 +230,6 @@ class CRM_Event_BAO_Event extends CRM_Event_DAO_Event {
    * @param int $eventId
    *   Event with which loc block is associated.
    *
-   * @static
    */
   public static function deleteEventLocBlock($locBlockId, $eventId = NULL) {
     $query = "SELECT count(ce.id) FROM civicrm_event ce WHERE ce.loc_block_id = $locBlockId";
@@ -265,13 +259,12 @@ class CRM_Event_BAO_Event extends CRM_Event_DAO_Event {
    *   true if you need to check permission else false.
    *
    * @return array
-   * @static
    */
   static function getEvents(
     $all = 0,
-                            $id = FALSE,
-                            $isActive = TRUE,
-                            $checkPermission = TRUE
+    $id = FALSE,
+    $isActive = TRUE,
+    $checkPermission = TRUE
   ) {
     $query = "
 SELECT `id`, `title`, `start_date`
@@ -320,7 +313,6 @@ WHERE  ( civicrm_event.is_template IS NULL OR civicrm_event.is_template = 0 )";
   /**
    * Get events Summary
    *
-   * @static
    *
    * @return array
    *   Array of event summary values
@@ -602,10 +594,10 @@ $event_summary_limit
    */
   public static function getParticipantCount(
     $eventId,
-                                             $considerStatus = TRUE,
-                                             $status = TRUE,
-                                             $considerRole = TRUE,
-                                             $role = TRUE
+    $considerStatus = TRUE,
+    $status = TRUE,
+    $considerRole = TRUE,
+    $role = TRUE
   ) {
 
     // consider both role and status for counted participants, CRM-4924.
@@ -655,8 +647,8 @@ $event_summary_limit
    * @param int $id
    *   For which we want map info.
    *
-   * @return null|string     title of the event
-   * @static
+   * @return null|string
+   *   title of the event
    */
   public static function &getMapInfo(&$id) {
 
@@ -702,9 +694,9 @@ WHERE civicrm_address.geo_code_1 IS NOT NULL
       $params = array('entity_id' => $id, 'entity_table' => 'civicrm_event');
       $addressValues = CRM_Core_BAO_Location::getValues($params, TRUE);
       $location['address'] = str_replace(array(
-          "\r",
-          "\n",
-        ), '', addslashes(nl2br($addressValues['address'][1]['display_text'])));
+        "\r",
+        "\n",
+      ), '', addslashes(nl2br($addressValues['address'][1]['display_text'])));
 
       $location['url'] = CRM_Utils_System::url('civicrm/event/register', 'reset=1&id=' . $dao->event_id);
       $location['location_type'] = $dao->location_type;
@@ -732,7 +724,6 @@ WHERE civicrm_address.geo_code_1 IS NOT NULL
    *
    * @return array
    *   array of all the events that are searched
-   * @static
    */
   static function &getCompleteInfo(
     $start = NULL,
@@ -914,16 +905,15 @@ WHERE civicrm_event.is_active = 1
    *
    * @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
    * @param bool $afterCreate
    *
-   * @return void
+   * @return CRM_Event_DAO_Event
    */
   public static function copy($id, $newEvent = NULL, $afterCreate = FALSE) {
 
-    $defaults = $eventValues = array();
+    $eventValues = array();
 
     //get the require event values.
     $eventParams = array('id' => $id);
@@ -1455,7 +1445,6 @@ WHERE civicrm_event.is_active = 1
    * @param array $profileFields
    *
    * @return void
-   * @static
    */
   public static function displayProfile(&$params, $gid, &$groupTitle, &$values, &$profileFields = array()) {
     if ($gid) {
@@ -2010,7 +1999,6 @@ WHERE  ce.loc_block_id = $locBlockId";
    *
    * @return string
    *   the permission that the user has (or null)
-   * @static
    */
   public static function checkPermission($eventId = NULL, $type = CRM_Core_Permission::VIEW) {
     static $permissions = NULL;
@@ -2075,7 +2063,6 @@ WHERE  ce.loc_block_id = $locBlockId";
    *
    * @return array
    *   an array of email ids
-   * @static
    */
   public static function getFromEmailIds($eventId = NULL) {
     $fromEmailValues['from_email_id'] = CRM_Core_BAO_Email::getFromEmail();
@@ -2112,7 +2099,6 @@ WHERE  ce.loc_block_id = $locBlockId";
    *
    * @return int
    *   event total seats w/ given criteria.
-   * @static
    */
   public static function eventTotalSeats($eventId, $extraWhereClause = NULL) {
     if (empty($eventId)) {
@@ -2158,7 +2144,7 @@ LEFT  JOIN  civicrm_price_field_value value ON ( value.id = lineItem.price_field
    *   Event template id.
    *
    * @return array
-   *   of custom data defaults.
+   *   Array of custom data defaults.
    */
   public static function getTemplateDefaultValues($templateId) {
     $defaults = array();
@@ -2232,7 +2218,7 @@ LEFT  JOIN  civicrm_price_field_value value ON ( value.id = lineItem.price_field
         // Fixme - this is going to ignore context, better to get conditions, add params, and call PseudoConstant::get
         return CRM_Financial_BAO_FinancialType::getIncomeFinancialType();
 
-      break;
+        break;
     }
     return CRM_Core_PseudoConstant::get(__CLASS__, $fieldName, $params, $context);
   }