Merge pull request #6757 from yashodha/CRM-17227

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

diff --git a/CRM/Core/Component/Info.php b/CRM/Core/Component/Info.php
index 882502ddb80154fe8c8fc11cd4ec29ff6ddfc501..f2b600c7204ffe13dd50b04a920aa1ec7d513480 100644 (file)
--- a/CRM/Core/Component/Info.php
+++ b/CRM/Core/Component/Info.php
@@ -1,9 +1,9 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.6                                                |
+ | CiviCRM version 4.7                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014                                |
+ | Copyright CiviCRM LLC (c) 2004-2015                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -30,7 +30,7 @@
  * for a component to introduce itself to the system.
  *
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2014
+ * @copyright CiviCRM LLC (c) 2004-2015
  * $Id$
  *
  */
@@ -42,12 +42,6 @@ abstract class CRM_Core_Component_Info {
    */
   const COMPONENT_INVOKE_CLASS = 'Invoke';
 
-  /**
-   * Name of the class (minus component namespace path)
-   * of the component configuration class'es name.
-   */
-  const COMPONENT_CONFIG_CLASS = 'Config';
-
   /**
    * Name of the class (minus component namespace path)
    * of the component BAO Query class'es name.
@@ -91,7 +85,7 @@ abstract class CRM_Core_Component_Info {
   public $info;
 
   /**
-   * Stores component keyword
+   * Stores component keyword.
    * @var string name of component keyword
    */
   protected $keyword;
@@ -133,7 +127,7 @@ abstract class CRM_Core_Component_Info {
   abstract public function getInfo();
 
   /**
-   * Get a list of entities to register via API
+   * Get a list of entities to register via API.
    *
    * @return array
    *   list of entities; same format as CRM_Utils_Hook::managedEntities(&$entities)
@@ -144,7 +138,7 @@ abstract class CRM_Core_Component_Info {
   }
 
   /**
-   * Provides permissions that are unwise for Anonymous Roles to have
+   * Provides permissions that are unwise for Anonymous Roles to have.
    *
    * @return array
    *   list of permissions
@@ -170,7 +164,7 @@ abstract class CRM_Core_Component_Info {
   abstract public function getPermissions($getAllUnconditionally = FALSE);
 
   /**
-   * Determine how many other records refer to a given record
+   * Determine how many other records refer to a given record.
    *
    * @param CRM_Core_DAO $dao
    *   The item for which we want a reference count.
@@ -185,7 +179,7 @@ abstract class CRM_Core_Component_Info {
   }
 
   /**
-   * Provides information about user dashboard element
+   * Provides information about user dashboard element.
    * offered by this component.
    *
    * @return array|null
@@ -195,7 +189,7 @@ abstract class CRM_Core_Component_Info {
   abstract public function getUserDashboardElement();
 
   /**
-   * Provides information about user dashboard element
+   * Provides information about user dashboard element.
    * offered by this component.
    *
    * @return array|null
@@ -240,16 +234,6 @@ abstract class CRM_Core_Component_Info {
     return FALSE;
   }
 
-  /**
-   * Provides component's configuration object.
-   *
-   * @return mixed
-   *   component's configuration object
-   */
-  public function getConfigObject() {
-    return $this->_instantiate(self::COMPONENT_CONFIG_CLASS);
-  }
-
   /**
    * Provides component's menu definition object.
    *
@@ -330,7 +314,7 @@ abstract class CRM_Core_Component_Info {
   }
 
   /**
-   * Provides the xml menu files
+   * Provides the xml menu files.
    *
    * @return array
    *   array of menu files