bbcode_set_flags(3) [php man page]

BBCODE_SET_FLAGS(3)							 1						       BBCODE_SET_FLAGS(3)

bbcode_set_flags - Set or alter parser options

SYNOPSIS

       bool bbcode_set_flags (resource	$bbcode_container, int	$flags, [int  $mode = BBCODE_SET_FLAGS_SET])

DESCRIPTION

	Set or alter parser options

PARAMETERS

	      o $bbcode_container
		- BBCode_Container resource, returned by bbcode_create(3).

	      o $flags
		- The flag set that must be applied to the bbcode_container options

	      o $mode
		- One of the BBCODE_SET_FLAGS_* constant to set, unset a specific flag set or to replace the flag set by flags.

RETURN VALUES

	Returns TRUE on success or FALSE on failure.

EXAMPLES

       Example #1

	      bbcode_set_flags(3) usage example

	      <?php
	      /*
	       * Preparing RuleSet
	       */
	      $arrayBBCode=array(
		  'b'=>        array('type'=>BBCODE_TYPE_NOARG,
				     'open_tag'=>'<b>', 'close_tag'=>'</b>'),
		  'u'=>        array('type'=>BBCODE_TYPE_NOARG,
				     'open_tag'=>'<u>', 'close_tag'=>'</u>'),
		  'i'=>        array('type'=>BBCODE_TYPE_NOARG,
				     'open_tag'=>'<i>', 'close_tag'=>'</i>'),
	      );
	      /*
	       * Paired incorrectly nested BBCode
	       */
	      $text="[i] Parser [b] Auto Correction [/i] at work [/b]
";
	      $BBHandler=bbcode_create($arrayBBCode);
	      echo bbcode_parse($BBHandler,$text);
	      // Enabling reopening of automatically closed elements
	      bbcode_set_flags($BBHandler,BBCODE_CORRECT_REOPEN_TAGS,
			       BBCODE_SET_FLAGS_SET);
	      echo bbcode_parse($BBHandler,$text);

	      /*
	       * Unpaired incorrectly nested BBCode
	       */
	      $text="[i] Parser [b] Auto Correction [/i] at work
";
	      echo bbcode_parse($BBHandler,$text);
	      // Enabling automatic close of pending tags
	      bbcode_set_flags($BBHandler,
			       BBCODE_CORRECT_REOPEN_TAGS|BBCODE_AUTO_CORRECT,
			       BBCODE_SET_FLAGS_SET);
	      echo bbcode_parse($BBHandler,$text);
	      ?>

	      The above example will output:

	      <i> Parser <b> Auto Correction </b></i> at work
	      <i> Parser <b> Auto Correction </b></i><b> at work </b>
	      <i> Parser [b] Auto Correction </i> at work
	      <i> Parser <b> Auto Correction </b></i><b> at work
	      </b>

PHP Documentation Group 												       BBCODE_SET_FLAGS(3)

BBCODE_SET_ARG_PARSER(3)						 1						  BBCODE_SET_ARG_PARSER(3)

bbcode_set_arg_parser - Attach another parser in order to use another rule set for argument parsing

SYNOPSIS

       bool bbcode_set_arg_parser (resource  $bbcode_container, resource  $bbcode_arg_parser)

DESCRIPTION

	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.

PARAMETERS

	      o $bbcode_container
		- BBCode_Container resource, returned by bbcode_create(3).

	      o $bbcode_arg_parser
		- BBCode_Container resource, returned by bbcode_create(3). It will be used only for parsed arguments

RETURN VALUES

	Returns TRUE on success or FALSE on failure.

