[Summary view] [Print] [Text view]

   1  <?php
   2  /**
   3  *
   4  * This file is part of the phpBB Forum Software package.
   5  *
   6  * @copyright (c) phpBB Limited <https://www.phpbb.com>
   7  * @license GNU General Public License, version 2 (GPL-2.0)
   8  *
   9  * For full copyright and license information, please see
  10  * the docs/CREDITS.txt file.
  11  *
  12  */
  13  
  14  namespace phpbb\textformatter;
  15  
  16  interface renderer_interface
  17  {
  18      /**
  19      * Render given text
  20      *
  21      * @param  string $text Text, as parsed by something that implements \phpbb\textformatter\parser
  22      * @return string
  23      */
  24  	public function render($text);
  25  
  26      /**
  27      * Set the smilies' path
  28      *
  29      * @return null
  30      */
  31  	public function set_smilies_path($path);
  32  
  33      /**
  34      * Return the value of the "viewcensors" option
  35      *
  36      * @return bool Option's value
  37      */
  38  	public function get_viewcensors();
  39  
  40      /**
  41      * Return the value of the "viewflash" option
  42      *
  43      * @return bool Option's value
  44      */
  45  	public function get_viewflash();
  46  
  47      /**
  48      * Return the value of the "viewimg" option
  49      *
  50      * @return bool Option's value
  51      */
  52  	public function get_viewimg();
  53  
  54      /**
  55      * Return the value of the "viewsmilies" option
  56      *
  57      * @return bool Option's value
  58      */
  59  	public function get_viewsmilies();
  60  
  61      /**
  62      * Set the "viewcensors" option
  63      *
  64      * @param  bool $value Option's value
  65      * @return null
  66      */
  67  	public function set_viewcensors($value);
  68  
  69      /**
  70      * Set the "viewflash" option
  71      *
  72      * @param  bool $value Option's value
  73      * @return null
  74      */
  75  	public function set_viewflash($value);
  76  
  77      /**
  78      * Set the "viewimg" option
  79      *
  80      * @param  bool $value Option's value
  81      * @return null
  82      */
  83  	public function set_viewimg($value);
  84  
  85      /**
  86      * Set the "viewsmilies" option
  87      *
  88      * @param  bool $value Option's value
  89      * @return null
  90      */
  91  	public function set_viewsmilies($value);
  92  }