<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>The HttpQueryString class</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="httpmessage.tostring.html">HttpMessage::toString</a></div>
<div class="next" style="text-align: right; float: right;"><a href="httpquerystring.construct.html">HttpQueryString::__construct</a></div>
<div class="up"><a href="book.http.html">HTTP</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="class.httpquerystring" class="reference">
<h1 class="title">The <a href="class.httpquerystring.html" class="classname">HttpQueryString</a> class</h1>
<div class="partintro"><p class="verinfo">(PECL pecl_http >= 0.22.0)</p>
<div class="section" id="httpquerystring.synopsis">
<h2 class="title">Class synopsis</h2>
<div class="classsynopsis">
<div class="ooclass"></div>
<div class="classsynopsisinfo">
<span class="ooclass"><strong class="classname">HttpQueryString</strong></span>
<span class="oointerface">implements
<span class="interfacename"><a href="class.arrayaccess.html" class="interfacename">ArrayAccess</a></span>
</span>
<span class="oointerface">,
<span class="interfacename"><a href="class.serializable.html" class="interfacename">Serializable</a></span>
</span>
{</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final public</span>
<span class="methodname"><a href="httpquerystring.construct.html" class="methodname">__construct</a></span>
([ <span class="methodparam"><span class="type">bool</span> <code class="parameter">$global</code><span class="initializer"> = true</span></span>
[, <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$add</code></span>
]] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span>
<span class="type">mixed</span> <span class="methodname"><a href="httpquerystring.get.html" class="methodname">get</a></span>
([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$key</code></span>
[, <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$type</code><span class="initializer"> = 0</span></span>
[, <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$defval</code><span class="initializer"> = <strong><code>NULL</code></strong></span></span>
[, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$delete</code><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="httpquerystring.mod.html" class="methodname">mod</a></span>
( <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$params</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span>
<span class="type">string</span> <span class="methodname"><a href="httpquerystring.set.html" class="methodname">set</a></span>
( <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$params</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">static public</span>
<span class="type">HttpQueryString</span> <span class="methodname"><a href="httpquerystring.singleton.html" class="methodname">singleton</a></span>
([ <span class="methodparam"><span class="type">bool</span> <code class="parameter">$global</code><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="httpquerystring.toarray.html" class="methodname">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="httpquerystring.tostring.html" class="methodname">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="httpquerystring.xlate.html" class="methodname">xlate</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$ie</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$oe</code></span>
)</div>
}</div>
</div>
<div class="section" id="http.httpquerystring.members">
<h2 class="title">Class Members</h2>
<div class="section" id="http.httpquerystring.properties">
<h2 class="title">Properties</h2>
<table id="http.httpquerystring.properties.instance" class="doctable table">
<caption><strong>Instance Properties</strong></caption>
<thead>
<tr>
<th>Modifiers</th>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>private</td>
<td>array</td>
<td>queryArray</td>
<td>query parameters</td>
</tr>
<tr>
<td>private</td>
<td>string</td>
<td>queryString</td>
<td>serialized query parameters</td>
</tr>
</tbody>
</table>
<table id="http.httpquerystring.properties.static" class="doctable table">
<caption><strong>Static Properties</strong></caption>
<thead>
<tr>
<th>Modifiers</th>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>private</td>
<td>array</td>
<td>instance</td>
<td>holds singletons</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="http.httpquerystring.constants">
<h2 class="title">Predefined Constants</h2>
<table class="doctable table">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>int</td>
<td>TYPE_BOOL</td>
<td>retrieve query param as bool</td>
</tr>
<tr>
<td>int</td>
<td>TYPE_INT</td>
<td>retrieve query param as int</td>
</tr>
<tr>
<td>int</td>
<td>TYPE_FLOAT</td>
<td>retrieve query param as float</td>
</tr>
<tr>
<td>int</td>
<td>TYPE_STRING</td>
<td>retrieve query param as string</td>
</tr>
<tr>
<td>int</td>
<td>TYPE_ARRAY</td>
<td>retrieve query param as array</td>
</tr>
<tr>
<td>int</td>
<td>TYPE_OBJECT</td>
<td>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="httpquerystring.construct.html">HttpQueryString::__construct</a> — HttpQueryString constructor</li><li><a href="httpquerystring.get.html">HttpQueryString::get</a> — Get (part of) query string</li><li><a href="httpquerystring.mod.html">HttpQueryString::mod</a> — Modifiy query string copy</li><li><a href="httpquerystring.set.html">HttpQueryString::set</a> — Set query string params</li><li><a href="httpquerystring.singleton.html">HttpQueryString::singleton</a> — HttpQueryString singleton</li><li><a href="httpquerystring.toarray.html">HttpQueryString::toArray</a> — Get query string as array</li><li><a href="httpquerystring.tostring.html">HttpQueryString::toString</a> — Get query string</li><li><a href="httpquerystring.xlate.html">HttpQueryString::xlate</a> — Change query strings charset</li></ul>
</div>
<hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="httpmessage.tostring.html">HttpMessage::toString</a></div>
<div class="next" style="text-align: right; float: right;"><a href="httpquerystring.construct.html">HttpQueryString::__construct</a></div>
<div class="up"><a href="book.http.html">HTTP</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
