codespell: CRM/*
[civicrm-core.git] / CRM / PCP / Page / PCP.php
index 28ec1336c20120babdd6314be1f7024528d75367..2b3972b08b18bf5a79c917d7499de5c2c420a18c 100644 (file)
@@ -3,7 +3,7 @@
  +--------------------------------------------------------------------+
  | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014                                |
+ | Copyright CiviCRM LLC (c) 2004-2015                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
  *
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2014
+ * @copyright CiviCRM LLC (c) 2004-2015
  * $Id$
  *
  */
 class CRM_PCP_Page_PCP extends CRM_Core_Page_Basic {
 
   /**
-   * The action links that we need to display for the browse screen
+   * The action links that we need to display for the browse screen.
    *
    * @var array
-   * @static
    */
   static $_links = NULL;
 
   /**
-   * Get BAO Name
+   * Get BAO Name.
    *
-   * @return string Classname of BAO.
+   * @return string
+   *   Classname of BAO.
    */
   public function getBAOName() {
     return 'CRM_PCP_BAO_PCP';
   }
 
   /**
-   * Get action Links
+   * Get action Links.
    *
-   * @return array (reference) of action links
+   * @return array
+   *   (reference) of action links
    */
   public function &links() {
     if (!(self::$_links)) {
@@ -91,12 +92,14 @@ class CRM_PCP_Page_PCP extends CRM_Core_Page_Basic {
           'extra' => 'onclick = "return confirm(\'' . $deleteExtra . '\');"',
           'title' => ts('Delete Personal Campaign Page'),
         ),
-        CRM_Core_Action::ENABLE => array('name' => ts('Enable'),
+        CRM_Core_Action::ENABLE => array(
+          'name' => ts('Enable'),
           'url' => 'civicrm/admin/pcp',
           'qs' => 'action=enable&id=%%id%%',
           'title' => ts('Enable'),
         ),
-        CRM_Core_Action::DISABLE => array('name' => ts('Disable'),
+        CRM_Core_Action::DISABLE => array(
+          'name' => ts('Disable'),
           'url' => 'civicrm/admin/pcp',
           'qs' => 'action=disable&id=%%id%%',
           'title' => ts('Disable'),
@@ -163,7 +166,6 @@ class CRM_PCP_Page_PCP extends CRM_Core_Page_Basic {
    * @param null $action
    *
    * @return void
-   * @static
    */
   public function browse($action = NULL) {
     $this->_sortByCharacter = CRM_Utils_Request::retrieve('sortByCharacter',
@@ -176,7 +178,6 @@ class CRM_PCP_Page_PCP extends CRM_Core_Page_Basic {
       $this->_sortByCharacter = '';
     }
 
-
     $status = CRM_PCP_BAO_PCP::buildOptions('status_id', 'create');
 
     $pcpSummary = $params = array();
@@ -233,7 +234,7 @@ class CRM_PCP_Page_PCP extends CRM_Core_Page_Basic {
     }
 
     // get all event pages. pcp campaign start and end dates for event related pcp's use the online registration start and end dates,
-    // altho if target is contribution page this might not be correct. fixme? dgg
+    // although if target is contribution page this might not be correct. fixme? dgg
     $query = "SELECT id, title, start_date, end_date, registration_start_date, registration_end_date
                   FROM civicrm_event
                   WHERE is_template IS NULL OR is_template != 1";
@@ -355,18 +356,20 @@ class CRM_PCP_Page_PCP extends CRM_Core_Page_Basic {
   }
 
   /**
-   * Get name of edit form
+   * Get name of edit form.
    *
-   * @return string Classname of edit form.
+   * @return string
+   *   Classname of edit form.
    */
   public function editForm() {
     return 'CRM_PCP_Form_PCP';
   }
 
   /**
-   * Get edit form name
+   * Get edit form name.
    *
-   * @return string name of this page.
+   * @return string
+   *   name of this page.
    */
   public function editName() {
     return ts('Personal Campaign Page');
@@ -377,14 +380,15 @@ class CRM_PCP_Page_PCP extends CRM_Core_Page_Basic {
    *
    * @param null $mode
    *
-   * @return string user context.
+   * @return string
+   *   user context.
    */
   public function userContext($mode = NULL) {
     return 'civicrm/admin/pcp';
   }
 
-  //@TODO this function changed, debug this at runtime
   /**
+   * @TODO this function changed, debug this at runtime
    * @param $whereClause
    * @param array $whereParams
    */
@@ -409,4 +413,5 @@ class CRM_PCP_Page_PCP extends CRM_Core_Page_Basic {
     $aToZBar = CRM_Utils_PagerAToZ::getAToZBar($dao, $this->_sortByCharacter, TRUE);
     $this->assign('aToZ', $aToZBar);
   }
+
 }