51 lines
1.7 KiB
PHP
51 lines
1.7 KiB
PHP
<?php
|
|
/**
|
|
* <pre>
|
|
* Invision Power Services
|
|
* IP.Board v3.4.5
|
|
* Custom bbcode plugin interfaces
|
|
* Last Updated: $Date: 2012-05-10 16:10:13 -0400 (Thu, 10 May 2012) $
|
|
* </pre>
|
|
*
|
|
* @author $author$
|
|
* @copyright (c) 2001 - 2009 Invision Power Services, Inc.
|
|
* @license http://www.invisionpower.com/company/standards.php#license
|
|
* @package IP.Board
|
|
* @link http://www.invisionpower.com
|
|
* @version $Rev: 10721 $
|
|
*/
|
|
|
|
interface bbcodePlugin
|
|
{
|
|
/**
|
|
* Method that is run before the content is stored in the database
|
|
* You are responsible for ensuring you mark the replaced text appropriately so that you
|
|
* are able to unparse it, if you wish to have bbcode parsed on save
|
|
*
|
|
* @access public
|
|
* @param string $txt BBCode text from submission to be stored in database
|
|
* @return string Formatted content, ready for display
|
|
*/
|
|
public function preDbParse( $txt );
|
|
|
|
/**
|
|
* Method that is run before the content is displayed to the user
|
|
* This is the safest method of parsing, as the original submitted text is left in tact.
|
|
* No markers are necessary if you use parse on display.
|
|
*
|
|
* @access public
|
|
* @param string $txt BBCode/parsed text from database to be displayed
|
|
* @return string Formatted content, ready for display
|
|
*/
|
|
public function preDisplayParse( $txt );
|
|
|
|
/**
|
|
* Method that is run before the content is placed into an editor for editing
|
|
* If you use "parse on display" you may simply return $txt
|
|
*
|
|
* @access public
|
|
* @param string $txt Parsed text from database to be edited
|
|
* @return string BBCode content, ready for editing
|
|
*/
|
|
public function preEditParse( $txt );
|
|
} |