Skip to content

Commit 0463c12

Browse files
committed
Document Dom\CharacterData methods
1 parent 30d79eb commit 0463c12

17 files changed

+595
-9
lines changed
Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<refentry xml:id="dom-characterdata.after" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
3+
<refnamediv>
4+
<refname>Dom\CharacterData::after</refname>
5+
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('domcharacterdata.after')/db:refnamediv/db:refpurpose)"/>
6+
</refnamediv>
7+
8+
<refsect1 role="description">
9+
&reftitle.description;
10+
<methodsynopsis role="Dom\\CharacterData">
11+
<modifier>public</modifier> <type>void</type><methodname>Dom\CharacterData::after</methodname>
12+
<methodparam rep="repeat"><type class="union"><type>Dom\Node</type><type>string</type></type><parameter>nodes</parameter></methodparam>
13+
</methodsynopsis>
14+
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('domcharacterdata.after')/db:refsect1[@role='description']/db:para[1])"/>
15+
</refsect1>
16+
17+
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('domchildnode.after')/db:refsect1[@role='parameters'])" />
18+
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('domchildnode.after')/db:refsect1[@role='returnvalues'])" />
19+
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('domchildnode.after')/db:refsect1[@role='errors'])" />
20+
21+
<refsect1 role="examples">
22+
&reftitle.examples;
23+
<example xml:id="dom-characterdata.after.example.basic">
24+
<title><methodname>Dom\CharacterData::after</methodname> example</title>
25+
<simpara>
26+
Adds nodes after the character data.
27+
</simpara>
28+
<programlisting role="php">
29+
<![CDATA[
30+
<?php
31+
$doc = Dom\XMLDocument::createFromString("<container><![CDATA[hello]]]]><![CDATA[></container>");
32+
$cdata = $doc->documentElement->firstChild;
33+
34+
$cdata->after("beautiful", $doc->createElement("world"));
35+
36+
echo $doc->saveXML();
37+
?>
38+
]]>
39+
</programlisting>
40+
&example.outputs;
41+
<screen>
42+
<![CDATA[
43+
<?xml version="1.0" encoding="UTF-8"?>
44+
<container><![CDATA[hello]]]]><![CDATA[>beautiful<world/></container>
45+
]]>
46+
</screen>
47+
</example>
48+
</refsect1>
49+
50+
<refsect1 role="seealso">
51+
&reftitle.seealso;
52+
<simplelist>
53+
<member><methodname>Dom\ChildNode::after</methodname></member>
54+
<member><methodname>Dom\CharacterData::before</methodname></member>
55+
</simplelist>
56+
</refsect1>
57+
58+
</refentry>
59+
<!-- Keep this comment at the end of the file
60+
Local variables:
61+
mode: sgml
62+
sgml-omittag:t
63+
sgml-shorttag:t
64+
sgml-minimize-attributes:nil
65+
sgml-always-quote-attributes:t
66+
sgml-indent-step:1
67+
sgml-indent-data:t
68+
indent-tabs-mode:nil
69+
sgml-parent-document:nil
70+
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
71+
sgml-exposed-tags:nil
72+
sgml-local-catalogs:nil
73+
sgml-local-ecat-files:nil
74+
End:
75+
vim600: syn=xml fen fdm=syntax fdl=2 si
76+
vim: et tw=78 syn=sgml
77+
vi: ts=1 sw=1
78+
-->
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<refentry xml:id="dom-characterdata.appenddata" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
3+
<refnamediv>
4+
<refname>Dom\CharacterData::appendData</refname>
5+
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('domcharacterdata.appenddata')/db:refnamediv/db:refpurpose)"/>
6+
</refnamediv>
7+
8+
<refsect1 role="description">
9+
&reftitle.description;
10+
<methodsynopsis role="Dom\\CharacterData">
11+
<modifier>public</modifier> <type>void</type><methodname>Dom\CharacterData::appendData</methodname>
12+
<methodparam><type>string</type><parameter>data</parameter></methodparam>
13+
</methodsynopsis>
14+
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('domcharacterdata.appenddata')/db:refsect1[@role='description']/db:para[1])"/>
15+
</refsect1>
16+
17+
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('domcharacterdata.appenddata')/db:refsect1[@role='parameters'])" />
18+
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('domcharacterdata.appenddata')/db:refsect1[@role='returnvalues'])" />
19+
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('domcharacterdata.appenddata')/db:refsect1[@role='errors'])" />
20+
21+
<refsect1 role="seealso">
22+
&reftitle.seealso;
23+
<simplelist>
24+
<member><methodname>Dom\CharacterData::deleteData</methodname></member>
25+
<member><methodname>Dom\CharacterData::insertData</methodname></member>
26+
<member><methodname>Dom\CharacterData::replaceData</methodname></member>
27+
<member><methodname>Dom\CharacterData::substringData</methodname></member>
28+
</simplelist>
29+
</refsect1>
30+
31+
</refentry>
32+
<!-- Keep this comment at the end of the file
33+
Local variables:
34+
mode: sgml
35+
sgml-omittag:t
36+
sgml-shorttag:t
37+
sgml-minimize-attributes:nil
38+
sgml-always-quote-attributes:t
39+
sgml-indent-step:1
40+
sgml-indent-data:t
41+
indent-tabs-mode:nil
42+
sgml-parent-document:nil
43+
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
44+
sgml-exposed-tags:nil
45+
sgml-local-catalogs:nil
46+
sgml-local-ecat-files:nil
47+
End:
48+
vim600: syn=xml fen fdm=syntax fdl=2 si
49+
vim: et tw=78 syn=sgml
50+
vi: ts=1 sw=1
51+
-->
Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<refentry xml:id="dom-characterdata.before" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
3+
<refnamediv>
4+
<refname>Dom\CharacterData::before</refname>
5+
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('domcharacterdata.before')/db:refnamediv/db:refpurpose)"/>
6+
</refnamediv>
7+
8+
<refsect1 role="description">
9+
&reftitle.description;
10+
<methodsynopsis role="Dom\\CharacterData">
11+
<modifier>public</modifier> <type>void</type><methodname>Dom\CharacterData::before</methodname>
12+
<methodparam rep="repeat"><type class="union"><type>Dom\Node</type><type>string</type></type><parameter>nodes</parameter></methodparam>
13+
</methodsynopsis>
14+
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('domcharacterdata.before')/db:refsect1[@role='description']/db:para[1])"/>
15+
</refsect1>
16+
17+
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('domchildnode.before')/db:refsect1[@role='parameters'])" />
18+
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('domchildnode.before')/db:refsect1[@role='returnvalues'])" />
19+
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('domchildnode.before')/db:refsect1[@role='errors'])" />
20+
21+
<refsect1 role="examples">
22+
&reftitle.examples;
23+
<example xml:id="dom-characterdata.before.example.basic">
24+
<title><methodname>Dom\CharacterData::before</methodname> example</title>
25+
<para>
26+
Adds nodes before the character data.
27+
</para>
28+
<programlisting role="php">
29+
<![CDATA[
30+
<?php
31+
$doc = Dom\XMLDocument::createFromString("<container><![CDATA[world]]]]><![CDATA[></container>");
32+
$cdata = $doc->documentElement->firstChild;
33+
34+
$cdata->before("hello", $doc->createElement("beautiful"));
35+
36+
echo $doc->saveXML();
37+
?>
38+
]]>
39+
</programlisting>
40+
&example.outputs;
41+
<screen>
42+
<![CDATA[
43+
<?xml version="1.0"?>
44+
<container>hello<beautiful/><![CDATA[world]]]]><![CDATA[></container>
45+
]]>
46+
</screen>
47+
</example>
48+
</refsect1>
49+
50+
<refsect1 role="seealso">
51+
&reftitle.seealso;
52+
<simplelist>
53+
<member><methodname>Dom\ChildNode::before</methodname></member>
54+
<member><methodname>Dom\CharacterData::after</methodname></member>
55+
</simplelist>
56+
</refsect1>
57+
58+
</refentry>
59+
<!-- Keep this comment at the end of the file
60+
Local variables:
61+
mode: sgml
62+
sgml-omittag:t
63+
sgml-shorttag:t
64+
sgml-minimize-attributes:nil
65+
sgml-always-quote-attributes:t
66+
sgml-indent-step:1
67+
sgml-indent-data:t
68+
indent-tabs-mode:nil
69+
sgml-parent-document:nil
70+
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
71+
sgml-exposed-tags:nil
72+
sgml-local-catalogs:nil
73+
sgml-local-ecat-files:nil
74+
End:
75+
vim600: syn=xml fen fdm=syntax fdl=2 si
76+
vim: et tw=78 syn=sgml
77+
vi: ts=1 sw=1
78+
-->
Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<refentry xml:id="dom-characterdata.deletedata" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
3+
<refnamediv>
4+
<refname>Dom\CharacterData::deleteData</refname>
5+
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('domcharacterdata.deletedata')/db:refnamediv/db:refpurpose)"/>
6+
</refnamediv>
7+
8+
<refsect1 role="description">
9+
&reftitle.description;
10+
<methodsynopsis role="Dom\\CharacterData">
11+
<modifier>public</modifier> <type>void</type><methodname>Dom\CharacterData::deleteData</methodname>
12+
<methodparam><type>int</type><parameter>offset</parameter></methodparam>
13+
<methodparam><type>int</type><parameter>count</parameter></methodparam>
14+
</methodsynopsis>
15+
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('domcharacterdata.deletedata')/db:refsect1[@role='description']/db:para[1])"/>
16+
</refsect1>
17+
18+
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('domcharacterdata.deletedata')/db:refsect1[@role='parameters'])" />
19+
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('domcharacterdata.deletedata')/db:refsect1[@role='returnvalues'])" />
20+
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('domcharacterdata.deletedata')/db:refsect1[@role='errors'])" />
21+
22+
<refsect1 role="seealso">
23+
&reftitle.seealso;
24+
<simplelist>
25+
<member><methodname>Dom\CharacterData::appendData</methodname></member>
26+
<member><methodname>Dom\CharacterData::insertData</methodname></member>
27+
<member><methodname>Dom\CharacterData::replaceData</methodname></member>
28+
<member><methodname>Dom\CharacterData::substringData</methodname></member>
29+
</simplelist>
30+
</refsect1>
31+
32+
</refentry>
33+
<!-- Keep this comment at the end of the file
34+
Local variables:
35+
mode: sgml
36+
sgml-omittag:t
37+
sgml-shorttag:t
38+
sgml-minimize-attributes:nil
39+
sgml-always-quote-attributes:t
40+
sgml-indent-step:1
41+
sgml-indent-data:t
42+
indent-tabs-mode:nil
43+
sgml-parent-document:nil
44+
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
45+
sgml-exposed-tags:nil
46+
sgml-local-catalogs:nil
47+
sgml-local-ecat-files:nil
48+
End:
49+
vim600: syn=xml fen fdm=syntax fdl=2 si
50+
vim: et tw=78 syn=sgml
51+
vi: ts=1 sw=1
52+
-->
Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<refentry xml:id="dom-characterdata.insertdata" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
3+
<refnamediv>
4+
<refname>Dom\CharacterData::insertData</refname>
5+
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('domcharacterdata.insertdata')/db:refnamediv/db:refpurpose)"/>
6+
</refnamediv>
7+
8+
<refsect1 role="description">
9+
&reftitle.description;
10+
<methodsynopsis role="Dom\\CharacterData">
11+
<modifier>public</modifier> <type>void</type><methodname>Dom\CharacterData::insertData</methodname>
12+
<methodparam><type>int</type><parameter>offset</parameter></methodparam>
13+
<methodparam><type>string</type><parameter>data</parameter></methodparam>
14+
</methodsynopsis>
15+
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('domcharacterdata.insertdata')/db:refsect1[@role='description']/db:para[1])"/>
16+
</refsect1>
17+
18+
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('domcharacterdata.insertdata')/db:refsect1[@role='parameters'])" />
19+
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('domcharacterdata.insertdata')/db:refsect1[@role='returnvalues'])" />
20+
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('domcharacterdata.insertdata')/db:refsect1[@role='errors'])" />
21+
22+
<refsect1 role="seealso">
23+
&reftitle.seealso;
24+
<simplelist>
25+
<member><methodname>Dom\CharacterData::appendData</methodname></member>
26+
<member><methodname>Dom\CharacterData::deleteData</methodname></member>
27+
<member><methodname>Dom\CharacterData::replaceData</methodname></member>
28+
<member><methodname>Dom\CharacterData::substringData</methodname></member>
29+
</simplelist>
30+
</refsect1>
31+
32+
</refentry>
33+
<!-- Keep this comment at the end of the file
34+
Local variables:
35+
mode: sgml
36+
sgml-omittag:t
37+
sgml-shorttag:t
38+
sgml-minimize-attributes:nil
39+
sgml-always-quote-attributes:t
40+
sgml-indent-step:1
41+
sgml-indent-data:t
42+
indent-tabs-mode:nil
43+
sgml-parent-document:nil
44+
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
45+
sgml-exposed-tags:nil
46+
sgml-local-catalogs:nil
47+
sgml-local-ecat-files:nil
48+
End:
49+
vim600: syn=xml fen fdm=syntax fdl=2 si
50+
vim: et tw=78 syn=sgml
51+
vi: ts=1 sw=1
52+
-->
Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<refentry xml:id="dom-characterdata.remove" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
3+
<refnamediv>
4+
<refname>Dom\CharacterData::remove</refname>
5+
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('domcharacterdata.remove')/db:refnamediv/db:refpurpose)"/>
6+
</refnamediv>
7+
8+
<refsect1 role="description">
9+
&reftitle.description;
10+
<methodsynopsis role="Dom\\CharacterData">
11+
<modifier>public</modifier> <type>void</type><methodname>Dom\CharacterData::remove</methodname>
12+
<void/>
13+
</methodsynopsis>
14+
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('domcharacterdata.remove')/db:refsect1[@role='description']/db:para[1])"/>
15+
</refsect1>
16+
17+
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('domchildnode.remove')/db:refsect1[@role='parameters'])" />
18+
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('domchildnode.remove')/db:refsect1[@role='returnvalues'])" />
19+
20+
<refsect1 role="examples">
21+
&reftitle.examples;
22+
<example xml:id="dom-characterdata.remove.example.basic">
23+
<title><methodname>Dom\CharacterData::remove</methodname> example</title>
24+
<para>
25+
Removes the character data.
26+
</para>
27+
<programlisting role="php">
28+
<![CDATA[
29+
<?php
30+
$doc = Dom\XMLDocument::createFromString("<container><![CDATA[hello]]]]><![CDATA[><world/></container>");
31+
$cdata = $doc->documentElement->firstChild;
32+
33+
$cdata->remove();
34+
35+
echo $doc->saveXML();
36+
?>
37+
]]>
38+
</programlisting>
39+
&example.outputs;
40+
<screen>
41+
<![CDATA[
42+
<?xml version="1.0"?>
43+
<container><world/></container>
44+
]]>
45+
</screen>
46+
</example>
47+
</refsect1>
48+
49+
<refsect1 role="seealso">
50+
&reftitle.seealso;
51+
<simplelist>
52+
<member><methodname>Dom\ChildNode::remove</methodname></member>
53+
<member><methodname>Dom\CharacterData::after</methodname></member>
54+
<member><methodname>Dom\CharacterData::before</methodname></member>
55+
<member><methodname>Dom\CharacterData::replaceWith</methodname></member>
56+
<member><methodname>Dom\Node::removeChild</methodname></member>
57+
</simplelist>
58+
</refsect1>
59+
60+
</refentry>
61+
<!-- Keep this comment at the end of the file
62+
Local variables:
63+
mode: sgml
64+
sgml-omittag:t
65+
sgml-shorttag:t
66+
sgml-minimize-attributes:nil
67+
sgml-always-quote-attributes:t
68+
sgml-indent-step:1
69+
sgml-indent-data:t
70+
indent-tabs-mode:nil
71+
sgml-parent-document:nil
72+
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
73+
sgml-exposed-tags:nil
74+
sgml-local-catalogs:nil
75+
sgml-local-ecat-files:nil
76+
End:
77+
vim600: syn=xml fen fdm=syntax fdl=2 si
78+
vim: et tw=78 syn=sgml
79+
vi: ts=1 sw=1
80+
-->

0 commit comments

Comments
 (0)