mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-31 08:18:56 +00:00
44d5d33cee
Based on a patch contributed by Máté Kocsis <kocsismate@woohoolabs.com>. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@351471 c90b9560-bf6c-de11-be94-00142212c4b1
138 lines
3.3 KiB
XML
138 lines
3.3 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-cdata" xmlns="http://docbook.org/ns/docbook">
|
||
<refnamediv>
|
||
<refname>XMLWriter::writeCdata</refname>
|
||
<refname>xmlwriter_write_cdata</refname>
|
||
<refpurpose>Write full CDATA tag</refpurpose>
|
||
</refnamediv>
|
||
<refsect1 role="description">
|
||
&reftitle.description;
|
||
<para>&style.oop;</para>
|
||
<methodsynopsis role="oop">
|
||
<modifier>public</modifier> <type>bool</type><methodname>XMLWriter::writeCdata</methodname>
|
||
<methodparam><type>string</type><parameter>content</parameter></methodparam>
|
||
</methodsynopsis>
|
||
<para>&style.procedural;</para>
|
||
<methodsynopsis role="procedural">
|
||
<type>bool</type><methodname>xmlwriter_write_cdata</methodname>
|
||
<methodparam><type>XMLWriter</type><parameter>writer</parameter></methodparam>
|
||
<methodparam><type>string</type><parameter>content</parameter></methodparam>
|
||
</methodsynopsis>
|
||
<para>
|
||
Writes a full CDATA.
|
||
</para>
|
||
</refsect1>
|
||
<refsect1 role="parameters">
|
||
&reftitle.parameters;
|
||
<para>
|
||
<variablelist>
|
||
&xmlwriter.xmlwriter.description;
|
||
<varlistentry>
|
||
<term><parameter>content</parameter></term>
|
||
<listitem>
|
||
<para>
|
||
The contents of the CDATA.
|
||
</para>
|
||
</listitem>
|
||
</varlistentry>
|
||
</variablelist>
|
||
</para>
|
||
</refsect1>
|
||
|
||
<refsect1 role="returnvalues">
|
||
&reftitle.returnvalues;
|
||
<para>
|
||
&return.success;
|
||
</para>
|
||
</refsect1>
|
||
|
||
<refsect1 role="changelog">
|
||
&reftitle.changelog;
|
||
<informaltable>
|
||
<tgroup cols="2">
|
||
<thead>
|
||
<row>
|
||
<entry>&Version;</entry>
|
||
<entry>&Description;</entry>
|
||
</row>
|
||
</thead>
|
||
<tbody>
|
||
&xmlwriter.changelog.writer-param;
|
||
</tbody>
|
||
</tgroup>
|
||
</informaltable>
|
||
</refsect1>
|
||
|
||
<refsect1 role="examples">
|
||
&reftitle.examples;
|
||
<example xml:id="xmlwriter-write-cdata.example.basic">
|
||
<title>Basic <function>xmlwriter_write_cdata</function> Usage</title>
|
||
<programlisting role="php">
|
||
<![CDATA[
|
||
<?php
|
||
// set up the document
|
||
$xml = new XmlWriter();
|
||
$xml->openMemory();
|
||
$xml->setIndent(true);
|
||
$xml->startDocument('1.0', 'UTF-8');
|
||
$xml->startElement('mydoc');
|
||
$xml->startElement('myele');
|
||
|
||
// CData output
|
||
$xml->startElement('mycdataelement');
|
||
$xml->writeCData("text for inclusion as CData");
|
||
$xml->endElement();
|
||
|
||
// end the document and output
|
||
$xml->endElement();
|
||
$xml->endElement();
|
||
echo $xml->outputMemory(true);
|
||
?>
|
||
]]>
|
||
</programlisting>
|
||
&example.outputs;
|
||
<screen>
|
||
<![CDATA[
|
||
<mydoc>
|
||
<myele>
|
||
<mycdataelement><![CDATA[text for inclusion as CData]]></mycdataelement>
|
||
</myele>
|
||
</mydoc>
|
||
]]>
|
||
</screen>
|
||
</example>
|
||
</refsect1>
|
||
|
||
<refsect1 role="seealso">
|
||
&reftitle.seealso;
|
||
<para>
|
||
<simplelist>
|
||
<member><methodname>XMLWriter::startCdata</methodname></member>
|
||
<member><methodname>XMLWriter::endCdata</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
|
||
-->
|