MediaWiki  1.34.0
MWTidy.php
Go to the documentation of this file.
1 <?php
29 class MWTidy {
30  private static $instance;
31 
42  public static function tidy( $text ) {
43  $driver = self::singleton();
44  if ( !$driver ) {
45  throw new MWException( __METHOD__ .
46  ': tidy is disabled, caller should have checked MWTidy::isEnabled()' );
47  }
48  return $driver->tidy( $text );
49  }
50 
54  public static function isEnabled() {
55  return self::singleton() !== false;
56  }
57 
61  public static function singleton() {
62  global $wgTidyConfig;
63  if ( self::$instance === null ) {
64  self::$instance = self::factory( $wgTidyConfig );
65  }
66  return self::$instance;
67  }
68 
76  public static function factory( array $config = null ) {
77  return new MediaWiki\Tidy\RemexDriver( $config ?? [] );
78  }
79 
85  public static function setInstance( $instance ) {
86  wfDeprecated( __METHOD__, '1.33' );
87  self::$instance = $instance;
88  }
89 
93  public static function destroySingleton() {
94  self::$instance = null;
95  }
96 }
MWTidy\isEnabled
static isEnabled()
Definition: MWTidy.php:54
MWException
MediaWiki exception.
Definition: MWException.php:26
MediaWiki\Tidy\RemexDriver
Definition: RemexDriver.php:12
MWTidy\factory
static factory(array $config=null)
Create a new Tidy driver object from configuration.
Definition: MWTidy.php:76
wfDeprecated
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
Definition: GlobalFunctions.php:1044
MWTidy\$instance
static $instance
Definition: MWTidy.php:30
MWTidy
Class to interact with and configure Remex tidy.
Definition: MWTidy.php:29
MWTidy\setInstance
static setInstance( $instance)
Set the driver to be used.
Definition: MWTidy.php:85
$wgTidyConfig
$wgTidyConfig
Configuration for HTML postprocessing tool.
Definition: DefaultSettings.php:4258
MWTidy\singleton
static singleton()
Definition: MWTidy.php:61
MWTidy\destroySingleton
static destroySingleton()
Destroy the current singleton instance.
Definition: MWTidy.php:93
MWTidy\tidy
static tidy( $text)
Interface with Remex tidy.
Definition: MWTidy.php:42