INFRA-132 - Docblock formatting fixes

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

diff --git a/CRM/PCP/BAO/PCP.php b/CRM/PCP/BAO/PCP.php
index 47d008585b767de3ee3c1826039e22c0109eb891..64f8c9615e2c16340ef0012f14f0f168d33bba3c 100644 (file)
--- a/CRM/PCP/BAO/PCP.php
+++ b/CRM/PCP/BAO/PCP.php
@@ -43,7 +43,6 @@ class CRM_PCP_BAO_PCP extends CRM_PCP_DAO_PCP {
   static $_pcpLinks = NULL;
 
   /**
-   *
    */
   public function __construct() {
     parent::__construct();
@@ -81,7 +80,7 @@ class CRM_PCP_BAO_PCP extends CRM_PCP_DAO_PCP {
 
     // set currency for CRM-1496
     if (!isset($dao->currency)) {
-      $config = & CRM_Core_Config::singleton();
+      $config = &CRM_Core_Config::singleton();
       $dao->currency = $config->defaultCurrency;
     }
 
@@ -95,7 +94,8 @@ class CRM_PCP_BAO_PCP extends CRM_PCP_DAO_PCP {
    * @param int $id
    *   Id for the PCP.
    *
-   * @return null|string     Dispaly name of the contact if found
+   * @return null|string
+   *   Dispaly name of the contact if found
    * @static
    */
   public static function displayName($id) {
@@ -115,7 +115,8 @@ WHERE  civicrm_pcp.contact_id = civicrm_contact.id
    *
    * @param int $contactId
    *
-   * @return array     array of Pcp if found
+   * @return array
+   *   array of Pcp if found
    * @static
    */
   public static function getPcpDashboardInfo($contactId) {
@@ -236,7 +237,8 @@ ORDER BY target_entity_type, target_entity_id
    *
    * @static
    *
-   * @return total amount
+   * @return total
+   *   amount
    */
   public static function thermoMeter($pcpId) {
     $query = "
@@ -258,7 +260,7 @@ WHERE pcp.id = %1 AND cc.contribution_status_id =1 AND cc.is_test = 0";
    *
    * @static
    *
-   * @return array $honor
+   * @return array
    */
   public static function honorRoll($pcpId) {
     $query = "
@@ -283,7 +285,8 @@ WHERE pcp.id = %1 AND cc.contribution_status_id =1 AND cc.is_test = 0";
   /**
    * Get action links
    *
-   * @return array (reference) of action links
+   * @return array
+   *   (reference) of action links
    * @static
    */
   public static function &pcpLinks() {
@@ -356,7 +359,6 @@ WHERE pcp.id = %1 AND cc.contribution_status_id =1 AND cc.is_test = 0";
    *
    * @return null
    * @static
-   *
    */
   public static function deleteById($id) {
     CRM_Utils_Hook::pre('delete', 'Campaign', $id, CRM_Core_DAO::$_nullArray);
@@ -394,7 +396,7 @@ WHERE pcp.id = %1 AND cc.contribution_status_id =1 AND cc.is_test = 0";
     }
     CRM_Core_DAO::commonRetrieveAll('CRM_Core_DAO_UFGroup', 'is_cms_user', $isUserRequired, $profiles, array(
       'title',
-      'is_active'
+      'is_active',
     ));
     if (!empty($profiles)) {
       foreach ($profiles as $key => $value) {
@@ -426,10 +428,9 @@ WHERE pcp.id = %1 AND cc.contribution_status_id =1 AND cc.is_test = 0";
   }
 
 
-  /*
-   * Add PCP form elements to a form
-   */
   /**
+   * Add PCP form elements to a form
+   *
    * @param int $pcpId
    * @param CRM_Core_Page $page
    * @param null $elements
@@ -466,8 +467,8 @@ WHERE pcp.id = %1 AND cc.contribution_status_id =1 AND cc.is_test = 0";
       );
       $extraOption = array('onclick' => "return pcpAnonymous( );");
       $elements = array();
-      $elements[] = & $page->createElement('radio', NULL, '', ts('Include my name and message'), 0, $extraOption);
-      $elements[] = & $page->createElement('radio', NULL, '', ts('List my support anonymously'), 1, $extraOption);
+      $elements[] = &$page->createElement('radio', NULL, '', ts('Include my name and message'), 0, $extraOption);
+      $elements[] = &$page->createElement('radio', NULL, '', ts('List my support anonymously'), 1, $extraOption);
       $page->addGroup($elements, 'pcp_is_anonymous', NULL, '   ');
       $page->_defaults['pcp_is_anonymous'] = 0;
 
@@ -479,10 +480,9 @@ WHERE pcp.id = %1 AND cc.contribution_status_id =1 AND cc.is_test = 0";
     }
   }
 
-  /*
-   * Process a PCP contribution/
-   */
   /**
+   * Process a PCP contribution
+   *
    * @param int $pcpId
    * @param $component
    * @param $entity
@@ -614,7 +614,7 @@ WHERE pcp.id = %1 AND cc.contribution_status_id =1 AND cc.is_test = 0";
 
     CRM_Core_Session::setStatus(ts("%1 status has been updated to %2.", array(
       1 => $pcpTitle,
-      2 => $pcpStatus
+      2 => $pcpStatus,
     )), 'Status Updated', 'success');
 
     // send status change mail
@@ -793,7 +793,6 @@ WHERE pcp.id = %1 AND cc.contribution_status_id =1 AND cc.is_test = 0";
    *
    * @return Boolean
    * @static
-   *
    */
   public static function getPcpBlockInUse($id) {
     $query = "