Skip to content

[PHP 8.3] New DOM methods #2922

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Girgias merged 6 commits into from
Nov 7, 2023
Merged

[PHP 8.3] New DOM methods #2922

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
cfe1f23
[PHP 8.3] New DOM methods
saundefined Nov 6, 2023
559f470
Apply suggestions from code review
saundefined Nov 6, 2023
f27e338
Apply suggestions from code review
saundefined Nov 6, 2023
56196bf
Apply suggestions from code review
saundefined Nov 7, 2023
3f31db4
Update reference/dom/domnode/getrootnode.xml
saundefined Nov 7, 2023
6424f3d
Apply suggestions from code review
saundefined Nov 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 80 additions & 0 deletions reference/dom/domelement/getattributenames.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
<?xml version="1.0" encoding="utf-8"?>
<refentry xml:id="domelement.getattributenames" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>DOMElement::getAttributeNames</refname>
<refpurpose>Get attribute names</refpurpose>
</refnamediv>

<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="DOMElement">
<modifier>public</modifier> <type>array</type><methodname>DOMElement::getAttributeNames</methodname>
<void/>
</methodsynopsis>
<para>
Get attribute names.
</para>
</refsect1>

<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Return attribute names.
</para>
</refsect1>

<refsect1 role="examples">
&reftitle.examples;
<example>
<title><methodname>DOMElement::getAttributeNames</methodname> example</title>
<programlisting role="php">
<![CDATA[
<?php

$dom = new DOMDocument();
$dom->loadXML('<html xmlns:some="some:ns" some:test="a" test2="b"/>');
var_dump($dom->documentElement->getAttributeNames());
?>
]]>
</programlisting>
</example>
&example.outputs;
<screen>
<![CDATA[
array(3) {
[0]=>
string(10) "xmlns:some"
[1]=>
string(9) "some:test"
[2]=>
string(5) "test2"
}
]]>
</screen>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
112 changes: 112 additions & 0 deletions reference/dom/domelement/insertadjacentelement.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
<?xml version="1.0" encoding="utf-8"?>
<refentry xml:id="domelement.insertadjacentelement" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>DOMElement::insertAdjacentElement</refname>
<refpurpose>Insert adjacent element</refpurpose>
</refnamediv>

<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="DOMElement">
<modifier>public</modifier> <type class="union"><type>DOMElement</type><type>null</type></type><methodname>DOMElement::insertAdjacentElement</methodname>
<methodparam><type>string</type><parameter>where</parameter></methodparam>
<methodparam><type>DOMElement</type><parameter>element</parameter></methodparam>
</methodsynopsis>
<para>
Inserts an element at a relative position given by <parameter>where</parameter>.
</para>
</refsect1>

<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>where</parameter></term>
<listitem>
<para>
<simplelist>
<member><literal>beforebegin</literal> - Insert before the target element.</member>
<member><literal>afterbegin</literal> - Insert as the first child of the target element.</member>
<member><literal>beforeend</literal> - Insert as the last child of the target element.</member>
<member><literal>afterend</literal> - Insert after the target element.</member>
</simplelist>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>element</parameter></term>
<listitem>
<para>
The element to insert.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Return <classname>DOMElement</classname> or &null; on failure.
</para>
</refsect1>

<refsect1 role="examples">
&reftitle.examples;
<example>
<title><methodname>DOMElement::insertAdjacentElement</methodname> example</title>
<programlisting role="php">
<![CDATA[
<?php

$dom = new DOMDocument();
$dom->loadXML('<?xml version="1.0"?><container><p>foo</p></container>');
$container = $dom->documentElement;
$p = $container->firstElementChild;

$p->insertAdjacentElement('beforebegin', $dom->createElement('A'));
echo $dom->saveXML();
?>
]]>
</programlisting>
</example>
&example.outputs;
<screen>
<![CDATA[
<?xml version="1.0"?>
<container><A/><p>foo</p></container>
]]>
</screen>
</refsect1>

<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>DOMElement::insertAdjacentText</methodname></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
115 changes: 115 additions & 0 deletions reference/dom/domelement/insertadjacenttext.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
<?xml version="1.0" encoding="utf-8"?>
<refentry xml:id="domelement.insertadjacenttext" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>DOMElement::insertAdjacentText</refname>
<refpurpose>Insert adjacent text</refpurpose>
</refnamediv>

<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="DOMElement">
<modifier>public</modifier> <type>void</type><methodname>DOMElement::insertAdjacentText</methodname>
<methodparam><type>string</type><parameter>where</parameter></methodparam>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
</methodsynopsis>
<para>
Inserts text at a relative position given by <parameter>where</parameter>.
</para>
</refsect1>

<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>where</parameter></term>
<listitem>
<para>
<simplelist>
<member><literal>beforebegin</literal> - Insert before the target element.</member>
<member><literal>afterbegin</literal> - Insert as the first child of the target element.</member>
<member><literal>beforeend</literal> - Insert as the last child of the target element.</member>
<member><literal>afterend</literal> - Insert after the target element.</member>
</simplelist>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
The string to insert.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>

<refsect1 role="examples">
&reftitle.examples;
<example>
<title><methodname>DOMElement::insertAdjacentText</methodname> example</title>
<programlisting role="php">
<![CDATA[
<?php

$dom = new DOMDocument();
$dom->loadXML('<?xml version="1.0"?><container><p>H</p></container>');

$container = $dom->documentElement;
$p = $container->firstElementChild;

$p->insertAdjacentText("afterbegin", "P");
$p->insertAdjacentText("beforeend", "P");

echo $dom->saveXML();
?>
]]>
</programlisting>
</example>
&example.outputs;
<screen>
<![CDATA[
<?xml version="1.0"?>
<container><p>PHP</p></container>
]]>
</screen>
</refsect1>

<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>DOMElement::insertAdjacentElement</methodname></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
Loading