File: SimpleXMLElement.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 (104 lines) | stat: -rw-r--r-- 5,300 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
103
104
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="SimpleXMLElement" namespace="" name="SimpleXMLElement">
  <implements name="Traversable" full="Traversable"/>
  <constructor name="__construct" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="&#10;   Creates a new SimpleXMLElement object&#10;  "/>
      <return type="void"/>
    </docblock>
    <parameter name="data" optional="false" byreference="false" type="string"/>
    <parameter name="options" optional="true" byreference="false" type="int"/>
    <parameter name="data_is_url" optional="true" byreference="false" type="object" class="bool"/>
    <parameter name="ns" optional="true" byreference="false" type="string"/>
    <parameter name="is_prefix" optional="true" byreference="false" type="object" class="bool"/>
  </constructor>
  <method name="addAttribute" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="&#10;   Adds an attribute to the SimpleXML element&#10;  "/>
      <return type="void"/>
    </docblock>
    <parameter name="name" optional="false" byreference="false" type="string"/>
    <parameter name="value" optional="true" byreference="false" type="string"/>
    <parameter name="namespace" optional="true" byreference="false" type="string"/>
  </method>
  <method name="addChild" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="&#10;   Adds a child element to the XML node&#10;  "/>
      <return type="SimpleXMLElement"/>
    </docblock>
    <parameter name="name" optional="false" byreference="false" type="string"/>
    <parameter name="value" optional="true" byreference="false" type="string"/>
    <parameter name="namespace" optional="true" byreference="false" type="string"/>
  </method>
  <method name="asXML" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="&#10;   Return a well-formed XML string based on SimpleXML element&#10;  "/>
      <return type="mixed"/>
    </docblock>
    <parameter name="filename" optional="true" byreference="false" type="string"/>
  </method>
  <method name="attributes" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Identifies an element's attributes"/>
      <return type="SimpleXMLElement"/>
    </docblock>
    <parameter name="ns" optional="true" byreference="false" type="string"/>
    <parameter name="is_prefix" optional="true" byreference="false" type="object" class="bool"/>
  </method>
  <method name="children" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Finds children of given node"/>
      <return type="SimpleXMLElement"/>
    </docblock>
    <parameter name="ns" optional="true" byreference="false" type="string"/>
    <parameter name="is_prefix" optional="true" byreference="false" type="object" class="bool"/>
  </method>
  <method name="count" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Counts the children of an element"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="getDocNamespaces" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="&#10;   Returns namespaces declared in document&#10;  "/>
      <return type="array"/>
    </docblock>
    <parameter name="recursive" optional="true" byreference="false" type="object" class="bool"/>
    <parameter name="from_root" optional="true" byreference="false" type="object" class="bool"/>
  </method>
  <method name="getName" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Gets the name of the XML element"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="getNamespaces" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="&#10;   Returns namespaces used in document&#10;  "/>
      <return type="array"/>
    </docblock>
    <parameter name="recursive" optional="true" byreference="false" type="object" class="bool"/>
  </method>
  <method name="registerXPathNamespace" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="&#10;   Creates a prefix/ns context for the next XPath query&#10;  "/>
      <return type="bool"/>
    </docblock>
    <parameter name="prefix" optional="false" byreference="false" type="string"/>
    <parameter name="ns" optional="false" byreference="false" type="string"/>
  </method>
  <method name="__toString" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the string content"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="xpath" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Runs XPath query on XML data"/>
      <return type="array"/>
    </docblock>
    <parameter name="path" optional="false" byreference="false" type="string"/>
  </method>
</class>