Merge pull request #6160 from eileenmcnaughton/CRM-16737

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

diff --git a/CRM/Activity/Task.php b/CRM/Activity/Task.php
index 482a0770f2e5964bcf7c5509c670ab5e64fc869f..1a07d53b155a509a41988ca1286189425136a688 100644 (file)
--- a/CRM/Activity/Task.php
+++ b/CRM/Activity/Task.php
@@ -3,13 +3,13 @@
  +--------------------------------------------------------------------+
  | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014                                |
+ | Copyright CiviCRM LLC (c) 2004-2015                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
  | CiviCRM is free software; you can copy, modify, and distribute it  |
  | under the terms of the GNU Affero General Public License           |
- | Version 3, 19 November 2007.                                       |
+ | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  |                                                                    |
  | CiviCRM is distributed in the hope that it will be useful, but     |
  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
@@ -17,25 +17,24 @@
  | See the GNU Affero General Public License for more details.        |
  |                                                                    |
  | You should have received a copy of the GNU Affero General Public   |
- | License along with this program; if not, contact CiviCRM LLC       |
+ | License and the CiviCRM Licensing Exception along                  |
+ | with this program; if not, contact CiviCRM LLC                     |
  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  | 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 to represent the actions that can be performed on a group of contacts
- * used by the search forms
- *
+ * Class to represent the actions that can be performed on a group of contacts
+ * used by the search forms.
  */
 class CRM_Activity_Task {
   const
@@ -47,27 +46,25 @@ class CRM_Activity_Task {
     EMAIL_SMS = 6;
 
   /**
-   * 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;
 
   /**
-   * These tasks are the core set of tasks that the user can perform
+   * 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
+   * @return array
+   *   the set of tasks for a group of contacts
    */
   public static function &tasks() {
     if (!(self::$_tasks)) {
@@ -126,7 +123,8 @@ class CRM_Activity_Task {
       $config = CRM_Core_Config::singleton();
       if (in_array('CiviCase', $config->enableComponents)) {
         if (CRM_Core_Permission::check('access all cases and activities') ||
-          CRM_Core_Permission::check('access my cases and activities')) {
+          CRM_Core_Permission::check('access my cases and activities')
+        ) {
           self::$_tasks[6] = array(
             'title' => ts('File on Case'),
             'class' => 'CRM_Activity_Form_Task_FileOnCase',
@@ -146,11 +144,11 @@ class CRM_Activity_Task {
   }
 
   /**
-   * These tasks are the core set of task titles
+   * These tasks are the core set of task titles.
    * on activity
    *
-   * @return array the set of task titles
-   * @static
+   * @return array
+   *   the set of task titles
    */
   public static function &taskTitles() {
     self::tasks();
@@ -162,12 +160,13 @@ class CRM_Activity_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
+   * @return array
+   *   set of tasks that are valid for the user
    */
   public static function &permissionedTaskTitles($permission) {
     $tasks = array();
@@ -188,13 +187,13 @@ class CRM_Activity_Task {
   }
 
   /**
-   * These tasks are the core set of tasks that the user can perform
+   * These tasks are the core set of tasks that the user can perform.
    * on activity
    *
    * @param int $value
    *
-   * @return array the set of tasks for a group of activity
-   * @static
+   * @return array
+   *   the set of tasks for a group of activity
    */
   public static function getTask($value) {
     self::tasks();
@@ -207,4 +206,5 @@ class CRM_Activity_Task {
       self::$_tasks[$value]['result'],
     );
   }
+
 }