friendica-github/library/php-markdown/Michelf/MarkdownInterface.php

39 lines
899 B
PHP
Raw Normal View History

2015-02-23 07:27:35 +00:00
<?php
/**
* Markdown - A text-to-HTML conversion tool for web writers
*
* @package php-markdown
* @author Michel Fortin <michel.fortin@michelf.com>
* @copyright 2004-2016 Michel Fortin <https://michelf.com/projects/php-markdown/>
* @copyright (Original Markdown) 2004-2006 John Gruber <https://daringfireball.net/projects/markdown/>
*/
2015-02-23 07:27:35 +00:00
namespace Michelf;
2015-02-23 07:27:35 +00:00
/**
* Markdown Parser Interface
*/
2015-02-23 07:27:35 +00:00
interface MarkdownInterface {
/**
* Initialize the parser and return the result of its transform method.
* This will work fine for derived classes too.
*
* @api
*
* @param string $text
* @return string
*/
public static function defaultTransform($text);
2015-02-23 07:27:35 +00:00
/**
* Main function. Performs some preprocessing on the input text
* and pass it through the document gamut.
*
* @api
*
* @param string $text
* @return string
*/
public function transform($text);
2015-02-23 07:27:35 +00:00
}