uTools-Manuals/docs/php/bbcode_add_smiley.html
2019-04-28 19:00:34 +08:00

109 lines
12 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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 class="docs"><div id="layout">
<div id="layout-content"><div id="function.bbcode-add-smiley" class="refentry">
<div class="refnamediv">
<h1 class="refname">bbcode_add_smiley</h1>
<p class="verinfo">(PECL bbcode &gt;= 0.10.2)</p><p class="refpurpose"><span class="refname">bbcode_add_smiley</span> &mdash; <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">说明</h3>
<div class="methodsynopsis dc-description">
<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>
) : <span class="type">bool</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">参数</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">bbcode_container</code></dt>
<dd>
<p class="para">
BBCode_Container resource, returned by <span class="function"><a href="bbcode_create.html" class="function">bbcode_create()</a></span>.
</p>
</dd>
<dt>
<code class="parameter">smiley</code></dt>
<dd>
<p class="para">
The string that will be replaced when found.
</p>
</dd>
<dt>
<code class="parameter">replace_by</code></dt>
<dd>
<p class="para">
The string that replace smiley when found.
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.bbcode-add-smiley-returnvalues">
<h3 class="title">返回值</h3>
<p class="para">
成功时返回 <strong><code>TRUE</code></strong> 或者在失败时返回 <strong><code>FALSE</code></strong>
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.bbcode-add-smiley-examples">
<h3 class="title">范例</h3>
<p class="para">
<div class="example" id="example-5846">
<p><strong>Example #1 <span class="function"><strong>bbcode_add_smiley()</strong></span> usage example</strong></p>
<div class="example-contents">
<div class="phpcode"><pre><span style="color: #000000">
<span style="color: #0000BB">&lt;?php<br /></span><span style="color: #FF8000">/*<br />&nbsp;*&nbsp;Prepare&nbsp;the&nbsp;rule&nbsp;set&nbsp;<br />&nbsp;*/<br /></span><span style="color: #0000BB">$arrayBBCode</span><span style="color: #007700">=array(<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">''</span><span style="color: #007700">=&gt;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;array(</span><span style="color: #DD0000">'type'</span><span style="color: #007700">=&gt;</span><span style="color: #0000BB">BBCODE_TYPE_ROOT</span><span style="color: #007700">,&nbsp;&nbsp;<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">'childs'</span><span style="color: #007700">=&gt;</span><span style="color: #DD0000">'!i'</span><span style="color: #007700">),<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">'b'</span><span style="color: #007700">=&gt;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;array(</span><span style="color: #DD0000">'type'</span><span style="color: #007700">=&gt;</span><span style="color: #0000BB">BBCODE_TYPE_NOARG</span><span style="color: #007700">,&nbsp;<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">'open_tag'</span><span style="color: #007700">=&gt;</span><span style="color: #DD0000">'&lt;b&gt;'</span><span style="color: #007700">,&nbsp;<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">'close_tag'</span><span style="color: #007700">=&gt;</span><span style="color: #DD0000">'&lt;/b&gt;'</span><span style="color: #007700">),<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">'u'</span><span style="color: #007700">=&gt;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;array(</span><span style="color: #DD0000">'type'</span><span style="color: #007700">=&gt;</span><span style="color: #0000BB">BBCODE_TYPE_NOARG</span><span style="color: #007700">,&nbsp;<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">'open_tag'</span><span style="color: #007700">=&gt;</span><span style="color: #DD0000">'&lt;u&gt;'</span><span style="color: #007700">,&nbsp;<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">'close_tag'</span><span style="color: #007700">=&gt;</span><span style="color: #DD0000">'&lt;/u&gt;'</span><span style="color: #007700">,&nbsp;<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">'flags'</span><span style="color: #007700">=&gt;</span><span style="color: #0000BB">BBCODE_FLAGS_SMILEYS_OFF</span><span style="color: #007700">),<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">'i'</span><span style="color: #007700">=&gt;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;array(</span><span style="color: #DD0000">'type'</span><span style="color: #007700">=&gt;</span><span style="color: #0000BB">BBCODE_TYPE_NOARG</span><span style="color: #007700">,&nbsp;<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">'open_tag'</span><span style="color: #007700">=&gt;</span><span style="color: #DD0000">'&lt;i&gt;'</span><span style="color: #007700">,&nbsp;<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">'close_tag'</span><span style="color: #007700">=&gt;</span><span style="color: #DD0000">'&lt;/i&gt;'</span><span style="color: #007700">,&nbsp;<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">'childs'</span><span style="color: #007700">=&gt;</span><span style="color: #DD0000">'b'</span><span style="color: #007700">),<br />);<br /></span><span style="color: #FF8000">/*&nbsp;<br />&nbsp;*&nbsp;Parsed&nbsp;Text<br />&nbsp;*/<br /></span><span style="color: #0000BB">$text</span><span style="color: #007700">=&lt;&lt;&lt;EOF<br /></span><span style="color: #DD0000">[i]&nbsp;No&nbsp;parse&nbsp;Test&nbsp;[/i]&nbsp;:)<br />[b]&nbsp;Parsed,&nbsp;with&nbsp;smiley&nbsp;:(&nbsp;[/b]<br />[u]&nbsp;Parsed,&nbsp;with&nbsp;no&nbsp;smiley&nbsp;:D&nbsp;[/u]<br /></span><span style="color: #007700">EOF;<br /></span><span style="color: #FF8000">/*<br />&nbsp;*&nbsp;Init&nbsp;the&nbsp;parser<br />&nbsp;*/<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 />&nbsp;*&nbsp;Add&nbsp;Smiley&nbsp;rules&nbsp;to&nbsp;parser<br />&nbsp;*/<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">,&nbsp;</span><span style="color: #DD0000">":)"</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">"&lt;img&nbsp;src=\"smiley.gif\"&nbsp;alt=\":)\"&nbsp;/&gt;"</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">,&nbsp;</span><span style="color: #DD0000">":("</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">"&lt;img&nbsp;src=\"sad.gif\"&nbsp;alt=\":(\"&nbsp;/&gt;"</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">,&nbsp;</span><span style="color: #DD0000">":D"</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">"&lt;img&nbsp;src=\"happy.gif\"&nbsp;alt=\":D\"&nbsp;/&gt;"</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">,&nbsp;</span><span style="color: #DD0000">":p"</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">"&lt;img&nbsp;src=\"tong.gif\"&nbsp;alt=\":p\"&nbsp;/&gt;"</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">,&nbsp;</span><span style="color: #DD0000">":|"</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">"&lt;img&nbsp;src=\"special.gif\"&nbsp;alt=\":|\"&nbsp;/&gt;"</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">,&nbsp;</span><span style="color: #DD0000">":6:"</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">"&lt;img&nbsp;src=\"six.gif\"&nbsp;alt=\":6:\"&nbsp;/&gt;"</span><span style="color: #007700">);<br /></span><span style="color: #FF8000">/*<br />&nbsp;*&nbsp;Parse&nbsp;the&nbsp;text<br />&nbsp;*/<br /></span><span style="color: #007700">echo&nbsp;</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">?&gt;</span>
</span>
</pre></div>
</div>
<div class="example-contents"><p>以上例程会输出:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
&lt;i&gt; No parse Test &lt;/i&gt; &lt;img src=&quot;smiley.gif&quot; alt=&quot;:)&quot; /&gt;
&lt;b&gt; Parsed, with smiley &lt;img src=&quot;sad.gif&quot; alt=&quot;:(&quot; /&gt; &lt;/b&gt;
&lt;u&gt; Parsed, with no smiley :D &lt;/u&gt;
</pre></div>
</div>
</div>
</p>
</div>
</div></div></div></body></html>