A scheduled provider which simply provides data given to it through its constructor. More...
Inherits MediaWiki\Installer\Task\Task.
Public Member Functions | |
| __construct ( $name, $provisions) | |
| execute () | |
| Execute the task. | |
| getName () | |
| Get the symbolic name of the task. | |
| getProvidedNames () | |
| Get a list of names of objects that this task promises to provide via $this->getContext()->provide(). | |
 Public Member Functions inherited from MediaWiki\Installer\Task\Task | |
| getAliases () | |
| Get alternative names of this task. | |
| getDependencies () | |
| Get a list of names or aliases of tasks that must be done prior to this task. | |
| getDescription () | |
| Get a human-readable description of what this task does, for use as a progress message. | |
| getDescriptionMessage () | |
| Get the description as a Message object. | |
| getHookContainer () | |
| Get a HookContainer suitable for calling LoadExtensionSchemaUpdates. | |
| getServices () | |
| Get the restored services. | |
| getVirtualDomains () | |
| initBase (ITaskContext $context, string $schemaBasePath) | |
| Inject the base class dependencies and configuration. | |
| isPostInstall () | |
| If this returns true, the task will be scheduled after tasks for which it returns false. | |
| isSkipped () | |
| Override this to return true to skip the task. | |
Additional Inherited Members | |
| Protected Member Functions inherited from MediaWiki\Installer\Task\Task | |
| applySourceFile (IMaintainableDatabase $conn, string $relPath) | |
| Apply a SQL source file to the database as part of running an installation step. | |
| definitelyGetConnection (string $type) | |
| Get a database connection, and throw if a connection could not be obtained. | |
| getConfigVar (string $name) | |
| Get a configuration variable for the wiki being created. | |
| getConnection (string $type) | |
| Connect to the database for a specified purpose. | |
| getContext () | |
| Get the execution context. | |
| getDatabaseCreator () | |
| Get a helper for creating databases. | |
| getOption (string $name) | |
| Get an installer option value. | |
| getSchemaBasePath () | |
| Get the absolute base path for SQL schema files. | |
| getSqlFilePath (string $filename) | |
| Return a path to the DBMS-specific SQL file if it exists, otherwise default SQL file. | |
Detailed Description
A scheduled provider which simply provides data given to it through its constructor.
The point of a scheduled provider is to defer data construction, which this isn't doing. This is instead used to replace the scheduled provider in the regular installer, instead providing data that's available from the start in installPreConfigured.php.
- Access: internal
Definition at line 18 of file CannedProvider.php.
Constructor & Destructor Documentation
◆ __construct()
| MediaWiki\Installer\Task\CannedProvider::__construct | ( | $name, | |
| $provisions ) |
- Parameters
-
string $name array $provisions
Definition at line 28 of file CannedProvider.php.
Member Function Documentation
◆ execute()
| MediaWiki\Installer\Task\CannedProvider::execute | ( | ) |
Execute the task.
Notes for implementors:
- Unless the task is registered with a specific profile, tasks will run in both installPreConfigured.php and the traditional unconfigured environment. The global state differs between these environments.
- Tasks almost always have dependencies. Override getDependencies().
- If you need MediaWikiServices, declare a dependency on 'services' and use getServices(). The dependency ensures that the task is run when the global service container is functional.
- Returns
- Status
Reimplemented from MediaWiki\Installer\Task\Task.
Definition at line 41 of file CannedProvider.php.
References MediaWiki\Installer\Task\Task\getContext().
◆ getName()
| MediaWiki\Installer\Task\CannedProvider::getName | ( | ) |
Get the symbolic name of the task.
- Returns
- string
Reimplemented from MediaWiki\Installer\Task\Task.
Definition at line 33 of file CannedProvider.php.
◆ getProvidedNames()
| MediaWiki\Installer\Task\CannedProvider::getProvidedNames | ( | ) |
Get a list of names of objects that this task promises to provide via $this->getContext()->provide().
If this is non-empty, the task is a scheduled provider, which means that it is not persistently complete after it has been run. If installation is interrupted, it might need to be run again.
- Stability: stable
- to override
- Returns
- string|string[]
Reimplemented from MediaWiki\Installer\Task\Task.
Definition at line 37 of file CannedProvider.php.
The documentation for this class was generated from the following file:
- includes/installer/Task/CannedProvider.php
