sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-16 00:48:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

update docs

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@315968 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Xinchen Hui 2011-09-01 11:12:59 +00:00
parent 2aa12a3a69
commit ed2da66dc0
35 changed files with 464 additions and 70 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

137
reference/yaf/examples.xml
View file

@ -4,23 +4,136 @@
<chapter xml:id="yaf.examples" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.examples;
<example>
<title>Yaf Example</title>
<programlisting role="php">
<![CDATA[
<?php
/* ... */
?>
]]>
</programlisting>
&example.outputs.similar;
<title>A classic Application directory layout</title>
<screen>
<![CDATA[
...
- index.php
- .htaccess
+ conf
|- application.ini //application config
- application/
- Bootstrap.php
+ controllers
- Index.php //default controller
+ views
|+ index
- index.phtml //view template for default action
+ modules
- library
- models
- plugins
]]>
</screen>
</example>
<example>
<title>Entry</title>
<para>index.php in the top directory is the only way in of the application, you should rewrite all request to it(you can use .htaccess in Apache+php_mod) </para>
<programlisting role="php">
<![CDATA[
<?php
define("APPLICATION_PATH", dirname(__FILE__));
$app = new Yaf_Application(APPLICATION_PATH . "/conf/application.ini");
$app->bootstrap() //call bootstrap methods defined in Bootstrap.php
->run();
]]>
</programlisting>
</example>
<example>
<title>Rewrite rule</title>
<screen>
<![CDATA[
#for apache (.htaccess)
RewriteEngine On
RewriteCond %{REQUEST_FILENAME} !-f
RewriteRule .* index.php
#for nginx
server {
listen ****;
server_name domain.com;
root document_root;
index index.php index.html index.htm;
if (!-e $request_filename) {
rewrite ^/(.*) /index.php/$1 last;
}
}
#for lighttpd
$HTTP["host"] =~ "(www.)?domain.com$" {
url.rewrite = (
"^/(.+)/?$" => "/index.php/$1",
)
}
]]>
</screen>
</example>
<example>
<title>Application config</title>
<programlisting role="ini">
<![CDATA[
[yaf]
;APPLICATION_PATH is the constant defined in index.php
application.directory=APPLICATION_PATH "/application/"
;product section inherit from yaf section
[product:yaf]
foo=bar
]]>
</programlisting>
</example>
<example>
<title>Default controller</title>
<programlisting role="php">
<![CDATA[
<?php
class IndexController extends Yaf_Controller_Abstract {
/* default action */
public function indexAction() {
$this->view->word = "hello world";
}
}
?>
]]>
</programlisting>
</example>
<example>
<title>Default view template</title>
<programlisting role="php">
<![CDATA[
<html>
<head>
<title>Hello World</title>
</head>
<body>
<?php echo $word;?>
</body>
</htlm>
]]>
</programlisting>
</example>
<example>
<title>Run the Applicatioin</title>
&example.outputs.similar;
<screen>
<![CDATA[
<html>
<head>
<title>Hello World</title>
</head>
<body>
hello world
</body>
</htlm>
]]>
</screen>
</example>
</chapter>
<!-- Keep this comment at the end of the file

3
reference/yaf/versions.xml
View file

@ -15,6 +15,9 @@
<function name='yaf_application::getconfig' from='PECL yaf &gt;=1.0.0'/>
<function name='yaf_application::getmodules' from='PECL yaf &gt;=1.0.0'/>
<function name='yaf_application::getdispatcher' from='PECL yaf &gt;=1.0.0'/>
<function name='yaf_application::getlasterrorno' from='PECL yaf &gt;=2.1.2'/>
<function name='yaf_application::getlasterrormsg' from='PECL yaf &gt;=2.1.2'/>
<function name='yaf_application::clearlasterror' from='PECL yaf &gt;=2.1.2'/>
<function name='yaf_application::__destruct' from='PECL yaf &gt;=1.0.0'/>
<function name='yaf_application::__clone' from='PECL yaf &gt;=1.0.0'/>
<function name='yaf_application::__sleep' from='PECL yaf &gt;=1.0.0'/>

