Add DOMAttribute->setèvalue() docs

Switch the other DOMAttribute methods to the new structure
Added documentation, pointers and tips to switch to php5 ext/dom


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@188243 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Mehdi Achour 2005-06-12 21:09:55 +00:00
parent a50a655ee0
commit 41a7e04069
4 changed files with 176 additions and 23 deletions

View file

@ -1,23 +1,44 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<!-- $Revision: 1.9 $ -->
<refentry id='function.domattribute-name'>
<refnamediv>
<refname>DomAttribute->name</refname>
<refpurpose>
Returns name of attribute
Returns the name of attribute
</refpurpose>
</refnamediv>
<refsect1>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>DomAttribute->name</methodname>
<void/>
</methodsynopsis>
<classsynopsis>
<ooclass><classname>DomAttribute</classname></ooclass>
<methodsynopsis>
<type>string</type><methodname>name</methodname>
<void/>
</methodsynopsis>
</classsynopsis>
<para>
This function returns the name of the attribute.
Gets the name of the attribute.
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
See also <function>domattribute_value</function> for an example.
Returns the name of the attribute.
</para>
</refsect1>
<refsect1 role="migration">
<title>Migrating to PHP 5</title>
<para>
Use the <property>name</property> property of
<classname>DOMAttr</classname>.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="function.domattribute-value" /> for an example</member>
</simplelist>
</para>
</refsect1>
</refentry>

View file

@ -0,0 +1,80 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id='function.domattribute-set-value'>
<refnamediv>
<refname>DomAttribute->set_value</refname>
<refpurpose>
Sets the value of an attribute
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>DomAttribute</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>set_value</methodname>
<methodparam><type>string</type><parameter>content</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
<para>
This function sets the value of an attribute.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>content</parameter></term>
<listitem>
<para>
The new value.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="migration">
<title>Migrating to PHP 5</title>
<para>
Set the <property>value</property> property of
<classname>DOMAttr</classname>.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="function.domattribute-value" /></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
-->

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry id='function.domattribute-specified'>
<refnamediv>
<refname>DomAttribute->specified</refname>
@ -7,14 +7,41 @@
Checks if attribute is specified
</refpurpose>
</refnamediv>
<refsect1>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>DomAttribute->specified</methodname>
<void/>
</methodsynopsis>
<classsynopsis>
<ooclass><classname>DomAttribute</classname></ooclass>
<methodsynopsis>
<type>bool</type><methodname>specified</methodname>
<void/>
</methodsynopsis>
</classsynopsis>
<para>
Check DOM standard for a detailed explanation.
Checks if the attribute was explicitly given a value in the original
document.
</para>
<note>
<para>
This method is not implemented yet.
</para>
</note>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member>
The definition of <ulink
url="&url.dom1.attribute-specified;">specified</ulink> in the DOM
Recommendations
</member>
</simplelist>
</para>
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<!-- $Revision: 1.9 $ -->
<refentry id='function.domattribute-value'>
<refnamediv>
<refname>DomAttribute->value</refname>
@ -7,15 +7,21 @@
Returns value of attribute
</refpurpose>
</refnamediv>
<refsect1>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>DomAttribute->value</methodname>
<void/>
</methodsynopsis>
<classsynopsis>
<ooclass><classname>DomAttribute</classname></ooclass>
<methodsynopsis>
<type>string</type><methodname>value</methodname>
<void/>
</methodsynopsis>
</classsynopsis>
<para>
This function returns the value of the attribute.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Getting all the attributes of a node</title>
@ -50,8 +56,27 @@ Attributes of chapter
</screen>
</example>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
See also <function>domattribute_name</function>.
Returns the value of the attribute.
</para>
</refsect1>
<refsect1 role="migration">
<title>Migrating to PHP 5</title>
<para>
Use the <property>value</property> property of
<classname>DOMAttr</classname>.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><xref linkend="function.domattribute-set-value" /></member>
<member><xref linkend="function.domattribute-name" /></member>
</simplelist>
</para>
</refsect1>
</refentry>