MediaWiki\ResourceLoader\ResourceLoaderEntryPoint Class Reference
Entry point implementation for ResourceLoader, which serves static CSS/JavaScript via MediaWiki\ResourceLoader\Module Module subclasses. More...
Inherits MediaWiki\MediaWikiEntryPoint.
Collaboration diagram for MediaWiki\ResourceLoader\ResourceLoaderEntryPoint:
Public Member Functions | |
| execute () | |
| Main entry point. | |
 Public Member Functions inherited from MediaWiki\MediaWikiEntryPoint | |
| __construct (IContextSource $context, EntryPointEnvironment $environment, MediaWikiServices $mediaWikiServices) | |
| enableOutputCapture () | |
| Enable capturing of the current output buffer. | |
| getCapturedOutput () | |
| Stop capturing and return all output. | |
| getRequestPathSuffix ( $basePath) | |
| If the request URL matches a given base path, extract the path part of the request URL after that base, and decode escape sequences in it. | |
| run () | |
| Main app life cycle: Calls doSetup(), execute(), prepareForOutput(), and postOutputShutdown(). | |
Protected Member Functions | |
| doPrepareForOutput () | |
| Prepare for sending the output. | |
| Protected Member Functions inherited from MediaWiki\MediaWikiEntryPoint | |
| commitMainTransaction () | |
| This function commits all DB and session changes as needed before the client can receive a response (in case DB commit fails) and thus also before the response can trigger a subsequent related request by the client. | |
| commitOutputBuffer () | |
| Ends the current output buffer, appending its content to the parent buffer. | |
| disableModDeflate () | |
| discardAllOutput () | |
| Discards all buffered output, down to the capture buffer level. | |
| discardOutputBuffer () | |
| doPostOutputShutdown () | |
| Forces the response to be sent to the client and then does work that can be done after the user gets the HTTP response, so they don't block on it. | |
| doSetup () | |
| Perform any setup needed before execute() is called. | |
| drainOutputBuffer () | |
| Returns the content of the current output buffer and clears it. | |
| enterPostSendMode () | |
| Disables all output to the client. | |
| exit (int $code=0) | |
| fastCgiFinishRequest () | |
| Calls fastcgi_finish_request if possible. | |
| flushOutputBuffer () | |
| Flush buffered output to the client. | |
| getBlockManager () | |
| getConfig (string $key) | |
| getContext () | |
| getDBLoadBalancerFactory () | |
| getEnv (string $name) | |
| Returns the value of an environment variable. | |
| getIni (string $name) | |
| Returns the value of an ini option. | |
| getJobQueueGroupFactory () | |
| getJobRunner () | |
| getMessageCache () | |
| getOutputBufferLength () | |
| getOutputBufferLevel () | |
| Returns the output buffer level. | |
| getOutputBufferStatus () | |
| getReadOnlyMode () | |
| getRequest () | |
| getRequestURL () | |
| Returns the current request's path and query string (not a full URL), like PHP's built-in $_SERVER['REQUEST_URI']. | |
| getResponse () | |
| getServerInfo (string $key, $default=null) | |
| getServiceContainer () | |
| Returns the main service container. | |
| getSpecialPageFactory () | |
| getStatsdDataFactory () | |
| getStatsFactory () | |
| getStatusCode () | |
| getUrlUtils () | |
| handleTopLevelError (Throwable $e) | |
| Report a top level error. | |
| hasFastCgi () | |
| header (string $header, bool $replace=true, int $status=0) | |
| inPostSendMode () | |
| Whether enterPostSendMode() has been called. | |
| isCli () | |
| outputResponsePayload ( $content) | |
| Print a response body to the current buffer (if there is one) or the server (otherwise) | |
| postOutputShutdown () | |
| Forces the response to be sent to the client and then does work that can be done after the user gets the HTTP response, so they don't block on it. | |
| prepareForOutput () | |
| Prepare for sending the output. | |
| print ( $data) | |
| restInPeace () | |
| Ends this task peacefully. | |
| schedulePostSendJobs () | |
| If enabled, after everything specific to this request is done, occasionally run jobs. | |
| setIniOption (string $name, $value) | |
| setup () | |
| Perform any setup needed before execute() is called. | |
| shouldDoHttpRedirect () | |
| Check if an HTTP->HTTPS redirect should be done. | |
| startOutputBuffer (?callable $callback=null) | |
| Adds a new output buffer level. | |
| status (int $code) | |
| triggerAsyncJobs ( $n, LoggerInterface $runJobsLogger) | |
| triggerError (string $message, int $level=E_USER_NOTICE) | |
| Triggers a PHP runtime error. | |
| triggerSyncJobs ( $n) | |
Additional Inherited Members | |
| Static Public Member Functions inherited from MediaWiki\MediaWikiEntryPoint | |
| static | emitBufferedStatsdData (IBufferingStatsdDataFactory $stats, Config $config) |
| Send out any buffered statsd data according to sampling rules. | |
| Protected Attributes inherited from MediaWiki\MediaWikiEntryPoint | |
| EntryPointEnvironment | $environment |
Detailed Description
Entry point implementation for ResourceLoader, which serves static CSS/JavaScript via MediaWiki\ResourceLoader\Module Module subclasses.
- See also
- load.php
Definition at line 34 of file ResourceLoaderEntryPoint.php.
Member Function Documentation
◆ doPrepareForOutput()
|
protected |
Prepare for sending the output.
Should be called by entry points before sending the response. Will be called automatically by run() via prepareForOutput(). Subclasses may override this method, but should not call it directly.
- Note
- arc-lamp profiling relies on the name of this method, it's hard coded in the arclamp-generate-svgs script!
Reimplemented from MediaWiki\MediaWikiEntryPoint.
Definition at line 61 of file ResourceLoaderEntryPoint.php.
◆ execute()
| MediaWiki\ResourceLoader\ResourceLoaderEntryPoint::execute | ( | ) |
Main entry point.
Reimplemented from MediaWiki\MediaWikiEntryPoint.
Definition at line 39 of file ResourceLoaderEntryPoint.php.
References MediaWiki\MediaWikiEntryPoint\getRequest(), MediaWiki\MediaWikiEntryPoint\getServiceContainer(), and Profiler\instance().
The documentation for this class was generated from the following file:
- includes/ResourceLoader/ResourceLoaderEntryPoint.php
