Source of: /manual/en/class.httpquerystring.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/book.http.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'class.httpquerystring.php',
1 => 'The HttpQueryString class',
),
'up' =>
array (
0 => 'book.http.php',
1 => 'HTTP',
),
'prev' =>
array (
0 => 'function.httpmessage-tostring.php',
1 => 'HttpMessage::toString',
),
'next' =>
array (
0 => 'function.httpquerystring-construct.php',
1 => 'HttpQueryString::__construct',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div>
<h1 class="title">The <b class="classname">HttpQueryString</b> class</h1>
<div class="partintro">
<div id="httpquerystring.synopsis" class="section">
<h2 class="title">Class synopsis</h2>
<div class="classsynopsis">
<div class="ooclass"><b class="classname">HttpQueryString</b></div>
<div class="classsynopsisinfo">
<span class="ooclass"><b class="classname">HttpQueryString</b></span>
<span class="oointerface">implements
<a href="class.arrayaccess.php" class="interfacename">ArrayAccess</a>
</span>
<span class="oointerface">,
<a href="class.serializable.php" class="interfacename">Serializable</a>
</span>
{</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final public</span>
<span class="type">void</span> <span class="methodname"><a href="function.httpquerystring-construct.php" class="function">__construct</a></span>
([ <span class="methodparam"><span class="type">bool</span> <tt class="parameter">$global</tt><span class="initializer"> = true</span></span>
[, <span class="methodparam"><span class="type"><a href="language.pseudo-types.php#language.types.mixed" class="type mixed">mixed</a></span> <tt class="parameter">$add</tt></span>
]] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span>
<span class="type">mixed</span> <span class="methodname"><a href="function.httpquerystring-get.php" class="function">get</a></span>
([ <span class="methodparam"><span class="type">string</span> <tt class="parameter">$key</tt></span>
[, <span class="methodparam"><span class="type"><a href="language.pseudo-types.php#language.types.mixed" class="type mixed">mixed</a></span> <tt class="parameter">$type</tt><span class="initializer"> = 0</span></span>
[, <span class="methodparam"><span class="type"><a href="language.pseudo-types.php#language.types.mixed" class="type mixed">mixed</a></span> <tt class="parameter">$defval</tt><span class="initializer"> = NULL</span></span>
[, <span class="methodparam"><span class="type">bool</span> <tt class="parameter">$delete</tt><span class="initializer"> = false</span></span>
]]]] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span>
<span class="type">HttpQueryString</span> <span class="methodname"><a href="function.httpquerystring-mod.php" class="function">mod</a></span>
( <span class="methodparam"><span class="type"><a href="language.pseudo-types.php#language.types.mixed" class="type mixed">mixed</a></span> <tt class="parameter">$params</tt></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span>
<span class="type">string</span> <span class="methodname"><a href="function.httpquerystring-set.php" class="function">set</a></span>
( <span class="methodparam"><span class="type"><a href="language.pseudo-types.php#language.types.mixed" class="type mixed">mixed</a></span> <tt class="parameter">$params</tt></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">static public</span>
<span class="type">HttpQueryString</span> <span class="methodname"><a href="function.httpquerystring-singleton.php" class="function">singleton</a></span>
([ <span class="methodparam"><span class="type">bool</span> <tt class="parameter">$global</tt><span class="initializer"> = true</span></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span>
<span class="type">array</span> <span class="methodname"><a href="function.httpquerystring-toarray.php" class="function">toArray</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span>
<span class="type">string</span> <span class="methodname"><a href="function.httpquerystring-tostring.php" class="function">toString</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span>
<span class="type">bool</span> <span class="methodname"><a href="function.httpquerystring-xlate.php" class="function">xlate</a></span>
( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$ie</tt></span>
, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$oe</tt></span>
)</div>
}</div>
</div>
<div id="http.HttpQueryString.members" class="section">
<h2 class="title">Class Members</h2>
<div id="http.HttpQueryString.properties" class="section">
<h2 class="title">Properties</h2>
<table class="doctable table">
<caption><b>Instance Properties</b></caption>
<thead valign="middle">
<tr valign="middle">
<th>Modifiers</th>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody valign="middle" class="tbody">
<tr valign="middle">
<td align="left">private</td>
<td align="left">array</td>
<td align="left">queryArray</td>
<td align="left">query parameters</td>
</tr>
<tr valign="middle">
<td align="left">private</td>
<td align="left">string</td>
<td align="left">queryString</td>
<td align="left">serialized query parameters</td>
</tr>
</tbody>
</table>
<table class="doctable table">
<caption><b>Static Properties</b></caption>
<thead valign="middle">
<tr valign="middle">
<th>Modifiers</th>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody valign="middle" class="tbody">
<tr valign="middle">
<td align="left">private</td>
<td align="left">array</td>
<td align="left">instance</td>
<td align="left">holds singletons</td>
</tr>
</tbody>
</table>
</div>
<div id="http.HttpQueryString.constants" class="section">
<h2 class="title">Predefined Constants</h2>
<table class="doctable table">
<thead valign="middle">
<tr valign="middle">
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody valign="middle" class="tbody">
<tr valign="middle">
<td align="left">int</td>
<td align="left">TYPE_BOOL</td>
<td align="left">retrieve query param as bool</td>
</tr>
<tr valign="middle">
<td align="left">int</td>
<td align="left">TYPE_INT</td>
<td align="left">retrieve query param as int</td>
</tr>
<tr valign="middle">
<td align="left">int</td>
<td align="left">TYPE_FLOAT</td>
<td align="left">retrieve query param as float</td>
</tr>
<tr valign="middle">
<td align="left">int</td>
<td align="left">TYPE_STRING</td>
<td align="left">retrieve query param as string</td>
</tr>
<tr valign="middle">
<td align="left">int</td>
<td align="left">TYPE_ARRAY</td>
<td align="left">retrieve query param as array</td>
</tr>
<tr valign="middle">
<td align="left">int</td>
<td align="left">TYPE_OBJECT</td>
<td align="left">retrieve query param as object</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="function.httpquerystring-construct.php">HttpQueryString::__construct</a> — HttpQueryString constructor</li><li><a href="function.httpquerystring-get.php">HttpQueryString::get</a> — Get (part of) query string</li><li><a href="function.httpquerystring-mod.php">HttpQueryString::mod</a> — Modifiy query string copy</li><li><a href="function.httpquerystring-set.php">HttpQueryString::set</a> — Set query string params</li><li><a href="function.httpquerystring-singleton.php">HttpQueryString::singleton</a> — HttpQueryString singleton</li><li><a href="function.httpquerystring-toarray.php">HttpQueryString::toArray</a> — Get query string as array</li><li><a href="function.httpquerystring-tostring.php">HttpQueryString::toString</a> — Get query string</li><li><a href="function.httpquerystring-xlate.php">HttpQueryString::xlate</a> — Change query strings charset</li></ul>
</div>
<?php manual_footer(); ?>