www.aleph1.co.uk Git - yaffs-website/blob - vendor/michelf/php-markdown/Michelf/MarkdownInterface.php

   1 <?php
   2 /**
   3  * Markdown  -  A text-to-HTML conversion tool for web writers
   4  *
   5  * @package   php-markdown
   6  * @author    Michel Fortin <michel.fortin@michelf.com>
   7  * @copyright 2004-2016 Michel Fortin <https://michelf.com/projects/php-markdown/>
   8  * @copyright (Original Markdown) 2004-2006 John Gruber <https://daringfireball.net/projects/markdown/>
   9  */
  10
  11 namespace Michelf;
  12
  13 /**
  14  * Markdown Parser Interface
  15  */
  16 interface MarkdownInterface {
  17         /**
  18          * Initialize the parser and return the result of its transform method.
  19          * This will work fine for derived classes too.
  20          *
  21          * @api
  22          *
  23          * @param  string $text
  24          * @return string
  25          */
  26         public static function defaultTransform($text);
  27
  28         /**
  29          * Main function. Performs some preprocessing on the input text
  30          * and pass it through the document gamut.
  31          *
  32          * @api
  33          *
  34          * @param  string $text
  35          * @return string
  36          */
  37         public function transform($text);
  38 }