From 2b41092a3789d617bb273f776941b20a00e94555 Mon Sep 17 00:00:00 2001 From: Xinchen Hui Date: Fri, 7 Oct 2011 05:14:37 +0000 Subject: [PATCH] update docs git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@317851 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/yaf/yaf-config-ini.xml | 74 ++++++++++++++++++- reference/yaf/yaf_config_abstract/get.xml | 7 +- .../yaf/yaf_config_abstract/readonly.xml | 4 +- reference/yaf/yaf_config_abstract/set.xml | 4 +- reference/yaf/yaf_config_abstract/toarray.xml | 4 +- reference/yaf/yaf_config_ini/set.xml | 2 +- reference/yaf/yaf_dispatcher/autorender.xml | 32 +++++++- reference/yaf/yaf_dispatcher/disableview.xml | 2 +- 8 files changed, 115 insertions(+), 14 deletions(-) diff --git a/reference/yaf/yaf-config-ini.xml b/reference/yaf/yaf-config-ini.xml index 53c1d96558..fd9cabf48f 100644 --- a/reference/yaf/yaf-config-ini.xml +++ b/reference/yaf/yaf-config-ini.xml @@ -12,8 +12,24 @@
&reftitle.intro; - + Yaf_Config_Ini enables developers to store configuration data in a + familiar INI format and read them in the application by using nested object + property syntax. The INI format is specialized to provide both the ability + to have a hierarchy of configuration data keys and inheritance between + configuration data sections. Configuration data hierarchies are supported + by separating the keys with the dot or period character ("."). A section + may extend or inherit from another section by following the section name + with a colon character (":") and the name of the section from which data are + to be inherited. + + + Yaf_Config_Ini utilizes the ยป parse_ini_file() PHP function. Please review + this documentation to be aware of its specific behaviors, which propagate + to Yaf_Config_Ini, such as how the special values of "TRUE", "FALSE", + "yes", "no", and "NULL" are handled. + +
@@ -87,6 +103,62 @@ +
+ &reftitle.examples; + + <function>Yaf_Config_Ini</function>example + + This example illustrates a basic use of Yaf_Config_Ini for loading + configuration data from an INI file. In this example there are + configuration data for both a production system and for a staging system. + Because the staging system configuration data are very similar to those + for production, the staging section inherits from the production section. + In this case, the decision is arbitrary and could have been written + conversely, with the production section inheriting from the staging + section, though this may not be the case for more complex situations. + Suppose, then, that the following configuration data are contained in + /path/to/config.ini: + + + + + +database->params->host); +var_dump($config->database->params->dbname); +var_dump($config->get("database.params.username")); +?> +]]> + + &example.outputs.similar; + + + + +
diff --git a/reference/yaf/yaf_config_abstract/get.xml b/reference/yaf/yaf_config_abstract/get.xml index a1e19694dd..18de3aa0f8 100644 --- a/reference/yaf/yaf_config_abstract/get.xml +++ b/reference/yaf/yaf_config_abstract/get.xml @@ -4,14 +4,15 @@ Yaf_Config_Abstract::get - The get purpose + Getter &reftitle.description; - abstract public voidYaf_Config_Abstract::get - + abstract public mixedYaf_Config_Abstract::get + stringname + mixedvalue diff --git a/reference/yaf/yaf_config_abstract/readonly.xml b/reference/yaf/yaf_config_abstract/readonly.xml index 3278c0eb68..ff9b0a97b7 100644 --- a/reference/yaf/yaf_config_abstract/readonly.xml +++ b/reference/yaf/yaf_config_abstract/readonly.xml @@ -4,13 +4,13 @@ Yaf_Config_Abstract::readonly - The readonly purpose + Find a config whether readonly &reftitle.description; - abstract public voidYaf_Config_Abstract::readonly + abstract public boolYaf_Config_Abstract::readonly diff --git a/reference/yaf/yaf_config_abstract/set.xml b/reference/yaf/yaf_config_abstract/set.xml index 3c9c342578..3e1f1deee3 100644 --- a/reference/yaf/yaf_config_abstract/set.xml +++ b/reference/yaf/yaf_config_abstract/set.xml @@ -4,13 +4,13 @@ Yaf_Config_Abstract::set - The set purpose + Setter &reftitle.description; - abstract public voidYaf_Config_Abstract::set + abstract public Yaf_Config_AbstractYaf_Config_Abstract::set diff --git a/reference/yaf/yaf_config_abstract/toarray.xml b/reference/yaf/yaf_config_abstract/toarray.xml index e1886e2c09..15d5e7c3e8 100644 --- a/reference/yaf/yaf_config_abstract/toarray.xml +++ b/reference/yaf/yaf_config_abstract/toarray.xml @@ -4,13 +4,13 @@ Yaf_Config_Abstract::toArray - The toArray purpose + Cast to array &reftitle.description; - abstract public voidYaf_Config_Abstract::toArray + abstract public arrayYaf_Config_Abstract::toArray diff --git a/reference/yaf/yaf_config_ini/set.xml b/reference/yaf/yaf_config_ini/set.xml index 5868db0d6c..cdab6e0bb2 100644 --- a/reference/yaf/yaf_config_ini/set.xml +++ b/reference/yaf/yaf_config_ini/set.xml @@ -12,7 +12,7 @@ public voidYaf_Config_Ini::__set stringname - stringvalue + mixedvalue diff --git a/reference/yaf/yaf_dispatcher/autorender.xml b/reference/yaf/yaf_dispatcher/autorender.xml index 12ee5832ca..aadb675c1f 100644 --- a/reference/yaf/yaf_dispatcher/autorender.xml +++ b/reference/yaf/yaf_dispatcher/autorender.xml @@ -14,7 +14,8 @@ boolflag - + Yaf will can render after dispatched a request, you can prevent the + rendering by calling this method with flag TRUE &warn.undocumented.func; @@ -28,7 +29,7 @@ flag - + bool @@ -42,6 +43,33 @@ + + &reftitle.examples; + + <function>Yaf_Dispatcher::autoRender</function>example + +getRequest()->isXmlHttpRequest()) { + //do not call render for ajax request + //we will outpu a json string + Yaf_Dispatcher::getInstance()->autoRender(FALSE); + } + } +} +?> +]]> + + &example.outputs.similar; + + + + + diff --git a/reference/yaf/yaf_dispatcher/disableview.xml b/reference/yaf/yaf_dispatcher/disableview.xml index 1f50e8548c..8cdf84d371 100644 --- a/reference/yaf/yaf_dispatcher/disableview.xml +++ b/reference/yaf/yaf_dispatcher/disableview.xml @@ -14,7 +14,7 @@ - + &warn.undocumented.func;