mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-25 05:18:56 +00:00
ecf42293a5
-- Provided by Michael C (wafflestealer654@gmail.com) git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@334709 c90b9560-bf6c-de11-be94-00142212c4b1
103 lines
3 KiB
XML
103 lines
3 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
|
|
<refentry xml:id="httpquerystring.get" xmlns="http://docbook.org/ns/docbook">
|
|
|
|
<refnamediv>
|
|
<refname>HttpQueryString::get</refname>
|
|
<refpurpose>Get the query string or a part thereof</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<modifier>public</modifier>
|
|
<type>mixed</type><methodname>HttpQueryString::get</methodname>
|
|
<methodparam choice="opt"><type>string</type><parameter>key</parameter></methodparam>
|
|
<methodparam choice="opt"><type>mixed</type><parameter>type</parameter><initializer>0</initializer></methodparam>
|
|
<methodparam choice="opt"><type>mixed</type><parameter>defval</parameter><initializer>&null;</initializer></methodparam>
|
|
<methodparam choice="opt"><type>bool</type><parameter>delete</parameter><initializer>false</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>Get the query string or a part thereof</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>key</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Key of the query string parameter to retrieve
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>type</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Variable type to enforce for the returned value
|
|
</para>
|
|
<para>
|
|
Either one of the
|
|
<link linkend="http.httpquerystring.constants">
|
|
HttpQueryString::TYPE_* constants
|
|
</link>
|
|
or a type abbreviation - "b" for bool, "i" for int, "f" for float,
|
|
"s" for string, "a" for array and "o" for a stdClass object.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>defval</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Default value if <parameter>key</parameter> does not exist
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>delete</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Whether to remove <parameter>key</parameter> from the query string
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns the value of the query string param or the whole query string if
|
|
<parameter>key</parameter> was not specified. Returns
|
|
<parameter>defval</parameter> if the specified <parameter>key</parameter>
|
|
does not exist.
|
|
</para>
|
|
</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
|
|
-->
|