mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-20 02:48:56 +00:00
af4410a7e1
still using this, after discussion on the phpdoc list. From now on, manual.ced will need to be found at ~/.phpdoc/manual.ced. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@288721 c90b9560-bf6c-de11-be94-00142212c4b1
148 lines
3.9 KiB
XML
148 lines
3.9 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.bbcode-add-smiley" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>bbcode_add_smiley</refname>
|
|
<refpurpose>Adds a smiley to the parser</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>bbcode_add_smiley</methodname>
|
|
<methodparam><type>resource</type><parameter>bbcode_container</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>smiley</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>replace_by</parameter></methodparam>
|
|
</methodsynopsis>
|
|
|
|
<para>
|
|
Adds a smiley to the parser
|
|
</para>
|
|
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>bbcode_container</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
BBCode_Container resource, returned by <function>bbcode_create</function>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>smiley</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The string that will be replaced when found.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>replace_by</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The string that replace smiley when found.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
&return.success;
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>bbcode_add_smiley</function> usage example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
/*
|
|
* Prepare the rule set
|
|
*/
|
|
$arrayBBCode=array(
|
|
''=> array('type'=>BBCODE_TYPE_ROOT,
|
|
'childs'=>'!i'),
|
|
'b'=> array('type'=>BBCODE_TYPE_NOARG,
|
|
'open_tag'=>'<b>',
|
|
'close_tag'=>'</b>'),
|
|
'u'=> array('type'=>BBCODE_TYPE_NOARG,
|
|
'open_tag'=>'<u>',
|
|
'close_tag'=>'</u>',
|
|
'flags'=>BBCODE_FLAGS_SMILEYS_OFF),
|
|
'i'=> array('type'=>BBCODE_TYPE_NOARG,
|
|
'open_tag'=>'<i>',
|
|
'close_tag'=>'</i>',
|
|
'childs'=>'b'),
|
|
);
|
|
/*
|
|
* Parsed Text
|
|
*/
|
|
$text=<<<EOF
|
|
[i] No parse Test [/i] :)
|
|
[b] Parsed, with smiley :( [/b]
|
|
[u] Parsed, with no smiley :D [/u]
|
|
EOF;
|
|
/*
|
|
* Init the parser
|
|
*/
|
|
$BBHandler=bbcode_create($arrayBBCode);
|
|
/*
|
|
* Add Smiley rules to parser
|
|
*/
|
|
bbcode_add_smiley($BBHandler, ":)", "<img src=\"smiley.gif\" alt=\":)\" />");
|
|
bbcode_add_smiley($BBHandler, ":(", "<img src=\"sad.gif\" alt=\":(\" />");
|
|
bbcode_add_smiley($BBHandler, ":D", "<img src=\"happy.gif\" alt=\":D\" />");
|
|
bbcode_add_smiley($BBHandler, ":p", "<img src=\"tong.gif\" alt=\":p\" />");
|
|
bbcode_add_smiley($BBHandler, ":|", "<img src=\"special.gif\" alt=\":|\" />");
|
|
bbcode_add_smiley($BBHandler, ":6:", "<img src=\"six.gif\" alt=\":6:\" />");
|
|
/*
|
|
* Parse the text
|
|
*/
|
|
echo bbcode_parse($BBHandler,$text);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
<i> No parse Test </i> <img src="smiley.gif" alt=":)" />
|
|
<b> Parsed, with smiley <img src="sad.gif" alt=":(" /> </b>
|
|
<u> Parsed, with no smiley :D </u>
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</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
|
|
-->
|
|
|