Merge pull request #4809 from totten/master-cs2

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

diff --git a/CRM/Pledge/Info.php b/CRM/Pledge/Info.php
index 3f0e20f3b88982ac603738142655afb99600b3c3..4560ef650c62902c5c30ff8b4346fcd1342ffbe0 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                                |
  +--------------------------------------------------------------------+
@@ -40,7 +40,13 @@ class CRM_Pledge_Info extends CRM_Core_Component_Info {
   // docs inherited from interface
   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',
@@ -53,6 +59,23 @@ class CRM_Pledge_Info extends CRM_Core_Component_Info {
 
 
   // docs inherited from interface
+  /**
+   * 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',
@@ -62,6 +85,17 @@ class CRM_Pledge_Info extends CRM_Core_Component_Info {
   }
 
   // docs inherited from interface
+  /**
+   * 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'),
       'title' => ts('Your Pledge(s)'),
@@ -72,6 +106,17 @@ class CRM_Pledge_Info extends CRM_Core_Component_Info {
   }
 
   // docs inherited from interface
+  /**
+   * 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'),
       'url' => 'pledge',
@@ -80,6 +125,17 @@ class CRM_Pledge_Info extends CRM_Core_Component_Info {
   }
 
   // docs inherited from interface
+  /**
+   * 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'),
       'weight' => 25,
@@ -87,11 +143,26 @@ class CRM_Pledge_Info extends CRM_Core_Component_Info {
   }
 
   // docs inherited from interface
+  /**
+   * 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
+  /**
+   * @param $shortCuts
+   */
   public function creatNewShortcut(&$shortCuts) {
     if (CRM_Core_Permission::check('access CiviPledge') &&
       CRM_Core_Permission::check('edit pledges')
@@ -105,4 +176,3 @@ class CRM_Pledge_Info extends CRM_Core_Component_Info {
     }
   }
 }
-