Merge pull request #4893 from colemanw/INFRA-132

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

diff --git a/CRM/Contribute/Info.php b/CRM/Contribute/Info.php
index f2b2cf6e640e1c99d6918f116b35b6de406d78c8..36af5e6983e5ac4b6273ca535bc36d7581e3c618 100644 (file)
--- a/CRM/Contribute/Info.php
+++ b/CRM/Contribute/Info.php
@@ -1,7 +1,7 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
@@ -42,6 +42,17 @@ class CRM_Contribute_Info extends CRM_Core_Component_Info {
   protected $keyword = 'contribute';
 
   // 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
+   */
+  /**
+   * @return array
+   */
   public function getInfo() {
     return array(
       'name' => 'CiviContribute',
@@ -53,6 +64,23 @@ class CRM_Contribute_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 CiviContribute',
@@ -62,6 +90,16 @@ class CRM_Contribute_Info extends CRM_Core_Component_Info {
     );
   }
 
+  /**
+   * Provides permissions that are unwise for Anonymous Roles to have
+   *
+   * @return array
+   *   list of permissions
+   * @see CRM_Component_Info::getPermissions
+   */
+  /**
+   * @return array
+   */
   public function getAnonymousPermissionWarnings() {
     return array(
       'access CiviContribute',
@@ -69,8 +107,19 @@ class CRM_Contribute_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('Contributions'),
+    return array(
+    'name' => ts('Contributions'),
       'title' => ts('Your Contribution(s)'),
       'perm' => array('make online contributions'),
       'weight' => 10,
@@ -78,14 +127,35 @@ class CRM_Contribute_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('Contributions'),
+    return array(
+    'title' => ts('Contributions'),
       'url' => 'contribution',
       'weight' => 20,
     );
   }
 
   // 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('Contributions'),
@@ -94,11 +164,26 @@ class CRM_Contribute_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
+   * @param $newCredit
+   */
   public function creatNewShortcut(&$shortCuts, $newCredit) {
     if (CRM_Core_Permission::check('access CiviContribute') &&
       CRM_Core_Permission::check('edit contributions')
@@ -122,4 +207,3 @@ class CRM_Contribute_Info extends CRM_Core_Component_Info {
     }
   }
 }
-