<!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>Attach another parser in order to use another rule set for argument parsing</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.bbcode-parse.html">bbcode_parse</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.bbcode-set-flags.html">bbcode_set_flags</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-set-arg-parser" class="refentry"> <div class="refnamediv"> <h1 class="refname">bbcode_set_arg_parser</h1> <p class="verinfo">(PECL bbcode >= 0.10.2)</p><p class="refpurpose"><span class="refname">bbcode_set_arg_parser</span> — <span class="dc-title">Attach another parser in order to use another rule set for argument parsing</span></p> </div> <div class="refsect1 description" id="refsect1-function.bbcode-set-arg-parser-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><strong>bbcode_set_arg_parser</strong></span> ( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$bbcode_container</code></span> , <span class="methodparam"><span class="type">resource</span> <code class="parameter">$bbcode_arg_parser</code></span> )</div> <p class="para rdfs-comment"> Attaches another parser to the bbcode_container. This parser is used only when arguments must be parsed. If this function is not used, the default argument parser is the parser itself. </p> </div> <div class="refsect1 parameters" id="refsect1-function.bbcode-set-arg-parser-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">bbcode_arg_parser</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>. It will be used only for parsed arguments </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-function.bbcode-set-arg-parser-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-set-arg-parser-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-4778"> <p><strong>Example #1 <span class="function"><strong>bbcode_set_arg_parser()</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 /> * Generating bbcode ruleset for main parser <br /> */<br /></span><span style="color: #0000BB">$arrayBBCode</span><span style="color: #007700">=array(<br /> </span><span style="color: #DD0000">'quote'</span><span style="color: #007700">=> array(</span><span style="color: #DD0000">'type'</span><span style="color: #007700">=></span><span style="color: #0000BB">BBCODE_TYPE_ARG</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'open_tag'</span><span style="color: #007700">=></span><span style="color: #DD0000">'<quote><h4>Source: {PARAM}</h4>'</span><span style="color: #007700">, <br /> </span><span style="color: #DD0000">'close_tag'</span><span style="color: #007700">=></span><span style="color: #DD0000">'</quote>'</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'flags'</span><span style="color: #007700">=></span><span style="color: #0000BB">BBCODE_FLAGS_REMOVE_IF_EMPTY</span><span style="color: #007700">|</span><span style="color: #0000BB">BBCODE_FLAGS_ARG_PARSING</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">, </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">'flags'</span><span style="color: #007700">=></span><span style="color: #0000BB">BBCODE_FLAGS_REMOVE_IF_EMPTY</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">, </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">| </span><span style="color: #0000BB">BBCODE_FLAGS_REMOVE_IF_EMPTY </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">, </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">'flags'</span><span style="color: #007700">=></span><span style="color: #0000BB">BBCODE_FLAGS_REMOVE_IF_EMPTY</span><span style="color: #007700">),<br />);<br /></span><span style="color: #FF8000">/*<br /> * Generating bbcode ruleset for argument parser <br /> */<br /></span><span style="color: #0000BB">$arrayBBCode_arg</span><span style="color: #007700">=array(<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 class="sub">'</span><span style="color: #007700">, </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">'flags'</span><span style="color: #007700">=></span><span style="color: #0000BB">BBCODE_FLAGS_REMOVE_IF_EMPTY</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">, </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">| </span><span style="color: #0000BB">BBCODE_FLAGS_REMOVE_IF_EMPTY </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">, </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">'flags'</span><span style="color: #007700">=></span><span style="color: #0000BB">BBCODE_FLAGS_REMOVE_IF_EMPTY</span><span style="color: #007700">),<br />);<br /></span><span style="color: #FF8000">/*<br /> * Text we are going to parse<br /> */<br /></span><span style="color: #0000BB">$text</span><span style="color: #007700">=<<<EOF<br /></span><span style="color: #DD0000">[quote="[b]Test[/b]"]<br />Foo :)<br />[/quote]<br />[b]Bar example :)[/b] :)<br /></span><span style="color: #007700">EOF;<br /></span><span style="color: #FF8000">/*<br /> * Init the two parsers<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: #0000BB">$BBArgHandler</span><span style="color: #007700">=</span><span style="color: #0000BB">bbcode_create</span><span style="color: #007700">(</span><span style="color: #0000BB">$arrayBBCode_arg</span><span style="color: #007700">);<br /></span><span style="color: #FF8000">/*<br /> * Setting Flags on the parsers<br /> */<br /></span><span style="color: #0000BB">bbcode_set_flags</span><span style="color: #007700">(</span><span style="color: #0000BB">$BBHandler</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">BBCODE_CORRECT_REOPEN_TAGS</span><span style="color: #007700">|</span><span style="color: #0000BB">BBCODE_DEFAULT_SMILEYS_ON</span><span style="color: #007700">|</span><span style="color: #0000BB">BBCODE_ARG_DOUBLE_QUOTE</span><span style="color: #007700">|<br /> </span><span style="color: #0000BB">BBCODE_ARG_SINGLE_QUOTE</span><span style="color: #007700">|</span><span style="color: #0000BB">BBCODE_ARG_HTML_QUOTE</span><span style="color: #007700">,</span><span style="color: #0000BB">BBCODE_SET_FLAGS_SET</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">bbcode_set_flags</span><span style="color: #007700">(</span><span style="color: #0000BB">$BBArgHandler</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">BBCODE_CORRECT_REOPEN_TAGS</span><span style="color: #007700">|</span><span style="color: #0000BB">BBCODE_DEFAULT_SMILEYS_ON</span><span style="color: #007700">|</span><span style="color: #0000BB">BBCODE_ARG_DOUBLE_QUOTE</span><span style="color: #007700">|<br /> </span><span style="color: #0000BB">BBCODE_ARG_SINGLE_QUOTE</span><span style="color: #007700">|</span><span style="color: #0000BB">BBCODE_ARG_HTML_QUOTE</span><span style="color: #007700">,</span><span style="color: #0000BB">BBCODE_SET_FLAGS_SET</span><span style="color: #007700">);<br /></span><span style="color: #FF8000">/*<br /> * Setting $BBArgHandler as the BBHandler argument parser<br /> */<br /></span><span style="color: #0000BB">bbcode_set_arg_parser</span><span style="color: #007700">(</span><span style="color: #0000BB">$BBHandler</span><span style="color: #007700">,</span><span style="color: #0000BB">$BBArgHandler</span><span style="color: #007700">);<br /></span><span style="color: #FF8000">/*<br /> * Adding Smileys handling rules to Main 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: #FF8000">/*<br /> * Use the main parser to parse 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> <quote><h4>Source: <b class="sub">Test</b></h4> Foo <img src="smiley.gif" alt=":)" /> </quote> <b>Bar example :)</b> <img src="smiley.gif" alt=":)" /> </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-parse.html">bbcode_parse</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.bbcode-set-flags.html">bbcode_set_flags</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>