fixes to comment blocks

[civicrm-core.git] / CRM / Campaign / Task.php

diff --git a/CRM/Campaign/Task.php b/CRM/Campaign/Task.php
index 4e78a38980be520078e2c90317b8b4d8dda59b31..dff92989e82fb224d62ed8812ae81cb20f18ca8d 100755 (executable)
--- a/CRM/Campaign/Task.php
+++ b/CRM/Campaign/Task.php
@@ -1,9 +1,9 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.4                                                |
+ | CiviCRM version 4.7                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2013                                |
+ | Copyright CiviCRM LLC (c) 2004-2015                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -23,12 +23,12 @@
  | 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-2013
+ * @copyright CiviCRM LLC (c) 2004-2015
  * $Id$
  *
  */
@@ -40,21 +40,19 @@
  *
  */
 class CRM_Campaign_Task {
-  CONST INTERVIEW = 1, RESERVE = 2, RELEASE = 3, PRINT_VOTERS = 4;
+  const INTERVIEW = 1, RESERVE = 2, RELEASE = 3, PRINT_VOTERS = 4;
 
   /**
-   * the task array
+   * The task array
    *
    * @var array
-   * @static
    */
   static $_tasks = NULL;
 
   /**
-   * the optional task array
+   * The optional task array
    *
    * @var array
-   * @static
    */
   static $_optionalTasks = NULL;
 
@@ -62,20 +60,22 @@ class CRM_Campaign_Task {
    * These tasks are the core set of tasks that the user can perform
    * on a voter / group of voters
    *
-   * @return array the set of tasks for a group of voters.
-   * @static
-   * @access public
+   * @return array
+   *   the set of tasks for a group of voters.
    */
-  static function &tasks() {
+  public static function &tasks() {
     if (!(self::$_tasks)) {
-      self::$_tasks = array(1 => array('title' => ts('Record Respondents Interview'),
+      self::$_tasks = array(
+        1 => array(
+          'title' => ts('Record Respondents Interview'),
           'class' => array(
             'CRM_Campaign_Form_Task_Interview',
             'CRM_Campaign_Form_Task_Release',
           ),
           'result' => FALSE,
         ),
-        2 => array('title' => ts('Reserve Respondents'),
+        2 => array(
+          'title' => ts('Reserve Respondents'),
           'class' => array(
             'CRM_Campaign_Form_Task_Reserve',
             'CRM_Campaign_Form_Task_Interview',
@@ -83,11 +83,13 @@ class CRM_Campaign_Task {
           ),
           'result' => FALSE,
         ),
-        3 => array('title' => ts('Release Respondents'),
+        3 => array(
+          'title' => ts('Release Respondents'),
           'class' => 'CRM_Campaign_Form_Task_Release',
           'result' => FALSE,
         ),
-        4 => array('title' => ts('Print Respondents'),
+        4 => array(
+          'title' => ts('Print Respondents'),
           'class' => 'CRM_Campaign_Form_Task_Print',
           'result' => FALSE,
         ),
@@ -105,11 +107,10 @@ class CRM_Campaign_Task {
    * These tasks are the core set of task titles
    * on voters.
    *
-   * @return array the set of task titles
-   * @static
-   * @access public
+   * @return array
+   *   the set of task titles
    */
-  static function &taskTitles() {
+  public static function &taskTitles() {
     self::tasks();
     $titles = array();
     foreach (self::$_tasks as $id => $value) {
@@ -120,15 +121,15 @@ class CRM_Campaign_Task {
   }
 
   /**
-   * show tasks selectively based on the permission level
+   * Show tasks selectively based on the permission level
    * of the user
    *
    * @param int $permission
    *
-   * @return array set of tasks that are valid for the user
-   * @access public
+   * @return array
+   *   set of tasks that are valid for the user
    */
-  static function &permissionedTaskTitles($permission) {
+  public static function &permissionedTaskTitles($permission) {
     $tasks = self::taskTitles();
 
     return $tasks;
@@ -140,11 +141,10 @@ class CRM_Campaign_Task {
    *
    * @param int $value
    *
-   * @return array the set of tasks for a group of voters.
-   * @static
-   * @access public
+   * @return array
+   *   the set of tasks for a group of voters.
    */
-  static function getTask($value) {
+  public static function getTask($value) {
     self::tasks();
     if (!$value || !CRM_Utils_Array::value($value, self::$_tasks)) {
       // make the interview task by default
@@ -156,5 +156,5 @@ class CRM_Campaign_Task {
       self::$_tasks[$value]['result'],
     );
   }
-}
 
+}