2
reference/yaf/yaf_application/app.xml
View file

@ -4,7 +4,7 @@
<refentry xml:id="yaf-application.app" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Yaf_Application::app</refname>
<refpurpose>retrive an Application instance</refpurpose>
<refpurpose>Retrive an Application instance</refpurpose>
</refnamediv>
<refsect1 role="description">

93
reference/yaf/yaf_application/clearlasterror.xml Normal file
View file

@ -0,0 +1,93 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="yaf-application.clearlasterror" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Yaf_Application::clearLastError</refname>
<refpurpose>Clear the last error info</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>Yaf_Application</type><methodname>Yaf_Application::clearLastError</methodname>
<void />
</methodsynopsis>
<para>
</para>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title><function>Yaf_Application::clearLastError</function>example</title>
<programlisting role="php">
<![CDATA[
<?php
function error_handler($errno, $errstr, $errfile, $errline) {
Yaf_Application::app()->clearLastError();
var_dump(Yaf_Application::app()->getLastErrorNo());
}
$config = array(
"application" => array(
"directory" => "/tmp/notexists",
"dispatcher" => array(
"throwException" => 0, //trigger error instead of throw exception when error occure
),
),
);
$app = new Yaf_Application($config);
$app->getDispatcher()->setErrorHandler("error_handler", E_RECOVERABLE_ERROR);
$app->run();
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
int(0)
]]>
</screen>
</example>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

2
reference/yaf/yaf_application/environ.xml
View file

@ -4,7 +4,7 @@
<refentry xml:id="yaf-application.environ" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Yaf_Application::environ</refname>
<refpurpose>retrive environ</refpurpose>
<refpurpose>Retrive environ</refpurpose>
</refnamediv>
<refsect1 role="description">

2
reference/yaf/yaf_application/execute.xml
View file

@ -4,7 +4,7 @@
<refentry xml:id="yaf-application.execute" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Yaf_Application::execute</refname>
<refpurpose>execute a callback</refpurpose>
<refpurpose>Execute a callback</refpurpose>
</refnamediv>
<refsect1 role="description">

2
reference/yaf/yaf_application/getconfig.xml
View file

@ -4,7 +4,7 @@
<refentry xml:id="yaf-application.getconfig" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Yaf_Application::getConfig</refname>
<refpurpose>retrive the config instance</refpurpose>
<refpurpose>Retrive the config instance</refpurpose>
</refnamediv>
<refsect1 role="description">

2
reference/yaf/yaf_application/getdispatcher.xml
View file

@ -4,7 +4,7 @@
<refentry xml:id="yaf-application.getdispatcher" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Yaf_Application::getDispatcher</refname>
<refpurpose>get Yaf_Dispatcher instance</refpurpose>
<refpurpose>Get Yaf_Dispatcher instance</refpurpose>
</refnamediv>
<refsect1 role="description">

92
reference/yaf/yaf_application/getlasterrormsg.xml Normal file
View file

@ -0,0 +1,92 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="yaf-application.getlasterrormsg" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Yaf_Application::getLastErrorMsg</refname>
<refpurpose>Get message of the last occurred error</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>Yaf_Application::getLastErrorMsg</methodname>
<void />
</methodsynopsis>
<para>
</para>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title><function>Yaf_Application::getLastErrorMsg</function>example</title>
<programlisting role="php">
<![CDATA[
<?php
function error_handler($errno, $errstr, $errfile, $errline) {
var_dump(Yaf_Application::app()->getLastErrorMsg());
}
$config = array(
"application" => array(
"directory" => "/tmp/notexists",
"dispatcher" => array(
"throwException" => 0, //trigger error instead of throw exception when error occure
),
),
);
$app = new Yaf_Application($config);
$app->getDispatcher()->setErrorHandler("error_handler", E_RECOVERABLE_ERROR);
$app->run();
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
string(69) "Could not find controller script /tmp/notexists/controllers/Index.php"
]]>
</screen>
</example>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

