php-doc-en/reference/yaf/yaf-request-simple.xml
George Peter Banyard ecaa214642
Fix de/constructor synopsis tag usage (#1457)
In Solr, Stomp, Yaf.

Also include constructor and destructor in StreamWrapper interface synopsis
2022-03-15 16:36:11 +00:00

194 lines
5.7 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<phpdoc:classref xml:id="class.yaf-request-simple" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The Yaf_Request_Simple class</title>
<titleabbrev>Yaf_Request_Simple</titleabbrev>
<partintro>
<!-- {{{ Yaf_Request_Simple intro -->
<section xml:id="yaf-request-simple.intro">
&reftitle.intro;
<para>
<classname>Yaf_Request_Simple</classname> is particularlly used for test
puporse. ie. simulate some espacial request under CLI mode.
</para>
</section>
<!-- }}} -->
<section xml:id="yaf-request-simple.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>Yaf_Request_Simple</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>Yaf_Request_Simple</classname>
</ooclass>
<ooclass>
<modifier>extends</modifier>
<classname>Yaf_Request_Abstract</classname>
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">Constants</classsynopsisinfo>
<fieldsynopsis>
<modifier>const</modifier>
<type>string</type>
<varname linkend="yaf-request-simple.constants.scheme-http">Yaf_Request_Simple::SCHEME_HTTP</varname>
<initializer>http</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>string</type>
<varname linkend="yaf-request-simple.constants.scheme-https">Yaf_Request_Simple::SCHEME_HTTPS</varname>
<initializer>https</initializer>
</fieldsynopsis>
<classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.yaf-request-simple')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[not(@role='procedural')])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.yaf-request-simple')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
<classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.yaf-request-abstract')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
</classsynopsis>
<!-- }}} -->
</section>
<!-- {{{ Yaf_Request_Simple properties -->
<section xml:id="yaf-request-simple.props">
&reftitle.properties;
<variablelist>
<varlistentry xml:id="yaf-request-simple.props.module">
<term><varname>module</varname></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry xml:id="yaf-request-simple.props.controller">
<term><varname>controller</varname></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry xml:id="yaf-request-simple.props.action">
<term><varname>action</varname></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry xml:id="yaf-request-simple.props.method">
<term><varname>method</varname></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry xml:id="yaf-request-simple.props.params">
<term><varname>params</varname></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry xml:id="yaf-request-simple.props.language">
<term><varname>language</varname></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry xml:id="yaf-request-simple.props.exception">
<term><varname>_exception</varname></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry xml:id="yaf-request-simple.props.base-uri">
<term><varname>_base_uri</varname></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry xml:id="yaf-request-simple.props.uri">
<term><varname>uri</varname></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry xml:id="yaf-request-simple.props.dispatched">
<term><varname>dispatched</varname></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry xml:id="yaf-request-simple.props.routed">
<term><varname>routed</varname></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->
<!-- {{{ Yaf_Request_Simple constants -->
<section xml:id="yaf-request-simple.constants">
&reftitle.constants;
<variablelist>
<varlistentry xml:id="yaf-request-simple.constants.scheme-http">
<term><constant>Yaf_Request_Simple::SCHEME_HTTP</constant></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry xml:id="yaf-request-simple.constants.scheme-https">
<term><constant>Yaf_Request_Simple::SCHEME_HTTPS</constant></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->
</partintro>
&reference.yaf.entities.yaf-request-simple;
</phpdoc:classref>
<!-- 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
-->