Add docs for the yaf.cache_config

Add visiblity modifier to constructors


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@320343 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Xinchen Hui 2011-12-04 05:51:01 +00:00
parent 7847003cd4
commit 124db99281
9 changed files with 37 additions and 12 deletions

View file

@ -203,9 +203,23 @@
<listitem>
<para>
If this is On, and in the meantime you are using ini config file as the
parameter of <classname>Yaf_Application</classname>, then the
parameter of <methodname>Yaf_Application</methodname>, the
compiling result of the ini config file will be cached in the PHP
process.
<note>
<para>
Yaf examine the mtime of the ini file, if it was changed since
last compiling, Yaf will reload it.
</para>
</note>
<warning>
<para>
Yaf use the ini file path as the cache entry key, so do use the
absolute path in ini file path, otherwise there might be some
conflicts if two application use the same relative path of ini
config.
</para>
</warning>
</para>
</listitem>
</varlistentry>

View file

@ -10,12 +10,12 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<methodname>Yaf_Application::__construct</methodname>
<modifier>public</modifier><methodname>Yaf_Application::__construct</methodname>
<methodparam><type>mixed</type><parameter>config</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>envrion</parameter></methodparam>
</methodsynopsis>
<para>
Instance a <classname>Yaf_Application</classname>.
</para>
&warn.undocumented.func;
@ -35,6 +35,14 @@
If is a ini config file, there should be a section named as the one
defined by <link linkend="ini.yaf.environ">yaf.environ</link>, which
is "product" by default.
<note>
<para>
If you use a ini configuration file as your applicatioin's config
container. you would open the <link
linkend="ini.yaf.cache-config">yaf.cache_config</link> to improve
performance.
</para>
</note>
</para>
<para>
And the config entry(and there default value) list blow:

View file

@ -10,7 +10,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<methodname>Yaf_Dispatcher::__construct</methodname>
<modifier>public</modifier><methodname>Yaf_Dispatcher::__construct</methodname>
<void />
</methodsynopsis>
<para>

View file

@ -10,7 +10,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<methodname>Yaf_Loader::__construct</methodname>
<modifier>public</modifier><methodname>Yaf_Loader::__construct</methodname>
<void />
</methodsynopsis>
<para>

View file

@ -10,7 +10,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<methodname>Yaf_Route_Regex::__construct</methodname>
<modifier>public</modifier><methodname>Yaf_Route_Regex::__construct</methodname>
<methodparam><type>string</type><parameter>match</parameter></methodparam>
<methodparam><type>array</type><parameter>route</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>map</parameter></methodparam>

View file

@ -10,7 +10,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<methodname>Yaf_Route_Rewrite::__construct</methodname>
<modifier>public</modifier><methodname>Yaf_Route_Rewrite::__construct</methodname>
<methodparam><type>string</type><parameter>match</parameter></methodparam>
<methodparam><type>array</type><parameter>route</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>verify</parameter></methodparam>

View file

@ -10,7 +10,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<methodname>Yaf_Route_Simple::__construct</methodname>
<modifier>public</modifier><methodname>Yaf_Route_Simple::__construct</methodname>
<methodparam><type>string</type><parameter>module_name</parameter></methodparam>
<methodparam><type>string</type><parameter>controller_name</parameter></methodparam>
<methodparam><type>string</type><parameter>action_name</parameter></methodparam>

View file

@ -10,11 +10,14 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<methodname>Yaf_Route_Supervar::__construct</methodname>
<modifier>public</modifier><methodname>Yaf_Route_Supervar::__construct</methodname>
<methodparam><type>string</type><parameter>supervar_name</parameter></methodparam>
</methodsynopsis>
<para>
<classname>Yaf_Route_Supervar</classname> is similar with
<classname>Yaf_Route_Static</classname>, the difference is
<classname>Yaf_Route_Supervar</classname> will look for path info in query
string, and the parameter <varname>supervar_name</varname> is the key.
</para>
&warn.undocumented.func;

View file

@ -4,13 +4,13 @@
<refentry xml:id="yaf-router.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Yaf_Router::__construct</refname>
<refpurpose>The __construct purpose</refpurpose>
<refpurpose>Yaf_Router constructor</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<methodname>Yaf_Router::__construct</methodname>
<modifier>public</modifier><methodname>Yaf_Router::__construct</methodname>
<void />
</methodsynopsis>
<para>