93
reference/yaf/yaf_application/getlasterrorno.xml Normal file
View file

@ -0,0 +1,93 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="yaf-application.getlasterrorno" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Yaf_Application::getLastErrorNo</refname>
<refpurpose>Get code of last occurred error</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>int</type><methodname>Yaf_Application::getLastErrorNo</methodname>
<void />
</methodsynopsis>
<para>
</para>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title><function>Yaf_Application::getLastErrorNo</function>example</title>
<programlisting role="php">
<![CDATA[
<?php
function error_handler($errno, $errstr, $errfile, $errline) {
var_dump(Yaf_Application::app()->getLastErrorNo());
var_dump(Yaf_Application::app()->getLastErrorNo() == YAF_ERR_NOTFOUND_CONTROLLER);
}
$config = array(
"application" => array(
"directory" => "/tmp/notexists",
"dispatcher" => array(
"throwException" => 0, //trigger error instead of throw exception when error occure
),
),
);
$app = new Yaf_Application($config);
$app->getDispatcher()->setErrorHandler("error_handler", E_RECOVERABLE_ERROR);
$app->run();
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
int(516)
bool(true)
]]>
</screen>
</example>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

2
reference/yaf/yaf_application/getmodules.xml
View file

@ -4,7 +4,7 @@
<refentry xml:id="yaf-application.getmodules" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Yaf_Application::getModules</refname>
<refpurpose>get defined module names</refpurpose>
<refpurpose>Get defined module names</refpurpose>
</refnamediv>
<refsect1 role="description">

2
reference/yaf/yaf_application/run.xml
View file

@ -4,7 +4,7 @@
<refentry xml:id="yaf-application.run" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Yaf_Application::run</refname>
<refpurpose>start Yaf_Application</refpurpose>
<refpurpose>Start Yaf_Application</refpurpose>
</refnamediv>
<refsect1 role="description">

6
reference/yaf/yaf_dispatcher/autorender.xml
View file

@ -4,14 +4,14 @@
<refentry xml:id="yaf-dispatcher.autorender" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Yaf_Dispatcher::autoRender</refname>
<refpurpose>The autoRender purpose</refpurpose>
<refpurpose>Switch on/off autorendering</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>Yaf_Dispatcher::autoRender</methodname>
<methodparam><type>string</type><parameter>flag</parameter></methodparam>
<modifier>public</modifier> <type>Yaf_Dispatcher</type><methodname>Yaf_Dispatcher::autoRender</methodname>
<methodparam><type>bool</type><parameter>flag</parameter></methodparam>
</methodsynopsis>
<para>

6
reference/yaf/yaf_dispatcher/catchexception.xml
View file

@ -4,14 +4,14 @@
<refentry xml:id="yaf-dispatcher.catchexception" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Yaf_Dispatcher::catchException</refname>
<refpurpose>The catchException purpose</refpurpose>
<refpurpose>Switch on/off exception catching</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>Yaf_Dispatcher::catchException</methodname>
<methodparam choice="opt"><type>string</type><parameter>flag</parameter></methodparam>
<modifier>public</modifier> <type>Yaf_Dispatcher</type><methodname>Yaf_Dispatcher::catchException</methodname>
<methodparam choice="opt"><type>bool</type><parameter>flag</parameter></methodparam>
</methodsynopsis>
<para>

2
reference/yaf/yaf_dispatcher/clone.xml
View file

@ -4,7 +4,7 @@
<refentry xml:id="yaf-dispatcher.clone" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Yaf_Dispatcher::__clone</refname>
<refpurpose>The __clone purpose</refpurpose>
<refpurpose>Yaf_Dispatcher can not be cloned</refpurpose>
</refnamediv>
<refsect1 role="description">

