sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-16 00:48:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

SXE class/method synopsis improvements, lowercase xml:ids

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@305704 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Peter Cowburn 2010-11-23 23:21:32 +00:00
parent 4b5aa71aaf
commit e551bed23b
14 changed files with 69 additions and 100 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
reference/simplexml/simplexmlelement.xml
View file

@ -35,6 +35,7 @@
<!-- }}} -->
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.simplexmlelement')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[1])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.simplexmlelement')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
</classsynopsis>
<!-- }}} -->

17
reference/simplexml/simplexmlelement/addAttribute.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id='simplexmlelement.addAttribute' xmlns="http://docbook.org/ns/docbook">
<refentry xml:id="simplexmlelement.addattribute" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>SimpleXMLElement::addAttribute</refname>
<refpurpose>
@ -9,15 +9,12 @@
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>SimpleXMLElement</classname></ooclass>
<methodsynopsis>
<type>void</type><methodname>addAttribute</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam><type>string</type><parameter>value</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>namespace</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>SimpleXMLElement::addAttribute</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam><type>string</type><parameter>value</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>namespace</parameter></methodparam>
</methodsynopsis>
<para>
Adds an attribute to the SimpleXML element.
</para>

17
reference/simplexml/simplexmlelement/addChild.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id='simplexmlelement.addChild' xmlns="http://docbook.org/ns/docbook">
<refentry xml:id="simplexmlelement.addchild" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>SimpleXMLElement::addChild</refname>
<refpurpose>
@ -9,15 +9,12 @@
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>SimpleXMLElement</classname></ooclass>
<methodsynopsis>
<type>SimpleXMLElement</type><methodname>addChild</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>value</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>namespace</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<modifier>public</modifier> <type>SimpleXMLElement</type><methodname>SimpleXMLElement::addChild</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>value</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>namespace</parameter></methodparam>
</methodsynopsis>
<para>
Adds a child element to the node and returns a SimpleXMLElement of the child.
</para>

13
reference/simplexml/simplexmlelement/asXML.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id='simplexmlelement.asXML' xmlns="http://docbook.org/ns/docbook">
<refentry xml:id="simplexmlelement.asxml" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>SimpleXMLElement::asXML</refname>
<refpurpose>
@ -9,13 +9,10 @@
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>SimpleXMLElement</classname></ooclass>
<methodsynopsis>
<type>mixed</type><methodname>asXML</methodname>
<methodparam choice="opt"><type>string</type><parameter>filename</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<modifier>public</modifier> <type>mixed</type><methodname>SimpleXMLElement::asXML</methodname>
<methodparam choice="opt"><type>string</type><parameter>filename</parameter></methodparam>
</methodsynopsis>
<para>
The <literal>asXML</literal> method formats the parent object's data
in XML version 1.0.

15
reference/simplexml/simplexmlelement/attributes.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id='simplexmlelement.attributes' xmlns="http://docbook.org/ns/docbook">
<refentry xml:id="simplexmlelement.attributes" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>SimpleXMLElement::attributes</refname>
<refpurpose>Identifies an element's attributes</refpurpose>
@ -8,14 +8,11 @@
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>SimpleXMLElement</classname></ooclass>
<methodsynopsis>
<type>SimpleXMLElement</type><methodname>attributes</methodname>
<methodparam choice="opt"><type>string</type><parameter>ns</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>is_prefix</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<modifier>public</modifier> <type>SimpleXMLElement</type><methodname>SimpleXMLElement::attributes</methodname>
<methodparam choice="opt"><type>string</type><parameter>ns</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>is_prefix</parameter><initializer>false</initializer></methodparam>
</methodsynopsis>
<para>
This function provides the attributes and values defined within an xml tag.
</para>

15
reference/simplexml/simplexmlelement/children.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id='simplexmlelement.children' xmlns="http://docbook.org/ns/docbook">
<refentry xml:id="simplexmlelement.children" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>SimpleXMLElement::children</refname>
<refpurpose>Finds children of given node</refpurpose>
@ -8,14 +8,11 @@
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>SimpleXMLElement</classname></ooclass>
<methodsynopsis>
<type>SimpleXMLElement</type><methodname>children</methodname>
<methodparam choice="opt"><type>string</type><parameter>ns</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>is_prefix</parameter><initializer>false</initializer></methodparam>
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<modifier>public</modifier> <type>SimpleXMLElement</type><methodname>SimpleXMLElement::children</methodname>
<methodparam choice="opt"><type>string</type><parameter>ns</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>is_prefix</parameter><initializer>false</initializer></methodparam>
</methodsynopsis>
<para>
This method finds the children of an element. The result follows normal
iteration rules.

21
reference/simplexml/simplexmlelement/construct.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id='simplexmlelement.construct' xmlns="http://docbook.org/ns/docbook">
<refentry xml:id="simplexmlelement.construct" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>SimpleXMLElement::__construct</refname>
<refpurpose>
@ -9,17 +9,14 @@
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>SimpleXMLElement</classname></ooclass>
<constructorsynopsis>
<methodname>__construct</methodname>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>options</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>data_is_url</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>ns</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>is_prefix</parameter></methodparam>
</constructorsynopsis>
</classsynopsis>
<constructorsynopsis>
<modifier>public</modifier> <methodname>SimpleXMLElement::__construct</methodname>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>data_is_url</parameter><initializer>false</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>ns</parameter><initializer>""</initializer></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>is_prefix</parameter><initializer>false</initializer></methodparam>
</constructorsynopsis>
<para>
Creates a new <classname>SimpleXMLElement</classname> object.
</para>

