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 822f2e7a37559061ad5b57d9e44cb8b57c9a3546..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,7 +37,9 @@
  */
 class CRM_Pledge_Info extends CRM_Core_Component_Info {
 
-  // docs inherited from interface
+  /**
+   * @inheritDoc
+   */
   protected $keyword = 'pledge';
 
   /**
@@ -45,8 +47,8 @@ class CRM_Pledge_Info extends CRM_Core_Component_Info {
    * Needs to be implemented in component's information
    * class.
    *
-   * @return array collection of required component settings
-   * @access public
+   * @return array
+   *   collection of required component settings
    */
   public function getInfo() {
     return array(
@@ -59,8 +61,8 @@ 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.
@@ -70,8 +72,8 @@ class CRM_Pledge_Info extends CRM_Core_Component_Info {
    *
    * @param bool $getAllUnconditionally
    *
-   * @return array|null collection of permissions, null if none
-   * @access public
+   * @return array|null
+   *   collection of permissions, null if none
    */
   /**
    * @param bool $getAllUnconditionally
@@ -86,21 +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,
+   * @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'),
+    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'),
@@ -108,55 +110,54 @@ 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,
+   * @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'),
+    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,
+   * @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'),
+    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
-   * @access public
-   *
+   * @return array|null
+   *   collection of activity types
    */
   /**
    * @return array|null
@@ -165,8 +166,8 @@ class CRM_Pledge_Info extends CRM_Core_Component_Info {
     return NULL;
   }
 
-  // add shortcut to Create New
   /**
+   * add shortcut to Create New
    * @param $shortCuts
    */
   public function creatNewShortcut(&$shortCuts) {
@@ -174,12 +175,14 @@ class CRM_Pledge_Info extends CRM_Core_Component_Info {
       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'),
+        ),
+      ));
     }
   }
-}
 
+}