SolrParams

abstract class SolrParams implements Serializable (View source)

(PECL solr >= 0.9.2)
Class SolrParams
This class represents a a collection of name-value pairs sent to the Solr server during a request.

Methods

SolrParams|false
add(string $name, string $value)

(PECL solr >= 0.9.2)
This is an alias for SolrParams::addParam

SolrParams|false
addParam(string $name, string $value)

(PECL solr >= 0.9.2)
Adds a parameter to the object

mixed
get(string $param_name)

(PECL solr >= 0.9.2)
This is an alias for SolrParams::getParam

mixed
getParam(string $param_name)

(PECL solr >= 0.9.2)
Returns a parameter value

array
getParams()

(PECL solr >= 0.9.2)
Returns an array of non URL-encoded parameters

array
getPreparedParams()

(PECL solr >= 0.9.2)
Returns an array of URL-encoded parameters

string|null
serialize()

(PECL solr >= 0.9.2)
Used for custom serialization

SolrParams|false
set(string $name, string $value)

(PECL solr >= 0.9.2)
An alias of SolrParams::setParam

SolrParams|false
setParam(string $name, string $value)

(PECL solr >= 0.9.2)
Sets the parameter to the specified value

string|false
toString(bool $url_encode = false)

(PECL solr >= 0.9.2)
Returns all the name-value pair parameters in the object

void
unserialize(string $serialized)

(PECL solr >= 0.9.2)
Used for custom serialization

Details

at line 31
SolrParams|false add(string $name, string $value)

(PECL solr >= 0.9.2)
This is an alias for SolrParams::addParam

Parameters

string $name

The name of the parameter

string $value

The value of the parameter

Return Value

SolrParams|false

Returns a SolrParams instance on success and FALSE on failure.

at line 47
SolrParams|false addParam(string $name, string $value)

(PECL solr >= 0.9.2)
Adds a parameter to the object

Parameters

string $name

The name of the parameter

string $value

The value of the parameter

Return Value

SolrParams|false

Returns a SolrParams instance on success and FALSE on failure.

at line 60
final mixed get(string $param_name)

(PECL solr >= 0.9.2)
This is an alias for SolrParams::getParam

Parameters

string $param_name

The name of the parameter

Return Value

mixed

Returns an array or string depending on the type of parameter

at line 73
final mixed getParam(string $param_name)

(PECL solr >= 0.9.2)
Returns a parameter value

Parameters

string $param_name

The name of the parameter

Return Value

mixed

Returns an array or string depending on the type of parameter

at line 83
final array getParams()

(PECL solr >= 0.9.2)
Returns an array of non URL-encoded parameters

Return Value

array

Returns an array of non URL-encoded parameters

at line 93
final array getPreparedParams()

(PECL solr >= 0.9.2)
Returns an array of URL-encoded parameters

Return Value

array

Returns an array of URL-encoded parameters

at line 103
final string|null serialize()

(PECL solr >= 0.9.2)
Used for custom serialization

Return Value

string|null

The string representation of the object or null

at line 119
final SolrParams|false set(string $name, string $value)

(PECL solr >= 0.9.2)
An alias of SolrParams::setParam

Parameters

string $name

The name of the parameter

string $value

The parameter value

Return Value

SolrParams|false

Returns a SolrParams instance on success and FALSE on failure.

at line 135
SolrParams|false setParam(string $name, string $value)

(PECL solr >= 0.9.2)
Sets the parameter to the specified value

Parameters

string $name

The name of the parameter

string $value

The parameter value

Return Value

SolrParams|false

Returns a SolrParams instance on success and FALSE on failure.

at line 148
final string|false toString(bool $url_encode = false)

(PECL solr >= 0.9.2)
Returns all the name-value pair parameters in the object

Parameters

bool $url_encode

Whether to return URL-encoded values

Return Value

string|false

Returns a string on success and FALSE on failure.

at line 158
final void unserialize(string $serialized)

(PECL solr >= 0.9.2)
Used for custom serialization

Parameters

string $serialized

The serialized representation of the object

Return Value

void