EXAMPLES

       Example #1

	      bbcode_set_arg_parser(3) usage example

	      <?php
	      /*
	       * Generating bbcode ruleset for main parser
	       */
	      $arrayBBCode=array(
		  'quote'=>    array('type'=>BBCODE_TYPE_ARG,
				     'open_tag'=>'<quote><h4>Source: {PARAM}</h4>',
				     'close_tag'=>'</quote>',
				     'flags'=>BBCODE_FLAGS_REMOVE_IF_EMPTY|BBCODE_FLAGS_ARG_PARSING),
		  'b'=>        array('type'=>BBCODE_TYPE_NOARG,
				     'open_tag'=>'<b>', 'close_tag'=>'</b>',
				     'flags'=>BBCODE_FLAGS_REMOVE_IF_EMPTY),
		  'u'=>        array('type'=>BBCODE_TYPE_NOARG,
				     'open_tag'=>'<u>', 'close_tag'=>'</u>',
				     'flags'=>BBCODE_FLAGS_SMILEYS_OFF | BBCODE_FLAGS_REMOVE_IF_EMPTY | BBCODE_FLAGS_SMILEYS_OFF),
		  'i'=>        array('type'=>BBCODE_TYPE_NOARG,
				     'open_tag'=>'<i>', 'close_tag'=>'</i>',
				     'flags'=>BBCODE_FLAGS_REMOVE_IF_EMPTY),
	      );
	      /*
	       * Generating bbcode ruleset for argument parser
	       */
	      $arrayBBCode_arg=array(
		  'b'=>        array('type'=>BBCODE_TYPE_NOARG,
				     'open_tag'=>'<b class="sub">', 'close_tag'=>'</b>',
				     'flags'=>BBCODE_FLAGS_REMOVE_IF_EMPTY),
		  'u'=>        array('type'=>BBCODE_TYPE_NOARG,
				     'open_tag'=>'<u>', 'close_tag'=>'</u>',
				     'flags'=>BBCODE_FLAGS_SMILEYS_OFF | BBCODE_FLAGS_REMOVE_IF_EMPTY | BBCODE_FLAGS_SMILEYS_OFF),
		  'i'=>        array('type'=>BBCODE_TYPE_NOARG,
				     'open_tag'=>'<i>', 'close_tag'=>'</i>',
				     'flags'=>BBCODE_FLAGS_REMOVE_IF_EMPTY),
	      );
	      /*
	       * Text we are going to parse
	       */
	      $text=<<<EOF
	      [quote="[b]Test[/b]"]
	      Foo :)
	      [/quote]
	      [b]Bar example :)[/b] :)
	      EOF;
	      /*
	       * Init the two parsers
	       */
	      $BBHandler=bbcode_create($arrayBBCode);
	      $BBArgHandler=bbcode_create($arrayBBCode_arg);
	      /*
	       * Setting Flags on the parsers
	       */
	      bbcode_set_flags($BBHandler,
			       BBCODE_CORRECT_REOPEN_TAGS|BBCODE_DEFAULT_SMILEYS_ON|BBCODE_ARG_DOUBLE_QUOTE|
			       BBCODE_ARG_SINGLE_QUOTE|BBCODE_ARG_HTML_QUOTE,BBCODE_SET_FLAGS_SET);
	      bbcode_set_flags($BBArgHandler,
			       BBCODE_CORRECT_REOPEN_TAGS|BBCODE_DEFAULT_SMILEYS_ON|BBCODE_ARG_DOUBLE_QUOTE|
			       BBCODE_ARG_SINGLE_QUOTE|BBCODE_ARG_HTML_QUOTE,BBCODE_SET_FLAGS_SET);
	      /*
	       * Setting $BBArgHandler as the BBHandler argument parser
	       */
	      bbcode_set_arg_parser($BBHandler,$BBArgHandler);
	      /*
	       * Adding Smileys handling rules to Main parser
	       */
	      bbcode_add_smiley($BBHandler, ":)", "<img src="smiley.gif" alt=":)" />");
	      /*
	       * Use the main parser to parse text
	       */
	      echo bbcode_parse($BBHandler,$text);
	      ?>

	      The above example will output:

	      <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=":)" />

PHP Documentation Group 												  BBCODE_SET_ARG_PARSER(3)