2
reference/simplexml/simplexmlelement/count.xml
View file

@ -10,7 +10,7 @@
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>integer</type><methodname>SimpleXMLElement::count</methodname>
<modifier>public</modifier> <type>integer</type><methodname>SimpleXMLElement::count</methodname>
<void />
</methodsynopsis>
<para>

13
reference/simplexml/simplexmlelement/getDocNamespaces.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id='simplexmlelement.getDocNamespaces' xmlns="http://docbook.org/ns/docbook">
<refentry xml:id="simplexmlelement.getdocnamespaces" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>SimpleXMLElement::getDocNamespaces</refname>
<refpurpose>
@ -9,13 +9,10 @@
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>SimpleXMLElement</classname></ooclass>
<methodsynopsis>
<type>array</type><methodname>getDocNamespaces</methodname>
<methodparam choice="opt"><type>bool</type><parameter>recursive</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<modifier>public</modifier> <type>array</type><methodname>SimpleXMLElement::getDocNamespaces</methodname>
<methodparam choice="opt"><type>bool</type><parameter>recursive</parameter><initializer>false</initializer></methodparam>
</methodsynopsis>
<para>
Returns namespaces declared in document
</para>

13
reference/simplexml/simplexmlelement/getName.xml
View file

@ -1,19 +1,16 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id='simplexmlelement.getName' xmlns="http://docbook.org/ns/docbook">
<refentry xml:id="simplexmlelement.getname" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>SimpleXMLElement::getName</refname>
<refpurpose>Gets the name of the XML element</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>SimpleXMLElement</classname></ooclass>
<methodsynopsis>
<type>string</type><methodname>getName</methodname>
<void/>
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>SimpleXMLElement::getName</methodname>
<void/>
</methodsynopsis>
<para>
Gets the name of the XML element.
</para>

13
reference/simplexml/simplexmlelement/getNamespaces.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id='simplexmlelement.getNamespaces' xmlns="http://docbook.org/ns/docbook">
<refentry xml:id="simplexmlelement.getnamespaces" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>SimpleXMLElement::getNamespaces</refname>
<refpurpose>
@ -9,13 +9,10 @@
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>SimpleXMLElement</classname></ooclass>
<methodsynopsis>
<type>array</type><methodname>getNamespaces</methodname>
<methodparam choice="opt"><type>bool</type><parameter>recursive</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<modifier>public</modifier> <type>array</type><methodname>SimpleXMLElement::getNamespaces</methodname>
<methodparam choice="opt"><type>bool</type><parameter>recursive</parameter><initializer>false</initializer></methodparam>
</methodsynopsis>
<para>
Returns namespaces used in document
</para>

15
reference/simplexml/simplexmlelement/registerXPathNamespace.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id='simplexmlelement.registerXPathNamespace' xmlns="http://docbook.org/ns/docbook">
<refentry xml:id="simplexmlelement.registerxpathnamespace" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>SimpleXMLElement::registerXPathNamespace</refname>
<refpurpose>
@ -9,14 +9,11 @@
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>SimpleXMLElement</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>registerXPathNamespace</methodname>
<methodparam><type>string</type><parameter>prefix</parameter></methodparam>
<methodparam><type>string</type><parameter>ns</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>SimpleXMLElement::registerXPathNamespace</methodname>
<methodparam><type>string</type><parameter>prefix</parameter></methodparam>
<methodparam><type>string</type><parameter>ns</parameter></methodparam>
</methodsynopsis>
<para>
Creates a prefix/ns context for the next XPath query. In particular, this is
helpful if the provider of the given XML document alters the namespace

13
reference/simplexml/simplexmlelement/xpath.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id='simplexmlelement.xpath' xmlns="http://docbook.org/ns/docbook">
<refentry xml:id="simplexmlelement.xpath" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>SimpleXMLElement::xpath</refname>
<refpurpose>Runs XPath query on XML data</refpurpose>
@ -8,13 +8,10 @@
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>SimpleXMLElement</classname></ooclass>
<methodsynopsis>
<type>array</type><methodname>xpath</methodname>
<methodparam><type>string</type><parameter>path</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<methodsynopsis>
<modifier>public</modifier> <type>array</type><methodname>SimpleXMLElement::xpath</methodname>
<methodparam><type>string</type><parameter>path</parameter></methodparam>
</methodsynopsis>
<para>
The <literal>xpath</literal> method searches the SimpleXML node for
children matching the <acronym>XPath</acronym> <parameter>path</parameter>.

1
reference/simplexml/versions.xml
View file

@ -19,6 +19,7 @@
<function name='simplexmlelement::getname' from='PHP 5 &gt;= 5.1.3'/>
<function name='simplexmlelement::getnamespaces' from='PHP 5 &gt;= 5.1.2'/>
<function name='simplexmlelement::registerxpathnamespace' from='PHP 5 &gt;= 5.2.0'/>
<function name='simplexmlelement::savexml' from='PHP 5 &gt;= 5.2.0'/>
<function name='simplexmlelement::xpath' from='PHP 5 &gt;= 5.2.0'/>
<function name='simplexmliterator::count' from='PHP 5 &gt;= 5.1.3'/>