Merge pull request #4911 from colemanw/CRM-15802

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

diff --git a/CRM/Grant/Info.php b/CRM/Grant/Info.php
index 26b6867e31c22c15761a0d614dee401551d89b83..a569c7fcb7a50e42e2958387bb11347b94e5375b 100644 (file)
--- a/CRM/Grant/Info.php
+++ b/CRM/Grant/Info.php
@@ -1,7 +1,7 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
@@ -37,10 +37,15 @@
  */
 class CRM_Grant_Info extends CRM_Core_Component_Info {
 
-  // docs inherited from interface
+  /**
+   * @inheritDoc
+   */
   protected $keyword = 'grant';
 
-  // docs inherited from interface
+  /**
+   * @inheritDoc
+   * @return array
+   */
   public function getInfo() {
     return array(
       'name' => 'CiviGrant',
@@ -53,7 +58,12 @@ class CRM_Grant_Info extends CRM_Core_Component_Info {
   }
 
 
-  // docs inherited from interface
+  /**
+   * @inheritDoc
+   * @param bool $getAllUnconditionally
+   *
+   * @return array
+   */
   public function getPermissions($getAllUnconditionally = FALSE) {
     return array(
       'access CiviGrant',
@@ -62,50 +72,71 @@ class CRM_Grant_Info extends CRM_Core_Component_Info {
     );
   }
 
-  // docs inherited from interface
+  /**
+   * @inheritDoc
+   * @return null
+   */
   public function getUserDashboardElement() {
     // no dashboard element for this component
     return NULL;
   }
 
-  // docs inherited from interface
+  /**
+   * @inheritDoc
+   * @return null
+   */
   public function getUserDashboardObject() {
     // no dashboard element for this component
     return NULL;
   }
 
-  // docs inherited from interface
+  /**
+   * @inheritDoc
+   * @return array
+   */
   public function registerTab() {
-    return array('title' => ts('Grants'),
+    return array(
+      'title' => ts('Grants'),
       'url' => 'grant',
       'weight' => 50,
     );
   }
 
-  // docs inherited from interface
+  /**
+   * @inheritDoc
+   * @return array
+   */
   public function registerAdvancedSearchPane() {
-    return array('title' => ts('Grants'),
+    return array(
+      'title' => ts('Grants'),
       'weight' => 50,
     );
   }
 
-  // docs inherited from interface
+  /**
+   * @inheritDoc
+   * @return 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 CiviGrant') &&
       CRM_Core_Permission::check('edit grants')
     ) {
       $shortCuts = array_merge($shortCuts, array(
-        array('path' => 'civicrm/grant/add',
-            'query' => "reset=1&action=add&context=standalone",
-            'ref' => 'new-grant',
-            'title' => ts('Grant'),
-          )));
+        array(
+          'path' => 'civicrm/grant/add',
+          'query' => "reset=1&action=add&context=standalone",
+          'ref' => 'new-grant',
+          'title' => ts('Grant'),
+        )
+      ));
     }
   }
 }
-