2
reference/yaf/yaf_dispatcher/construct.xml
View file

@ -4,7 +4,7 @@
<refentry xml:id="yaf-dispatcher.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Yaf_Dispatcher::__construct</refname>
<refpurpose>The __construct purpose</refpurpose>
<refpurpose>Yaf_Dispatcher constructor</refpurpose>
</refnamediv>
<refsect1 role="description">

4
reference/yaf/yaf_dispatcher/disableview.xml
View file

@ -4,13 +4,13 @@
<refentry xml:id="yaf-dispatcher.disableview" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Yaf_Dispatcher::disableView</refname>
<refpurpose>The disableView purpose</refpurpose>
<refpurpose>Disable view rendering</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>Yaf_Dispatcher::disableView</methodname>
<modifier>public</modifier> <type>Yaf_Dispatcher</type><methodname>Yaf_Dispatcher::disableView</methodname>
<void />
</methodsynopsis>
<para>

6
reference/yaf/yaf_dispatcher/dispatch.xml
View file

@ -4,14 +4,14 @@
<refentry xml:id="yaf-dispatcher.dispatch" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Yaf_Dispatcher::dispatch</refname>
<refpurpose>The dispatch purpose</refpurpose>
<refpurpose>Dispatch a request</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>Yaf_Dispatcher::dispatch</methodname>
<methodparam><type>string</type><parameter>request</parameter></methodparam>
<modifier>public</modifier> <type>Yaf_Response_Abstract</type><methodname>Yaf_Dispatcher::dispatch</methodname>
<methodparam><type>Yaf_Request_Abstract</type><parameter>request</parameter></methodparam>
</methodsynopsis>
<para>

4
reference/yaf/yaf_dispatcher/enableview.xml
View file

@ -4,13 +4,13 @@
<refentry xml:id="yaf-dispatcher.enableview" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Yaf_Dispatcher::enableView</refname>
<refpurpose>The enableView purpose</refpurpose>
<refpurpose>enable view rendering</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>Yaf_Dispatcher::enableView</methodname>
<modifier>public</modifier> <type>Yaf_Dispatcher</type><methodname>Yaf_Dispatcher::enableView</methodname>
<void />
</methodsynopsis>
<para>

6
reference/yaf/yaf_dispatcher/flushinstantly.xml
View file

@ -4,14 +4,14 @@
<refentry xml:id="yaf-dispatcher.flushinstantly" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Yaf_Dispatcher::flushInstantly</refname>
<refpurpose>The flushInstantly purpose</refpurpose>
<refpurpose>Switch on/off the instant flushing</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>Yaf_Dispatcher::flushInstantly</methodname>
<methodparam><type>string</type><parameter>flag</parameter></methodparam>
<modifier>public</modifier> <type>Yaf_Dispatcher</type><methodname>Yaf_Dispatcher::flushInstantly</methodname>
<methodparam><type>bool</type><parameter>flag</parameter></methodparam>
</methodsynopsis>
<para>

4
reference/yaf/yaf_dispatcher/getapplication.xml
View file

@ -4,13 +4,13 @@
<refentry xml:id="yaf-dispatcher.getapplication" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Yaf_Dispatcher::getApplication</refname>
<refpurpose>The getApplication purpose</refpurpose>
<refpurpose>Retrive the application</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>Yaf_Dispatcher::getApplication</methodname>
<modifier>public</modifier> <type>Yaf_Application</type><methodname>Yaf_Dispatcher::getApplication</methodname>
<void />
</methodsynopsis>
<para>

4
reference/yaf/yaf_dispatcher/getinstance.xml
View file

@ -4,13 +4,13 @@
<refentry xml:id="yaf-dispatcher.getinstance" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Yaf_Dispatcher::getInstance</refname>
<refpurpose>The getInstance purpose</refpurpose>
<refpurpose>Retrive the dispatcher instance</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <modifier>static</modifier> <type>void</type><methodname>Yaf_Dispatcher::getInstance</methodname>
<modifier>public</modifier> <modifier>static</modifier> <type>Yaf_Dispatcher</type><methodname>Yaf_Dispatcher::getInstance</methodname>
<void />
</methodsynopsis>
<para>

