File: Collator.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 (102 lines) | stat: -rw-r--r-- 5,019 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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="Collator" namespace="" name="Collator">
  <constructor name="__construct" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Create a collator"/>
      <return type="void"/>
    </docblock>
    <parameter name="locale" optional="false" byreference="false" type="string"/>
  </constructor>
  <method name="asort" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sort array maintaining index association">Object oriented style</description>
      <return type="bool"/>
    </docblock>
    <parameter name="arr" optional="false" byreference="false" type="object" class="array"/>
    <parameter name="sort_flag" optional="true" byreference="false" type="int"/>
  </method>
  <method name="compare" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Compare two Unicode strings">Object oriented style</description>
      <return type="int"/>
    </docblock>
    <parameter name="str1" optional="false" byreference="false" type="string"/>
    <parameter name="str2" optional="false" byreference="false" type="string"/>
  </method>
  <method name="create" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Create a collator">Object oriented style</description>
      <return type="Collator"/>
    </docblock>
    <parameter name="locale" optional="false" byreference="false" type="string"/>
  </method>
  <method name="getAttribute" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get collation attribute value">Object oriented style</description>
      <return type="int"/>
    </docblock>
    <parameter name="attr" optional="false" byreference="false" type="int"/>
  </method>
  <method name="getErrorCode" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get collator's last error code">Object oriented style</description>
      <return type="int"/>
    </docblock>
  </method>
  <method name="getErrorMessage" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get text for collator's last error code">Object oriented style</description>
      <return type="string"/>
    </docblock>
  </method>
  <method name="getLocale" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get the locale name of the collator">Object oriented style</description>
      <return type="string"/>
    </docblock>
    <parameter name="type" optional="false" byreference="false" type="int"/>
  </method>
  <method name="getSortKey" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get sorting key for a string">Object oriented style</description>
      <return type="string"/>
    </docblock>
    <parameter name="str" optional="false" byreference="false" type="string"/>
  </method>
  <method name="getStrength" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get current collation strength">Object oriented style</description>
      <return type="int"/>
    </docblock>
  </method>
  <method name="setAttribute" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Set collation attribute">Object oriented style</description>
      <return type="bool"/>
    </docblock>
    <parameter name="attr" optional="false" byreference="false" type="int"/>
    <parameter name="val" optional="false" byreference="false" type="int"/>
  </method>
  <method name="setStrength" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Set collation strength">Object oriented style</description>
      <return type="bool"/>
    </docblock>
    <parameter name="strength" optional="false" byreference="false" type="int"/>
  </method>
  <method name="sortWithSortKeys" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sort array using specified collator and sort keys">Object oriented style</description>
      <return type="bool"/>
    </docblock>
    <parameter name="arr" optional="false" byreference="false" type="object" class="array"/>
  </method>
  <method name="sort" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sort array using specified collator">Object oriented style</description>
      <return type="bool"/>
    </docblock>
    <parameter name="arr" optional="false" byreference="false" type="object" class="array"/>
    <parameter name="sort_flag" optional="true" byreference="false" type="int"/>
  </method>
</class>