mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-15 16:38:54 +00:00
c9389e4a0e
* Fix returnvalues section on yaf_route_* docs * Fix return values section being out-of-order * Fix appendBody docs having duplicate seealso sections * Fix return values to use string entity * Fix errors section missing literal tag and typo * Remove Yaf_Simple_View::__construct return values section * Fix Yaf_Controller_Abstract::forward return values * Fix Yaf_Controller_Abstract::forward signature * Add errors section * Update Yaf_Route_Simple::assemble * Fix Yaf_Route_Rewrite::assemble return value * Update Yaf_Route_Regex::assemble * Update Yaf_Route_Map::assemble Closes GH-569.
151 lines
4.3 KiB
XML
151 lines
4.3 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
|
|
<refentry xml:id="yaf-controller-abstract.forward" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>Yaf_Controller_Abstract::forward</refname>
|
|
<refpurpose>Forward to another action</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<modifier>public</modifier> <type>bool</type><methodname>Yaf_Controller_Abstract::forward</methodname>
|
|
<methodparam><type>string</type><parameter>action</parameter></methodparam>
|
|
<methodparam choice="opt"><type>array</type><parameter>paramters</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<methodsynopsis>
|
|
<modifier>public</modifier> <type>bool</type><methodname>Yaf_Controller_Abstract::forward</methodname>
|
|
<methodparam><type>string</type><parameter>controller</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>action</parameter></methodparam>
|
|
<methodparam choice="opt"><type>array</type><parameter>paramters</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<methodsynopsis>
|
|
<modifier>public</modifier> <type>bool</type><methodname>Yaf_Controller_Abstract::forward</methodname>
|
|
<methodparam><type>string</type><parameter>module</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>controller</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>action</parameter></methodparam>
|
|
<methodparam choice="opt"><type>array</type><parameter>paramters</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
forward current execution process to other action.
|
|
<note>
|
|
<para>
|
|
this method doesn't switch to the destination action immediately, it
|
|
will take place after current flow finish.
|
|
</para>
|
|
</note>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>module</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
destination module name, if NULL was given, then default module name
|
|
is assumed
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>controller</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
destination controller name
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>action</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
destination action name
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>paramters</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
calling arguments
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
&return.success;
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<example>
|
|
<title><function>Yaf_Controller_Abstract::forward</function>example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
class IndexController extends Yaf_Controller_Abstract
|
|
{
|
|
public function indexAction(){
|
|
$logined = $_SESSION["login"];
|
|
if (!$logined) {
|
|
$this->forward("login", array("from" => "Index")); // forward to login action
|
|
return FALSE; // this is important, this finish current working flow
|
|
// and tell the Yaf do not doing auto-render
|
|
}
|
|
|
|
// other processes
|
|
}
|
|
|
|
public function loginAction() {
|
|
echo "login, redirected from ", $this->_request->getParam("from") , " action";
|
|
}
|
|
}
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs.similar;
|
|
<screen>
|
|
<![CDATA[
|
|
login, redirected from Index action
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<simplelist>
|
|
<member><methodname>Yaf_Request_Abstrace::getParam</methodname></member>
|
|
</simplelist>
|
|
</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
|
|
-->
|