4
reference/yaf/yaf_dispatcher/getrequest.xml
View file

@ -4,13 +4,13 @@
<refentry xml:id="yaf-dispatcher.getrequest" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Yaf_Dispatcher::getRequest</refname>
<refpurpose>The getRequest purpose</refpurpose>
<refpurpose>Retrive the request instance</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>Yaf_Dispatcher::getRequest</methodname>
<modifier>public</modifier> <type>Yaf_Request_Abstract</type><methodname>Yaf_Dispatcher::getRequest</methodname>
<void />
</methodsynopsis>
<para>

4
reference/yaf/yaf_dispatcher/getrouter.xml
View file

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

4
reference/yaf/yaf_dispatcher/initview.xml
View file

@ -4,13 +4,13 @@
<refentry xml:id="yaf-dispatcher.initview" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Yaf_Dispatcher::initView</refname>
<refpurpose>The initView purpose</refpurpose>
<refpurpose>Initialize view and return it</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>Yaf_Dispatcher::initView</methodname>
<modifier>public</modifier> <type>Yaf_View_Interface</type><methodname>Yaf_Dispatcher::initView</methodname>
<methodparam><type>string</type><parameter>templates_dir</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>options</parameter></methodparam>
</methodsynopsis>

6
reference/yaf/yaf_dispatcher/registerplugin.xml
View file

@ -4,14 +4,14 @@
<refentry xml:id="yaf-dispatcher.registerplugin" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Yaf_Dispatcher::registerPlugin</refname>
<refpurpose>The registerPlugin purpose</refpurpose>
<refpurpose>Register a plugin</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>Yaf_Dispatcher::registerPlugin</methodname>
<methodparam><type>string</type><parameter>plugin</parameter></methodparam>
<modifier>public</modifier> <type>Yaf_Dispatcher</type><methodname>Yaf_Dispatcher::registerPlugin</methodname>
<methodparam><type>Yaf_Plugin_Abstract</type><parameter>plugin</parameter></methodparam>
</methodsynopsis>
<para>

4
reference/yaf/yaf_dispatcher/returnresponse.xml
View file

@ -10,8 +10,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>Yaf_Dispatcher::returnResponse</methodname>
<methodparam><type>string</type><parameter>flag</parameter></methodparam>
<modifier>public</modifier> <type>Yaf_Dispatcher</type><methodname>Yaf_Dispatcher::returnResponse</methodname>
<methodparam><type>bool</type><parameter>flag</parameter></methodparam>
</methodsynopsis>
<para>

4
reference/yaf/yaf_dispatcher/setappdirectory.xml
View file

@ -4,13 +4,13 @@
<refentry xml:id="yaf-dispatcher.setappdirectory" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Yaf_Dispatcher::setAppDirectory</refname>
<refpurpose>The setAppDirectory purpose</refpurpose>
<refpurpose>Change the application directory</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>Yaf_Dispatcher::setAppDirectory</methodname>
<modifier>public</modifier> <type>Yaf_Dispatcher</type><methodname>Yaf_Dispatcher::setAppDirectory</methodname>
<methodparam><type>string</type><parameter>directory</parameter></methodparam>
</methodsynopsis>
<para>

4
reference/yaf/yaf_dispatcher/setdefaultaction.xml
View file

@ -4,13 +4,13 @@
<refentry xml:id="yaf-dispatcher.setdefaultaction" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Yaf_Dispatcher::setDefaultAction</refname>
<refpurpose>The setDefaultAction purpose</refpurpose>
<refpurpose>Change default action name</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>Yaf_Dispatcher::setDefaultAction</methodname>
<modifier>public</modifier> <type>Yaf_Dispatcher</type><methodname>Yaf_Dispatcher::setDefaultAction</methodname>
<methodparam><type>string</type><parameter>action</parameter></methodparam>
</methodsynopsis>
<para>

