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

153 lines
12 KiB
HTML

<!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>Create a BBCode Resource</title>
</head>
<body class="docs"><div id="layout">
<div id="layout-content"><div id="function.bbcode-create" class="refentry">
<div class="refnamediv">
<h1 class="refname">bbcode_create</h1>
<p class="verinfo">(PECL bbcode &gt;= 0.9.0)</p><p class="refpurpose"><span class="refname">bbcode_create</span> &mdash; <span class="dc-title">Create a BBCode Resource</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.bbcode-create-description">
<h3 class="title">说明</h3>
<div class="methodsynopsis dc-description">
<span class="methodname"><strong>bbcode_create</strong></span>
([ <span class="methodparam"><span class="type">array</span> <code class="parameter">$bbcode_initial_tags</code><span class="initializer"> = NULL</span></span>
] ) : <span class="type">resource</span></div>
<p class="para rdfs-comment">
This function returns a new BBCode Resource used to parse BBCode strings.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.bbcode-create-parameters">
<h3 class="title">参数</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">bbcode_initial_tags</code></dt>
<dd>
<p class="para">
An associative array containing the tag names as keys and parameters
required to correctly parse BBCode as their value. The following key/value
pairs are supported:
<ul class="itemizedlist">
<li class="listitem">
<span class="simpara">
<var class="varname"><var class="varname">flags</var></var> optional - a flag
set based on the BBCODE_FLAGS_* constants.
</span>
</li>
<li class="listitem">
<span class="simpara">
<var class="varname"><var class="varname">type</var></var> required - an int
indicating the type of tag. Use the BBCODE_TYPE_* constants.
</span>
</li>
<li class="listitem">
<span class="simpara">
<var class="varname"><var class="varname">open_tag</var></var> required - the HTML
replacement string for the open tag.
</span>
</li>
<li class="listitem">
<span class="simpara">
<var class="varname"><var class="varname">close_tag</var></var> required - the HTML
replacement string for the close tag.
</span>
</li>
<li class="listitem">
<span class="simpara">
<var class="varname"><var class="varname">default_arg</var></var> optional -
use this value as the default argument if none is provided and
tag_type is of type OPTARG.
</span>
</li>
<li class="listitem">
<span class="simpara">
<var class="varname"><var class="varname">content_handling</var></var> optional -
Gives the callback used for modification of the content. Object
Oriented Notation supported only since 0.10.1
callback prototype is string name<em>(string $content, string $argument)</em>
</span>
</li>
<li class="listitem">
<span class="simpara">
<var class="varname"><var class="varname">param_handling</var></var> optional -
Gives the callback used for modification of the argument. Object
Oriented Notation supported only since 0.10.1
callback prototype is string name<em>(string $content, string $argument)</em>
</span>
</li>
<li class="listitem">
<span class="simpara">
<var class="varname"><var class="varname">childs</var></var> optional - List of
accepted children for the tag. The format of the list is a comma
separated string. If the list starts with ! it will be the list of
rejected children for the tag.
</span>
</li>
<li class="listitem">
<span class="simpara">
<var class="varname"><var class="varname">parent</var></var> optional - List of
accepted parents for the tag. The format of the list is a comma
separated string.
</span>
</li>
</ul>
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.bbcode-create-returnvalues">
<h3 class="title">返回值</h3>
<p class="para">
Returns a BBCode_Container
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.bbcode-create-examples">
<h3 class="title">范例</h3>
<p class="para">
<div class="example" id="example-5847">
<p><strong>Example #1 <span class="function"><strong>bbcode_create()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><pre><span style="color: #000000">
<span style="color: #0000BB">&lt;?php<br />$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;</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">'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;</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">,<br />&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;</span><span style="color: #DD0000">'childs'</span><span style="color: #007700">=&gt;</span><span style="color: #DD0000">'b'</span><span style="color: #007700">),<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">'url'</span><span style="color: #007700">=&gt;&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_OPTARG</span><span style="color: #007700">,<br />&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;a&nbsp;href="{PARAM}"&gt;'</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">'close_tag'</span><span style="color: #007700">=&gt;</span><span style="color: #DD0000">'&lt;/a&gt;'</span><span style="color: #007700">,<br />&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">'default_arg'</span><span style="color: #007700">=&gt;</span><span style="color: #DD0000">'{CONTENT}'</span><span style="color: #007700">,<br />&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,i'</span><span style="color: #007700">),<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">'img'</span><span style="color: #007700">=&gt;&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">,<br />&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;img&nbsp;src="'</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">'close_tag'</span><span style="color: #007700">=&gt;</span><span style="color: #DD0000">'"&nbsp;/&gt;'</span><span style="color: #007700">,<br />&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">''</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;</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">,<br />&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 />);<br /></span><span style="color: #0000BB">$text</span><span style="color: #007700">=&lt;&lt;&lt;EOF<br /></span><span style="color: #DD0000">[b]Bold&nbsp;Text[/b]<br />[i]Italic&nbsp;Text[/i]<br />[url]http://www.php.net/[/url]<br />[url=http://pecl.php.net/][b]Content&nbsp;Text[/b][/url]<br />[img]http://static.php.net/www.php.net/images/php.gif[/img]<br />[url=http://www.php.net/]<br />[img]http://static.php.net/www.php.net/images/php.gif[/img]<br />[/url]<br /></span><span style="color: #007700">EOF;<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 />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;b&gt;Bold Text&lt;/b&gt;
[i]Italic Text[/i]
&lt;a href=&quot;http://www.php.net/&quot;&gt;http://www.php.net/&lt;/a&gt;
&lt;a href=&quot;http://pecl.php.net/&quot;&gt;&lt;b&gt;Content Text&lt;/b&gt;&lt;/a&gt;
&lt;img src=&quot;http://static.php.net/www.php.net/images/php.gif&quot; /&gt;
&lt;a href=&quot;http://www.php.net/&quot;&gt;
[img]http://static.php.net/www.php.net/images/php.gif[/img]
&lt;/a&gt;
</pre></div>
</div>
</div>
</p>
</div>
</div></div></div></body></html>