<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <title>Adds a smiley to the parser</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.bbcode-add-element.html">bbcode_add_element</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.bbcode-create.html">bbcode_create</a></div> <div class="up"><a href="ref.bbcode.html">BBCode Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="function.bbcode-add-smiley" class="refentry"> <div class="refnamediv"> <h1 class="refname">bbcode_add_smiley</h1> <p class="verinfo">(PECL bbcode >= 0.10.2)</p><p class="refpurpose"><span class="refname">bbcode_add_smiley</span> — <span class="dc-title">Adds a smiley to the parser</span></p> </div> <div class="refsect1 description" id="refsect1-function.bbcode-add-smiley-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><strong>bbcode_add_smiley</strong></span> ( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$bbcode_container</code></span> , <span class="methodparam"><span class="type">string</span> <code class="parameter">$smiley</code></span> , <span class="methodparam"><span class="type">string</span> <code class="parameter">$replace_by</code></span> )</div> <p class="para rdfs-comment"> Adds a smiley to the parser </p> </div> <div class="refsect1 parameters" id="refsect1-function.bbcode-add-smiley-parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <span class="term"><em><code class="parameter">bbcode_container</code></em></span> <dd> <p class="para"> BBCode_Container resource, returned by <span class="function"><a href="function.bbcode-create.html" class="function">bbcode_create()</a></span>. </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">smiley</code></em></span> <dd> <p class="para"> The string that will be replaced when found. </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">replace_by</code></em></span> <dd> <p class="para"> The string that replace smiley when found. </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-function.bbcode-add-smiley-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure. </p> </div> <div class="refsect1 examples" id="refsect1-function.bbcode-add-smiley-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-4776"> <p><strong>Example #1 <span class="function"><strong>bbcode_add_smiley()</strong></span> usage example</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">/*<br /> * Prepare the rule set <br /> */<br /></span><span style="color: #0000BB">$arrayBBCode</span><span style="color: #007700">=array(<br /> </span><span style="color: #DD0000">''</span><span style="color: #007700">=> array(</span><span style="color: #DD0000">'type'</span><span style="color: #007700">=></span><span style="color: #0000BB">BBCODE_TYPE_ROOT</span><span style="color: #007700">, <br /> </span><span style="color: #DD0000">'childs'</span><span style="color: #007700">=></span><span style="color: #DD0000">'!i'</span><span style="color: #007700">),<br /> </span><span style="color: #DD0000">'b'</span><span style="color: #007700">=> array(</span><span style="color: #DD0000">'type'</span><span style="color: #007700">=></span><span style="color: #0000BB">BBCODE_TYPE_NOARG</span><span style="color: #007700">, <br /> </span><span style="color: #DD0000">'open_tag'</span><span style="color: #007700">=></span><span style="color: #DD0000">'<b>'</span><span style="color: #007700">, <br /> </span><span style="color: #DD0000">'close_tag'</span><span style="color: #007700">=></span><span style="color: #DD0000">'</b>'</span><span style="color: #007700">),<br /> </span><span style="color: #DD0000">'u'</span><span style="color: #007700">=> array(</span><span style="color: #DD0000">'type'</span><span style="color: #007700">=></span><span style="color: #0000BB">BBCODE_TYPE_NOARG</span><span style="color: #007700">, <br /> </span><span style="color: #DD0000">'open_tag'</span><span style="color: #007700">=></span><span style="color: #DD0000">'<u>'</span><span style="color: #007700">, <br /> </span><span style="color: #DD0000">'close_tag'</span><span style="color: #007700">=></span><span style="color: #DD0000">'</u>'</span><span style="color: #007700">, <br /> </span><span style="color: #DD0000">'flags'</span><span style="color: #007700">=></span><span style="color: #0000BB">BBCODE_FLAGS_SMILEYS_OFF</span><span style="color: #007700">),<br /> </span><span style="color: #DD0000">'i'</span><span style="color: #007700">=> array(</span><span style="color: #DD0000">'type'</span><span style="color: #007700">=></span><span style="color: #0000BB">BBCODE_TYPE_NOARG</span><span style="color: #007700">, <br /> </span><span style="color: #DD0000">'open_tag'</span><span style="color: #007700">=></span><span style="color: #DD0000">'<i>'</span><span style="color: #007700">, <br /> </span><span style="color: #DD0000">'close_tag'</span><span style="color: #007700">=></span><span style="color: #DD0000">'</i>'</span><span style="color: #007700">, <br /> </span><span style="color: #DD0000">'childs'</span><span style="color: #007700">=></span><span style="color: #DD0000">'b'</span><span style="color: #007700">),<br />);<br /></span><span style="color: #FF8000">/* <br /> * Parsed Text<br /> */<br /></span><span style="color: #0000BB">$text</span><span style="color: #007700">=<<<EOF<br /></span><span style="color: #DD0000">[i] No parse Test [/i] :)<br />[b] Parsed, with smiley :( [/b]<br />[u] Parsed, with no smiley :D [/u]<br /></span><span style="color: #007700">EOF;<br /></span><span style="color: #FF8000">/*<br /> * Init the parser<br /> */<br /></span><span style="color: #0000BB">$BBHandler</span><span style="color: #007700">=</span><span style="color: #0000BB">bbcode_create</span><span style="color: #007700">(</span><span style="color: #0000BB">$arrayBBCode</span><span style="color: #007700">);<br /></span><span style="color: #FF8000">/*<br /> * Add Smiley rules to parser<br /> */<br /></span><span style="color: #0000BB">bbcode_add_smiley</span><span style="color: #007700">(</span><span style="color: #0000BB">$BBHandler</span><span style="color: #007700">, </span><span style="color: #DD0000">":)"</span><span style="color: #007700">, </span><span style="color: #DD0000">"<img src=\"smiley.gif\" alt=\":)\" />"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">bbcode_add_smiley</span><span style="color: #007700">(</span><span style="color: #0000BB">$BBHandler</span><span style="color: #007700">, </span><span style="color: #DD0000">":("</span><span style="color: #007700">, </span><span style="color: #DD0000">"<img src=\"sad.gif\" alt=\":(\" />"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">bbcode_add_smiley</span><span style="color: #007700">(</span><span style="color: #0000BB">$BBHandler</span><span style="color: #007700">, </span><span style="color: #DD0000">":D"</span><span style="color: #007700">, </span><span style="color: #DD0000">"<img src=\"happy.gif\" alt=\":D\" />"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">bbcode_add_smiley</span><span style="color: #007700">(</span><span style="color: #0000BB">$BBHandler</span><span style="color: #007700">, </span><span style="color: #DD0000">":p"</span><span style="color: #007700">, </span><span style="color: #DD0000">"<img src=\"tong.gif\" alt=\":p\" />"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">bbcode_add_smiley</span><span style="color: #007700">(</span><span style="color: #0000BB">$BBHandler</span><span style="color: #007700">, </span><span style="color: #DD0000">":|"</span><span style="color: #007700">, </span><span style="color: #DD0000">"<img src=\"special.gif\" alt=\":|\" />"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">bbcode_add_smiley</span><span style="color: #007700">(</span><span style="color: #0000BB">$BBHandler</span><span style="color: #007700">, </span><span style="color: #DD0000">":6:"</span><span style="color: #007700">, </span><span style="color: #DD0000">"<img src=\"six.gif\" alt=\":6:\" />"</span><span style="color: #007700">);<br /></span><span style="color: #FF8000">/*<br /> * Parse the text<br /> */<br /></span><span style="color: #007700">echo </span><span style="color: #0000BB">bbcode_parse</span><span style="color: #007700">(</span><span style="color: #0000BB">$BBHandler</span><span style="color: #007700">,</span><span style="color: #0000BB">$text</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> <div class="example-contents"><p>The above example will output:</p></div> <div class="example-contents screen"> <div class="cdata"><pre> <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> </pre></div> </div> </div> </p> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.bbcode-add-element.html">bbcode_add_element</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.bbcode-create.html">bbcode_create</a></div> <div class="up"><a href="ref.bbcode.html">BBCode Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>