MediaWiki  1.28.1
Go to the documentation of this file.
1 <?php
21  public function executeSpecialPage(
23  $subPage = '',
24  WebRequest $request = null,
25  $language = null,
26  User $user = null
27  ) {
28  $context = $this->newContext( $request, $language, $user );
30  $output = new OutputPage( $context );
31  $context->setOutput( $output );
33  $page->setContext( $context );
34  $output->setTitle( $page->getPageTitle() );
36  $html = $this->getHTMLFromSpecialPage( $page, $subPage );
37  $response = $context->getRequest()->response();
39  if ( $response instanceof FauxResponse ) {
40  $code = $response->getStatusCode();
42  if ( $code > 0 ) {
43  $response->header( 'Status: ' . $code . ' ' . HttpStatus::getMessage( $code ) );
44  }
45  }
47  return [ $html, $response ];
48  }
57  private function newContext(
58  WebRequest $request = null,
59  $language = null,
60  User $user = null
61  ) {
64  $context->setRequest( $request ?: new FauxRequest() );
66  if ( $language !== null ) {
67  $context->setLanguage( $language );
68  }
70  if ( $user !== null ) {
71  $context->setUser( $user );
72  }
76  return $context;
77  }
85  $request = $context->getRequest();
87  // Edits via GET are a security issue and should not succeed. On the other hand, not all
88  // POST requests are edits, but should ignore unused parameters.
89  if ( !$request->getCheck( 'wpEditToken' ) && $request->wasPosted() ) {
90  $request->setVal( 'wpEditToken', $context->getUser()->getEditToken() );
91  }
92  }
101  private function getHTMLFromSpecialPage( SpecialPage $page, $subPage ) {
102  ob_start();
104  try {
105  $page->execute( $subPage );
107  $output = $page->getOutput();
109  if ( $output->getRedirect() !== '' ) {
110  $output->output();
111  $html = ob_get_contents();
112  } elseif ( $output->isDisabled() ) {
113  $html = ob_get_contents();
114  } else {
115  $html = $output->getHTML();
116  }
117  } catch ( Exception $ex ) {
118  ob_end_clean();
120  // Re-throw exception after "finally" handling because PHP 5.3 doesn't have "finally".
121  throw $ex;
122  }
124  ob_end_clean();
126  return $html;
127  }
129 }
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses & $html
Definition: hooks.txt:1936
Definition: load.php:50
Get the User object.
An IContextSource implementation which will inherit context from another source but allow individual ...
Get the OutputPage being used for this instance.
this hook is for auditing only $response
Definition: hooks.txt:802
static getMessage($code)
Get the message associated with an HTTP response status code.
Definition: HttpStatus.php:34
getHTMLFromSpecialPage(SpecialPage $page, $subPage)
Parent class for all special pages.
Definition: SpecialPage.php:36
static getMain()
Static methods.
Get the WebRequest object.
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable & $code
Definition: hooks.txt:802
This class should be covered by a general architecture document which does not exist as of January 20...
Definition: OutputPage.php:43
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 local account $user
Definition: hooks.txt:242
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object & $output
Definition: hooks.txt:1046
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:35
error also a ContextSource you ll probably need to make sure the header is varied on $request
Definition: hooks.txt:2573
executeSpecialPage(SpecialPage $page, $subPage= '', WebRequest $request=null, $language=null, User $user=null)
Default execute method Checks user permissions.
newContext(WebRequest $request=null, $language=null, User $user=null)
Sets the context this SpecialPage is executed in.
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached $page
Definition: hooks.txt:2491
setEditTokenFromUser(DerivativeContext $context)
If we are trying to edit and no token is set, supply one.
Get a self-referential title object.