CRM-15480 Fix for Recording completed payment for Pending membership from Edit Member...

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

diff --git a/CRM/Pledge/Info.php b/CRM/Pledge/Info.php
index 3f0e20f3b88982ac603738142655afb99600b3c3..822f2e7a37559061ad5b57d9e44cb8b57c9a3546 100644 (file)
--- a/CRM/Pledge/Info.php
+++ b/CRM/Pledge/Info.php
@@ -40,7 +40,14 @@ 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
+   * @access public
+   */
   public function getInfo() {
     return array(
       'name' => 'CiviPledge',
@@ -53,6 +60,24 @@ 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
+   * @access public
+   */
+  /**
+   * @param bool $getAllUnconditionally
+   *
+   * @return array|null
+   */
   public function getPermissions($getAllUnconditionally = FALSE) {
     return array(
       'access CiviPledge',
@@ -62,6 +87,18 @@ 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
+   * @access public
+   *
+   */
+  /**
+   * @return array|null
+   */
   public function getUserDashboardElement() {
     return array('name' => ts('Pledges'),
       'title' => ts('Your Pledge(s)'),
@@ -72,6 +109,18 @@ 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
+   * @access public
+   *
+   */
+  /**
+   * @return array|null
+   */
   public function registerTab() {
     return array('title' => ts('Pledges'),
       'url' => 'pledge',
@@ -80,6 +129,18 @@ 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
+   * @access public
+   *
+   */
+  /**
+   * @return array|null
+   */
   public function registerAdvancedSearchPane() {
     return array('title' => ts('Pledges'),
       'weight' => 25,
@@ -87,11 +148,27 @@ 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
+   * @access public
+   *
+   */
+  /**
+   * @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')