1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108
|
<?xml version="1.0" encoding="utf-8"?>
<refentry xml:id="domelement.toggleattribute" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>DOMElement::toggleAttribute</refname>
<refpurpose>Toggle attribute</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="DOMElement">
<modifier>public</modifier> <type>bool</type><methodname>DOMElement::toggleAttribute</methodname>
<methodparam><type>string</type><parameter>qualifiedName</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>bool</type><type>null</type></type><parameter>force</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Toggle the attribute.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>qualifiedName</parameter></term>
<listitem>
<para>
The qualified name of the attribute.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>force</parameter></term>
<listitem>
<para>
<simplelist>
<member>if &null;, the function will toggle the attribute.</member>
<member>if &true;, the function adds the attribute.</member>
<member>if &false;, the function removes the attribute.</member>
</simplelist>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &true; if the attribute is present after finishing the call, &false; otherwise.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title><methodname>DOMElement::toggleAttribute</methodname> example</title>
<programlisting role="php">
<![CDATA[
<?php
$dom = new DOMDocument();
$dom->loadXML("<?xml version='1.0'?><container selected=\"\"/>");
var_dump($dom->documentElement->toggleAttribute('selected'));
echo $dom->saveXML() . PHP_EOL;
var_dump($dom->documentElement->toggleAttribute('selected'));
echo $dom->saveXML();
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
bool(false)
<?xml version="1.0"?>
<container/>
bool(true)
<?xml version="1.0"?>
<container selected=""/>
]]>
</screen>
</example>
</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
-->
|