<!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 SolrParams class</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="solrgenericresponse.destruct.html">SolrGenericResponse::__destruct</a></div> <div class="next" style="text-align: right; float: right;"><a href="solrparams.add.html">SolrParams::add</a></div> <div class="up"><a href="book.solr.html">Solr</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="class.solrparams" class="reference"> <h1 class="title">The SolrParams class</h1> <div class="partintro"><p class="verinfo">(PECL solr >= 0.9.2)</p> <div class="section" id="solrparams.intro"> <h2 class="title">Introduction</h2> <p class="para"> Represents a collection of name-value pairs sent to the Solr server during a request. </p> </div> <div class="section" id="solrparams.synopsis"> <h2 class="title">Class synopsis</h2> <div class="classsynopsis"> <div class="ooclass"></div> <div class="classsynopsisinfo"> <span class="ooclass"> <span class="modifier">abstract</span> <strong class="classname">SolrParams</strong> </span> <span class="oointerface">implements <span class="interfacename"><a href="class.serializable.html" class="interfacename">Serializable</a></span> </span> {</div> <div class="classsynopsisinfo classsynopsisinfo_comment">/* Methods */</div> <div class="methodsynopsis dc-description"> <span class="modifier">final</span> <span class="modifier">public</span> <span class="type">SolrParams</span> <span class="methodname"><a href="solrparams.add.html" class="methodname">add</a></span> ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$name</code></span> , <span class="methodparam"><span class="type">string</span> <code class="parameter">$value</code></span> )</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">SolrParams</span> <span class="methodname"><a href="solrparams.addparam.html" class="methodname">addParam</a></span> ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$name</code></span> , <span class="methodparam"><span class="type">string</span> <code class="parameter">$value</code></span> )</div> <div class="methodsynopsis dc-description"> <span class="modifier">final</span> <span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="solrparams.get.html" class="methodname">get</a></span> ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$param_name</code></span> )</div> <div class="methodsynopsis dc-description"> <span class="modifier">final</span> <span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="solrparams.getparam.html" class="methodname">getParam</a></span> ([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$param_name</code></span> ] )</div> <div class="methodsynopsis dc-description"> <span class="modifier">final</span> <span class="modifier">public</span> <span class="type">array</span> <span class="methodname"><a href="solrparams.getparams.html" class="methodname">getParams</a></span> ( <span class="methodparam">void</span> )</div> <div class="methodsynopsis dc-description"> <span class="modifier">final</span> <span class="modifier">public</span> <span class="type">array</span> <span class="methodname"><a href="solrparams.getpreparedparams.html" class="methodname">getPreparedParams</a></span> ( <span class="methodparam">void</span> )</div> <div class="methodsynopsis dc-description"> <span class="modifier">final</span> <span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="solrparams.serialize.html" class="methodname">serialize</a></span> ( <span class="methodparam">void</span> )</div> <div class="methodsynopsis dc-description"> <span class="modifier">final</span> <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="solrparams.set.html" class="methodname">set</a></span> ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$name</code></span> , <span class="methodparam"><span class="type">string</span> <code class="parameter">$value</code></span> )</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">SolrParams</span> <span class="methodname"><a href="solrparams.setparam.html" class="methodname">setParam</a></span> ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$name</code></span> , <span class="methodparam"><span class="type">string</span> <code class="parameter">$value</code></span> )</div> <div class="methodsynopsis dc-description"> <span class="modifier">final</span> <span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="solrparams.tostring.html" class="methodname">toString</a></span> ([ <span class="methodparam"><span class="type">bool</span> <code class="parameter">$url_encode</code><span class="initializer"> = false</span></span> ] )</div> <div class="methodsynopsis dc-description"> <span class="modifier">final</span> <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="solrparams.unserialize.html" class="methodname">unserialize</a></span> ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$serialized</code></span> )</div> }</div> </div> </div> <h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="solrparams.add.html">SolrParams::add</a> — This is an alias for SolrParams::addParam</li><li><a href="solrparams.addparam.html">SolrParams::addParam</a> — Adds a parameter to the object</li><li><a href="solrparams.get.html">SolrParams::get</a> — This is an alias for SolrParams::getParam</li><li><a href="solrparams.getparam.html">SolrParams::getParam</a> — Returns a parameter value</li><li><a href="solrparams.getparams.html">SolrParams::getParams</a> — Returns an array of non URL-encoded parameters</li><li><a href="solrparams.getpreparedparams.html">SolrParams::getPreparedParams</a> — Returns an array of URL-encoded parameters</li><li><a href="solrparams.serialize.html">SolrParams::serialize</a> — Used for custom serialization</li><li><a href="solrparams.set.html">SolrParams::set</a> — An alias of SolrParams::setParam</li><li><a href="solrparams.setparam.html">SolrParams::setParam</a> — Sets the parameter to the specified value</li><li><a href="solrparams.tostring.html">SolrParams::toString</a> — Returns all the name-value pair parameters in the object</li><li><a href="solrparams.unserialize.html">SolrParams::unserialize</a> — Used for custom serialization</li></ul> </div> <hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="solrgenericresponse.destruct.html">SolrGenericResponse::__destruct</a></div> <div class="next" style="text-align: right; float: right;"><a href="solrparams.add.html">SolrParams::add</a></div> <div class="up"><a href="book.solr.html">Solr</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>