[Summary view] [Print] [Text view]

   1  <?php
   2  /**
   3   * Part of the Joomla Framework Application Package
   4   *
   5   * @copyright  Copyright (C) 2005 - 2021 Open Source Matters, Inc. All rights reserved.
   6   * @license    GNU General Public License version 2 or later; see LICENSE
   7   */
   8  
   9  namespace Joomla\Application;
  10  
  11  use Joomla\Registry\Registry;
  12  
  13  /**
  14   * Application sub-interface defining an application class which is aware of its configuration
  15   *
  16   * @since  2.0.0
  17   */
  18  interface ConfigurationAwareApplicationInterface extends ApplicationInterface
  19  {
  20      /**
  21       * Returns a property of the object or the default value if the property is not set.
  22       *
  23       * @param   string  $key      The name of the property.
  24       * @param   mixed   $default  The default value (optional) if none is set.
  25       *
  26       * @return  mixed   The value of the configuration.
  27       *
  28       * @since   2.0.0
  29       */
  30  	public function get($key, $default = null);
  31  
  32      /**
  33       * Modifies a property of the object, creating it if it does not already exist.
  34       *
  35       * @param   string  $key    The name of the property.
  36       * @param   mixed   $value  The value of the property to set (optional).
  37       *
  38       * @return  mixed   Previous value of the property
  39       *
  40       * @since   2.0.0
  41       */
  42  	public function set($key, $value = null);
  43  
  44      /**
  45       * Sets the configuration for the application.
  46       *
  47       * @param   Registry  $config  A registry object holding the configuration.
  48       *
  49       * @return  $this
  50       *
  51       * @since   2.0.0
  52       */
  53  	public function setConfiguration(Registry $config);
  54  }