Merge pull request #5076 from colemanw/Attachment

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

diff --git a/CRM/Report/Info.php b/CRM/Report/Info.php
index 6c119a7cfc47c930a010fd2bcdd9f55410be41fd..d6e09597d05855b22cb83c0643f979ec37cc8194 100644 (file)
--- a/CRM/Report/Info.php
+++ b/CRM/Report/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,10 +37,23 @@
  */
 class CRM_Report_Info extends CRM_Core_Component_Info {
 
-  // docs inherited from interface
+  /**
+   * @inheritDoc
+   */
   protected $keyword = 'report';
 
-  // docs inherited from interface
+  /**
+   * @inheritDoc
+   * 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' => 'CiviReport',
@@ -52,41 +65,117 @@ class CRM_Report_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.
+   *
+   * 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 CiviReport', 'access Report Criteria', 'administer reserved reports', 'administer Reports');
   }
 
 
-  // docs inherited from interface
+  /**
+   * @inheritDoc
+   * 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() {
     // no dashboard element for this component
     return NULL;
   }
 
+  /**
+   * Provides component's user dashboard page object.
+   *
+   * @return mixed
+   *   component's User Dashboard applet object
+   */
+  /**
+   * @return mixed
+   */
   public function getUserDashboardObject() {
     // no dashboard element for this component
     return NULL;
   }
 
-  // docs inherited from interface
+  /**
+   * @inheritDoc
+   * 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() {
     // this component doesn't use contact record tabs
     return NULL;
   }
 
-  // docs inherited from interface
+  /**
+   * @inheritDoc
+   * 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() {
     // this component doesn't use advanced search
     return NULL;
   }
 
-  // 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
+   */
+  /**
+   * @return array|null
+   */
   public function getActivityTypes() {
     return NULL;
   }
 
-  // add shortcut to Create New
-  public function creatNewShortcut(&$shortCuts) {}
-}
+  /**
+   * add shortcut to Create New
+   * @param $shortCuts
+   */
+  public function creatNewShortcut(&$shortCuts) {
+  }
 
+}