4
reference/yaf/yaf_dispatcher/setdefaultcontroller.xml
View file

@ -4,13 +4,13 @@
<refentry xml:id="yaf-dispatcher.setdefaultcontroller" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Yaf_Dispatcher::setDefaultController</refname>
<refpurpose>The setDefaultController purpose</refpurpose>
<refpurpose>Change default controller name</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>Yaf_Dispatcher::setDefaultController</methodname>
<modifier>public</modifier> <type>Yaf_Dispatcher</type><methodname>Yaf_Dispatcher::setDefaultController</methodname>
<methodparam><type>string</type><parameter>controller</parameter></methodparam>
</methodsynopsis>
<para>

4
reference/yaf/yaf_dispatcher/setdefaultmodule.xml
View file

@ -4,13 +4,13 @@
<refentry xml:id="yaf-dispatcher.setdefaultmodule" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Yaf_Dispatcher::setDefaultModule</refname>
<refpurpose>The setDefaultModule purpose</refpurpose>
<refpurpose>Change default module name</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>Yaf_Dispatcher::setDefaultModule</methodname>
<modifier>public</modifier> <type>Yaf_Dispatcher</type><methodname>Yaf_Dispatcher::setDefaultModule</methodname>
<methodparam><type>string</type><parameter>module</parameter></methodparam>
</methodsynopsis>
<para>

6
reference/yaf/yaf_dispatcher/seterrorhandler.xml
View file

@ -10,9 +10,9 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>Yaf_Dispatcher::setErrorHandler</methodname>
<methodparam><type>string</type><parameter>callback</parameter></methodparam>
<methodparam><type>string</type><parameter>error_types</parameter></methodparam>
<modifier>public</modifier> <type>Yaf_Dispatcher</type><methodname>Yaf_Dispatcher::setErrorHandler</methodname>
<methodparam><type>call</type><parameter>callback</parameter></methodparam>
<methodparam><type>int</type><parameter>error_types</parameter></methodparam>
</methodsynopsis>
<para>

4
reference/yaf/yaf_dispatcher/setrequest.xml
View file

@ -10,8 +10,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>Yaf_Dispatcher::setRequest</methodname>
<methodparam><type>string</type><parameter>plugin</parameter></methodparam>
<modifier>public</modifier> <type>Yaf_Dispatcher</type><methodname>Yaf_Dispatcher::setRequest</methodname>
<methodparam><type>Yaf_Request_Abstract</type><parameter>request</parameter></methodparam>
</methodsynopsis>
<para>

4
reference/yaf/yaf_dispatcher/setview.xml
View file

@ -10,8 +10,8 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>Yaf_Dispatcher::setView</methodname>
<methodparam><type>string</type><parameter>view</parameter></methodparam>
<modifier>public</modifier> <type>Yaf_Dispatcher</type><methodname>Yaf_Dispatcher::setView</methodname>
<methodparam><type>Yaf_View_Interface</type><parameter>view</parameter></methodparam>
</methodsynopsis>
<para>

6
reference/yaf/yaf_dispatcher/throwexception.xml
View file

@ -4,14 +4,14 @@
<refentry xml:id="yaf-dispatcher.throwexception" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Yaf_Dispatcher::throwException</refname>
<refpurpose>The throwException purpose</refpurpose>
<refpurpose>Switch on/off exception throwing</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>Yaf_Dispatcher::throwException</methodname>
<methodparam choice="opt"><type>string</type><parameter>flag</parameter></methodparam>
<modifier>public</modifier> <type>Yaf_Dispatcher</type><methodname>Yaf_Dispatcher::throwException</methodname>
<methodparam choice="opt"><type>bool</type><parameter>flag</parameter></methodparam>
</methodsynopsis>
<para>