MediaWiki  REL1_31
RaggettBase.php
Go to the documentation of this file.
1 <?php
2 
3 namespace MediaWiki\Tidy;
4 
5 abstract class RaggettBase extends TidyDriverBase {
12  public function tidy( $text ) {
13  $wrapper = new RaggettWrapper;
14  $wrappedtext = $wrapper->getWrapped( $text );
15 
16  $retVal = null;
17  $correctedtext = $this->cleanWrapped( $wrappedtext, false, $retVal );
18 
19  if ( $retVal < 0 ) {
20  wfDebug( "Possible tidy configuration error!\n" );
21  return $text . "\n<!-- Tidy was unable to run -->\n";
22  } elseif ( is_null( $correctedtext ) ) {
23  wfDebug( "Tidy error detected!\n" );
24  return $text . "\n<!-- Tidy found serious XHTML errors -->\n";
25  }
26 
27  $correctedtext = $wrapper->postprocess( $correctedtext ); // restore any hidden tokens
28 
29  return $correctedtext;
30  }
31 
32  public function validate( $text, &$errorStr ) {
33  $retval = 0;
34  $errorStr = $this->cleanWrapped( $text, true, $retval );
35  return ( $retval < 0 && $errorStr == '' ) || $retval == 0;
36  }
37 
46  abstract protected function cleanWrapped( $text, $stderr = false, &$retval = null );
47 }
MediaWiki\Tidy\RaggettWrapper
Class used to hide mw:editsection tokens from Tidy so that it doesn't break them or break on them.
Definition: RaggettWrapper.php:19
MediaWiki\Tidy\RaggettBase
Definition: RaggettBase.php:5
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:37
MediaWiki\Tidy\RaggettWrapper\getWrapped
getWrapped( $text)
Definition: RaggettWrapper.php:35
MediaWiki\Tidy\RaggettBase\validate
validate( $text, &$errorStr)
Definition: RaggettBase.php:32
wfDebug
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
Definition: GlobalFunctions.php:994
MediaWiki\Tidy\TidyDriverBase
Base class for HTML cleanup utilities.
Definition: TidyDriverBase.php:8
MediaWiki\Tidy\RaggettBase\tidy
tidy( $text)
Generic interface for wrapping and unwrapping HTML for Dave Raggett's tidy.
Definition: RaggettBase.php:12
MediaWiki\Tidy\RaggettBase\cleanWrapped
cleanWrapped( $text, $stderr=false, &$retval=null)
Perform a clean/repair operation.
$retval
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account incomplete not yet checked for validity & $retval
Definition: hooks.txt:266
MediaWiki\Tidy
Definition: Balancer.php:27