INFRA-132 - CRM/Core - phpcbf

[civicrm-core.git] / CRM / Core / Component / Info.php

diff --git a/CRM/Core/Component/Info.php b/CRM/Core/Component/Info.php
index fce8e98b120a505ffa8e71d6ddda273031e2c870..17f128817264fdc7c74190cd1681475b03605dfb 100644 (file)
--- a/CRM/Core/Component/Info.php
+++ b/CRM/Core/Component/Info.php
@@ -98,8 +98,10 @@ abstract class CRM_Core_Component_Info {
   protected $keyword;
 
   /**
-   * @param string $name name of the component
-   * @param string $namespace namespace prefix for component's files
+   * @param string $name
+   *   Name of the component.
+   * @param string $namespace
+   *   Namespace prefix for component's files.
    * @param int $componentID
    */
   public function __construct($name, $namespace, $componentID) {
@@ -126,7 +128,6 @@ abstract class CRM_Core_Component_Info {
    * class.
    *
    * @return array collection of required component settings
-   * @access public
    *
    */
   abstract public function getInfo();
@@ -162,14 +163,14 @@ abstract class CRM_Core_Component_Info {
    * @param bool $getAllUnconditionally
    *
    * @return array|null collection of permissions, null if none
-   * @access public
    */
   abstract public function getPermissions($getAllUnconditionally = FALSE);
 
   /**
    * Determine how many other records refer to a given record
    *
-   * @param CRM_Core_DAO $dao the item for which we want a reference count
+   * @param CRM_Core_DAO $dao
+   *   The item for which we want a reference count.
    * @return array each item in the array is an array with keys:
    *   - name: string, eg "sql:civicrm_email:contact_id"
    *   - type: string, eg "sql"
@@ -185,7 +186,6 @@ abstract class CRM_Core_Component_Info {
    *
    * @return array|null collection of required dashboard settings,
    *                    null if no element offered
-   * @access public
    *
    */
   abstract public function getUserDashboardElement();
@@ -196,7 +196,6 @@ abstract class CRM_Core_Component_Info {
    *
    * @return array|null collection of required dashboard settings,
    *                    null if no element offered
-   * @access public
    *
    */
   abstract public function registerTab();
@@ -207,7 +206,6 @@ abstract class CRM_Core_Component_Info {
    *
    * @return array|null collection of required pane settings,
    *                    null if no element offered
-   * @access public
    *
    */
   abstract public function registerAdvancedSearchPane();
@@ -219,7 +217,6 @@ abstract class CRM_Core_Component_Info {
    * class.
    *
    * @return array|null collection of activity types
-   * @access public
    *
    */
   abstract public function getActivityTypes();
@@ -229,7 +226,6 @@ abstract class CRM_Core_Component_Info {
    * marked as enabled in configuration.
    *
    * @return boolean true if component is enabled, false if not
-   * @access public
    *
    */
   public function isEnabled() {
@@ -244,7 +240,6 @@ abstract class CRM_Core_Component_Info {
    * Provides component's configuration object.
    *
    * @return mixed component's configuration object
-   * @access public
    *
    */
   public function getConfigObject() {
@@ -255,7 +250,6 @@ abstract class CRM_Core_Component_Info {
    * Provides component's menu definition object.
    *
    * @return mixed component's menu definition object
-   * @access public
    *
    */
   public function getMenuObject() {
@@ -266,7 +260,6 @@ abstract class CRM_Core_Component_Info {
    * Provides component's invocation object.
    *
    * @return mixed component's invocation object
-   * @access public
    *
    */
   public function getInvokeObject() {
@@ -277,7 +270,6 @@ abstract class CRM_Core_Component_Info {
    * Provides component's BAO Query object.
    *
    * @return mixed component's BAO Query object
-   * @access public
    *
    */
   public function getBAOQueryObject() {
@@ -287,7 +279,6 @@ abstract class CRM_Core_Component_Info {
   /**
    * Builds advanced search form's component specific pane.
    *
-   * @access public
    *
    */
   public function buildAdvancedSearchPaneForm(&$form) {
@@ -299,7 +290,6 @@ abstract class CRM_Core_Component_Info {
    * Provides component's user dashboard page object.
    *
    * @return mixed component's User Dashboard applet object
-   * @access public
    *
    */
   public function getUserDashboardObject() {
@@ -310,7 +300,6 @@ abstract class CRM_Core_Component_Info {
    * Provides component's contact record tab object.
    *
    * @return mixed component's contact record tab object
-   * @access public
    *
    */
   public function getTabObject() {
@@ -321,7 +310,6 @@ abstract class CRM_Core_Component_Info {
    * Provides component's advanced search pane's template path.
    *
    * @return string component's advanced search pane's template path
-   * @access public
    *
    */
   public function getAdvancedSearchPaneTemplatePath() {
@@ -333,7 +321,6 @@ abstract class CRM_Core_Component_Info {
    * Provides information whether given component uses system wide search.
    *
    * @return boolean true if component needs search integration
-   * @access public
    *
    */
   public function usesSearch() {
@@ -344,7 +331,6 @@ abstract class CRM_Core_Component_Info {
    * Provides the xml menu files
    *
    * @return array array of menu files
-   * @access public
    *
    */
   public function menuFiles() {
@@ -357,7 +343,6 @@ abstract class CRM_Core_Component_Info {
    * FIXME: accessed from beyond component infrastructure.
    *
    * @return string component keyword
-   * @access public
    *
    */
   public function getKeyword() {
@@ -368,7 +353,6 @@ abstract class CRM_Core_Component_Info {
    * Helper for figuring out menu XML file location.
    *
    * @return mixed component's element as class instance
-   * @access private
    *
    */
   private function _getMenuXMLPath() {
@@ -383,12 +367,10 @@ abstract class CRM_Core_Component_Info {
    * @param $cl
    *
    * @return mixed component's element as class instance
-   * @access private
    */
   private function _instantiate($cl) {
     $className = $this->namespace . '_' . $cl;
-    require_once (str_replace('_', DIRECTORY_SEPARATOR, $className) . '.php');
+    require_once str_replace('_', DIRECTORY_SEPARATOR, $className) . '.php';
     return new $className();
   }
 }
-