php-doc-en/reference/xmlwriter/functions/xmlwriter-write-attribute.xml
Christoph Michael Becker 2716a63905 Add example for intermixing sub-elements and attributes
This integrates user notes 103498 and 119937.


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@350605 c90b9560-bf6c-de11-be94-00142212c4b1
2020-09-20 16:39:23 +00:00

129 lines
3.4 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
<refentry xml:id="function.xmlwriter-write-attribute" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>XMLWriter::writeAttribute</refname>
<refname>xmlwriter_write_attribute</refname>
<refpurpose>Write full attribute</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>&style.oop;</para>
<methodsynopsis>
<type>bool</type><methodname>XMLWriter::writeAttribute</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam><type>string</type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>&style.procedural;</para>
<methodsynopsis>
<type>bool</type><methodname>xmlwriter_write_attribute</methodname>
<methodparam><type>resource</type><parameter>xmlwriter</parameter></methodparam>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam><type>string</type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>
Writes a full attribute.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&xmlwriter.xmlwriter.description;
<varlistentry>
<term><parameter>name</parameter></term>
<listitem>
<para>
The name of the attribute.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>value</parameter></term>
<listitem>
<para>
The value of the attribute.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example xml:id="xmlwriter-write-attribute.example.intermix">
<title>Intermixing Sub-elements and Attributes</title>
<para>
If writing sub-elements and attributes is intermixed, any attempt to write
attributes after the first sub-element will fail and return false.
</para>
<programlisting role="php">
<![CDATA[
<?php
$xml = new XMLWriter();
$xml->openMemory();
$xml->startElement('element');
$xml->writeAttribute('attr1', '0');
$xml->writeElement('subelem', '0');
var_dump($xml->writeAttribute('attr2', '0'));
$xml->endElement();
echo $xml->flush();
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
bool(false)
<element attr1="0"><subelem>0</subelem></element>
]]>
</screen>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>XMLWriter::writeAttributeNs</methodname></member>
<member><methodname>XMLWriter::startAttribute</methodname></member>
<member><methodname>XMLWriter::startAttributeNs</methodname></member>
<member><methodname>XMLWriter::endAttribute</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
-->