Merge pull request #5666 from davejenx/CRM-16321
[civicrm-core.git] / CRM / Pledge / Task.php
index e7d95adafbe23aa8f9ded6b111575a2e4b6e8cff..4d166216892465bb60d3ae3b9c8ebe7dd88632b4 100644 (file)
@@ -1,9 +1,9 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | 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_Pledge_Task {
-  CONST DELETE_PLEDGES = 1, PRINT_PLEDGES = 2, EXPORT_PLEDGES = 3;
+  const DELETE_PLEDGES = 1, PRINT_PLEDGES = 2, EXPORT_PLEDGES = 3;
 
   /**
    * The task array
    *
    * @var array
-   * @static
    */
   static $_tasks = NULL;
 
@@ -53,7 +52,6 @@ class CRM_Pledge_Task {
    * The optional task array
    *
    * @var array
-   * @static
    */
   static $_optionalTasks = NULL;
 
@@ -61,14 +59,14 @@ class CRM_Pledge_Task {
    * These tasks are the core set of tasks that the user can perform
    * on a contact / group of contacts
    *
-   * @return array the set of tasks for a group of contacts
-   * @static
-   * @access public
+   * @return array
+   *   the set of tasks for a group of contacts
    */
-  static function &tasks() {
+  public static function &tasks() {
     if (!self::$_tasks) {
-      self::$_tasks = array(1 => array(
-        'title' => ts('Delete Pledges'),
+      self::$_tasks = array(
+        1 => array(
+          'title' => ts('Delete Pledges'),
           'class' => 'CRM_Pledge_Form_Task_Delete',
           'result' => FALSE,
         ),
@@ -98,13 +96,12 @@ class CRM_Pledge_Task {
   }
 
   /**
-   * These tasks are the core set of task titles
+   * These tasks are the core set of task titles.
    *
-   * @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) {
@@ -114,13 +111,12 @@ class CRM_Pledge_Task {
   }
 
   /**
-   * These tasks get added based on the context the user is in
+   * These tasks get added based on the context the user is in.
    *
-   * @return array the set of optional tasks for a group of contacts
-   * @static
-   * @access public
+   * @return array
+   *   the set of optional tasks for a group of contacts
    */
-  static function &optionalTaskTitle() {
+  public static function &optionalTaskTitle() {
     $tasks = array();
     return $tasks;
   }
@@ -131,10 +127,10 @@ class CRM_Pledge_Task {
    *
    * @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 = array();
     if (($permission == CRM_Core_Permission::EDIT)
       || CRM_Core_Permission::check('edit pledges')
@@ -159,11 +155,10 @@ class CRM_Pledge_Task {
    *
    * @param int $value
    *
-   * @return array the set of tasks for a group of pledge holders
-   * @static
-   * @access public
+   * @return array
+   *   the set of tasks for a group of pledge holders
    */
-  static function getTask($value) {
+  public static function getTask($value) {
     self::tasks();
     if (!$value || !CRM_Utils_Array::value($value, self::$_tasks)) {
       // make the print task by default
@@ -174,5 +169,5 @@ class CRM_Pledge_Task {
       self::$_tasks[$value]['result'],
     );
   }
-}
 
+}