mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-16 00:48:54 +00:00
Added DOMXPath::registerPhpFunctions (file added this time)
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@289913 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Peter Cowburn
parent
b215575c11
commit
6bd06c94db
1 changed files with 194 additions and 0 deletions
194
reference/dom/domxpath/registerphpfunctions.xml
Normal file
194
reference/dom/domxpath/registerphpfunctions.xml
Normal file
|
|
@ -0,0 +1,194 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision: $ -->
|
||||
|
||||
<refentry xml:id="domxpath.registerphpfunctions" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
<refname>DOMXPath::registerPhpFunctions</refname>
|
||||
<refpurpose>Register PHP functions as XPath functions</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<modifier>public</modifier> <type>void</type><methodname>DOMXPath::registerPhpFunctions</methodname>
|
||||
<methodparam choice="opt"><type>mixed</type><parameter>restrict</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
This method enables the ability to use PHP functions within XPath expressions.
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>restrict</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Use this parameter to only allow certain functions to be called from XPath.
|
||||
</para>
|
||||
<para>
|
||||
This parameter can be either a <type>string</type> (a function name) or
|
||||
an <type>array</type> of function names.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
&return.void;
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="examples">
|
||||
&reftitle.examples;
|
||||
<para>
|
||||
The following examples use <filename>book.xml</filename> which contains the following:
|
||||
</para>
|
||||
<para>
|
||||
<example>
|
||||
<title>book.xml</title>
|
||||
<programlisting role="xml">
|
||||
<![CDATA[
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<books>
|
||||
<book>
|
||||
<title>PHP Basics</title>
|
||||
<author>Jim Smith</author>
|
||||
<author>Jane Smith</author>
|
||||
</book>
|
||||
<book>
|
||||
<title>PHP Secrets</title>
|
||||
<author>Jenny Smythe</author>
|
||||
</book>
|
||||
<book>
|
||||
<title>XML basics</title>
|
||||
<author>Joe Black</author>
|
||||
</book>
|
||||
</books>
|
||||
]]>
|
||||
</programlisting>
|
||||
</example>
|
||||
</para>
|
||||
<para>
|
||||
<example>
|
||||
<title><methodname>DOMXPath::registerPHPFunctions</methodname> with <literal>php:functionString</literal></title>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
$doc = new DOMDocument;
|
||||
$doc->load('book.xml');
|
||||
|
||||
$xpath = new DOMXPath($doc);
|
||||
|
||||
// Register the php: namespace (required)
|
||||
$xpath->registerNamespace("php", "http://php.net/xpath");
|
||||
|
||||
// Register PHP functions (no restrictions)
|
||||
$xpath->registerPHPFunctions();
|
||||
|
||||
// Call substr function on the book title
|
||||
$nodes = $xpath->query('//book[php:functionString("substr", title, 0, 3) = "PHP"]');
|
||||
|
||||
echo "Found {$nodes->length} books starting with 'PHP':\n";
|
||||
foreach ($nodes as $node) {
|
||||
$title = $node->getElementsByTagName("title")->item(0)->nodeValue;
|
||||
$author = $node->getElementsByTagName("author")->item(0)->nodeValue;
|
||||
echo "$title by $author\n";
|
||||
}
|
||||
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
&example.outputs.similar;
|
||||
<screen>
|
||||
<![CDATA[
|
||||
Found 2 books starting with 'PHP':
|
||||
PHP Basics by Jim Smith
|
||||
PHP Secrets by Jenny Smythe
|
||||
]]>
|
||||
</screen>
|
||||
</example>
|
||||
</para>
|
||||
<para>
|
||||
<example>
|
||||
<title><methodname>DOMXPath::registerPHPFunctions</methodname> with <literal>php:function</literal></title>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
$doc = new DOMDocument;
|
||||
$doc->load('book.xml');
|
||||
|
||||
$xpath = new DOMXPath($doc);
|
||||
|
||||
// Register the php: namespace (required)
|
||||
$xpath->registerNamespace("php", "http://php.net/xpath");
|
||||
|
||||
// Register PHP functions (has_multiple only)
|
||||
$xpath->registerPHPFunctions("has_multiple");
|
||||
|
||||
function has_multiple($nodes) {
|
||||
// Return true if more than one author
|
||||
return count($nodes) > 1;
|
||||
}
|
||||
// Filter books with multiple authors
|
||||
$books = $xpath->query('//book[php:function("has_multiple", author)]');
|
||||
|
||||
echo "Books with multiple authors:\n";
|
||||
foreach ($books as $book) {
|
||||
echo $book->getElementsByTagName("title")->item(0)->nodeValue . "\n";
|
||||
}
|
||||
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
&example.outputs.similar;
|
||||
<screen>
|
||||
<![CDATA[
|
||||
Books with multiple authors:
|
||||
PHP Basics
|
||||
]]>
|
||||
</screen>
|
||||
</example>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><methodname>DOMXPath::registerNamespace</methodname></member>
|
||||
<member><methodname>DOMXPath::query</methodname></member>
|
||||
<member><methodname>DOMXPath::evaluate</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:"../../../../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…
Reference in a new issue