File: SolrParams.xml

package info (click to toggle)
phpdox 0.12.0-6
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, sid
  • size: 7,672 kB
  • sloc: xml: 80,724; php: 9,167; makefile: 13
file content (82 lines) | stat: -rw-r--r-- 3,779 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="SolrParams" namespace="" name="SolrParams">
  <implements name="Serializable" full="Serializable"/>
  <method name="add" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="This is an alias for SolrParams::addParam"/>
      <return type="SolrParams"/>
    </docblock>
    <parameter name="name" optional="false" byreference="false" type="string"/>
    <parameter name="value" optional="false" byreference="false" type="string"/>
  </method>
  <method name="addParam" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Adds a parameter to the object"/>
      <return type="SolrParams"/>
    </docblock>
    <parameter name="name" optional="false" byreference="false" type="string"/>
    <parameter name="value" optional="false" byreference="false" type="string"/>
  </method>
  <method name="get" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="This is an alias for SolrParams::getParam"/>
      <return type="mixed"/>
    </docblock>
    <parameter name="param_name" optional="false" byreference="false" type="string"/>
  </method>
  <method name="getParam" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact=" Returns a parameter value"/>
      <return type="mixed"/>
    </docblock>
    <parameter name="param_name" optional="true" byreference="false" type="string"/>
  </method>
  <method name="getParams" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Returns an array of non URL-encoded parameters"/>
      <return type="array"/>
    </docblock>
  </method>
  <method name="getPreparedParams" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Returns an array of URL-encoded parameters"/>
      <return type="array"/>
    </docblock>
  </method>
  <method name="serialize" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Used for custom serialization"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="set" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="An alias of SolrParams::setParam"/>
      <return type="void"/>
    </docblock>
    <parameter name="name" optional="false" byreference="false" type="string"/>
    <parameter name="value" optional="false" byreference="false" type="string"/>
  </method>
  <method name="setParam" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sets the parameter to the specified value"/>
      <return type="SolrParams"/>
    </docblock>
    <parameter name="name" optional="false" byreference="false" type="string"/>
    <parameter name="value" optional="false" byreference="false" type="string"/>
  </method>
  <method name="toString" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Returns all the name-value pair parameters in the object"/>
      <return type="string"/>
    </docblock>
    <parameter name="url_encode" optional="true" byreference="false" type="object" class="bool"/>
  </method>
  <method name="unserialize" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Used for custom serialization"/>
      <return type="void"/>
    </docblock>
    <parameter name="serialized" optional="false" byreference="false" type="string"/>
  </method>
</class>