Author: Derick Rethans
Date: 2007-03-27 13:09:59 +0200 (Tue, 27 Mar 2007)
New Revision: 4776
Log:
- Implemented issue #10457: Unclear what $name in getSetting() of
Configuration component means.
Modified:
trunk/Configuration/ChangeLog
trunk/Configuration/src/configuration_manager.php
Modified: trunk/Configuration/ChangeLog
===================================================================
--- trunk/Configuration/ChangeLog 2007-03-26 09:23:12 UTC (rev 4775)
+++ trunk/Configuration/ChangeLog 2007-03-27 11:09:59 UTC (rev 4776)
@@ -3,6 +3,8 @@
- Implemented issue #9965: Support for delayed initialization through
ezcBaseInit.
+- Implemented issue #10457: Unclear what $name in getSetting() of
+ Configuration component means.
- Added the ezcConfigurationManager::reset() method that returns the
manager to its unintialized state.
- Fixed issue #10110: Warnings in configuration tests with the posix extension
Modified: trunk/Configuration/src/configuration_manager.php
===================================================================
--- trunk/Configuration/src/configuration_manager.php 2007-03-26 09:23:12 UTC
(rev 4775)
+++ trunk/Configuration/src/configuration_manager.php 2007-03-27 11:09:59 UTC
(rev 4776)
@@ -16,6 +16,12 @@
* smaller applications which don't have too many settings and does not have
* high memory or speed requirements.
*
+ * Many of the methods of this class that fetch settings accept one to three
+ * parameters with the following names: $name - the configuration's name. For
+ * the ini file reader, this is the name of the configuration file without the
+ * path or the extension (.ini); $group - the name of the group in which the
+ * setting is located; and $setting - the name of the setting itself.
+ *
* Before the manager can be used it must be configured so it knows where to
* fetch the settings, this is usually at the start of the program.
* <code>
@@ -173,7 +179,6 @@
* if the manager has not been initialized with the init() method.
*
* @param string $name
- * @param bool $mayFail
* @return ezcConfigurationReader The constructed reader
*/
private function fetchReader( $name )
@@ -225,7 +230,7 @@
}
/**
- * Returns the configuration object for a the configuration named $name.
+ * Returns the configuration object for the configuration named $name.
*
* @throws ezcConfigurationUnknownConfigException if the configuration
* $name does not exist.
--
svn-components mailing list
svn-components@lists.ez.no
http://lists.ez.no/mailman/listinfo/svn-components
