Merge pull request #4983 from colemanw/CRM-15842

[civicrm-core.git] / CRM / Pledge / Info.php

diff --git a/CRM/Pledge/Info.php b/CRM/Pledge/Info.php
index 3f0e20f3b88982ac603738142655afb99600b3c3..d0c36c6056bb2a67a60cb81d8cdaf9d74c388025 100644 (file)
--- a/CRM/Pledge/Info.php
+++ b/CRM/Pledge/Info.php
@@ -1,7 +1,7 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
@@ -23,7 +23,7 @@
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
  * This class introduces component to the system and provides all the
@@ -37,10 +37,19 @@
  */
 class CRM_Pledge_Info extends CRM_Core_Component_Info {
 
-  // docs inherited from interface
+  /**
+   * @inheritDoc
+   */
   protected $keyword = 'pledge';
 
-  // docs inherited from interface
+  /**
+   * Provides base information about the component.
+   * Needs to be implemented in component's information
+   * class.
+   *
+   * @return array
+   *   collection of required component settings
+   */
   public function getInfo() {
     return array(
       'name' => 'CiviPledge',
@@ -52,7 +61,25 @@ class CRM_Pledge_Info extends CRM_Core_Component_Info {
   }
 
 
-  // docs inherited from interface
+  /**
+   * @inheritDoc
+   * Provides permissions that are used by component.
+   * Needs to be implemented in component's information
+   * class.
+   *
+   * NOTE: if using conditionally permission return,
+   * implementation of $getAllUnconditionally is required.
+   *
+   * @param bool $getAllUnconditionally
+   *
+   * @return array|null
+   *   collection of permissions, null if none
+   */
+  /**
+   * @param bool $getAllUnconditionally
+   *
+   * @return array|null
+   */
   public function getPermissions($getAllUnconditionally = FALSE) {
     return array(
       'access CiviPledge',
@@ -61,9 +88,21 @@ class CRM_Pledge_Info extends CRM_Core_Component_Info {
     );
   }
 
-  // docs inherited from interface
+  /**
+   * @inheritDoc
+   * Provides information about user dashboard element
+   * offered by this component.
+   *
+   * @return array|null
+   *   collection of required dashboard settings,
+   *                    null if no element offered
+   */
+  /**
+   * @return array|null
+   */
   public function getUserDashboardElement() {
-    return array('name' => ts('Pledges'),
+    return array(
+      'name' => ts('Pledges'),
       'title' => ts('Your Pledge(s)'),
       // we need to check this permission since you can click on contribution page link for making payment
       'perm' => array('make online contributions'),
@@ -71,38 +110,79 @@ class CRM_Pledge_Info extends CRM_Core_Component_Info {
     );
   }
 
-  // docs inherited from interface
+  /**
+   * @inheritDoc
+   * Provides information about user dashboard element
+   * offered by this component.
+   *
+   * @return array|null
+   *   collection of required dashboard settings,
+   *                    null if no element offered
+   */
+  /**
+   * @return array|null
+   */
   public function registerTab() {
-    return array('title' => ts('Pledges'),
+    return array(
+      'title' => ts('Pledges'),
       'url' => 'pledge',
       'weight' => 25,
     );
   }
 
-  // docs inherited from interface
+  /**
+   * @inheritDoc
+   * Provides information about advanced search pane
+   * offered by this component.
+   *
+   * @return array|null
+   *   collection of required pane settings,
+   *                    null if no element offered
+   */
+  /**
+   * @return array|null
+   */
   public function registerAdvancedSearchPane() {
-    return array('title' => ts('Pledges'),
+    return array(
+      'title' => ts('Pledges'),
       'weight' => 25,
     );
   }
 
-  // docs inherited from interface
+  /**
+   * @inheritDoc
+   * Provides potential activity types that this
+   * component might want to register in activity history.
+   * Needs to be implemented in component's information
+   * class.
+   *
+   * @return array|null
+   *   collection of activity types
+   */
+  /**
+   * @return array|null
+   */
   public function getActivityTypes() {
     return NULL;
   }
 
-  // add shortcut to Create New
+  /**
+   * add shortcut to Create New
+   * @param $shortCuts
+   */
   public function creatNewShortcut(&$shortCuts) {
     if (CRM_Core_Permission::check('access CiviPledge') &&
       CRM_Core_Permission::check('edit pledges')
     ) {
       $shortCuts = array_merge($shortCuts, array(
-        array('path' => 'civicrm/pledge/add',
-            'query' => 'reset=1&action=add&context=standalone',
-            'ref' => 'new-pledge',
-            'title' => ts('Pledge'),
-          )));
+        array(
+          'path' => 'civicrm/pledge/add',
+          'query' => 'reset=1&action=add&context=standalone',
+          'ref' => 'new-pledge',
+          'title' => ts('Pledge'),
+        ),
+      ));
     }
   }
-}
 
+}