MediaWiki master
MediaWiki\Installer\Task\CreateExternalDomainsTask Class Reference

Create databases referenced in virtual domain and external store config. More...

Inherits MediaWiki\Installer\Task\Task.

Collaboration diagram for MediaWiki\Installer\Task\CreateExternalDomainsTask:

Public Member Functions

 execute ()
 Execute the task.
 
 getDependencies ()
 Get a list of names or aliases of tasks that must be done prior to this task.
 
 getName ()
 Get the symbolic name of the task.
 
- Public Member Functions inherited from MediaWiki\Installer\Task\Task
 getAliases ()
 Get alternative names of 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.
 
 getProvidedNames ()
 Get a list of names of objects that this task promises to provide via $this->getContext()->provide().
 
 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

Create databases referenced in virtual domain and external store config.

Initialise external store tables.

Definition at line 16 of file CreateExternalDomainsTask.php.

Member Function Documentation

◆ execute()

MediaWiki\Installer\Task\CreateExternalDomainsTask::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 31 of file CreateExternalDomainsTask.php.

◆ getDependencies()

MediaWiki\Installer\Task\CreateExternalDomainsTask::getDependencies ( )

Get a list of names or aliases of tasks that must be done prior to this task.

Stability: stable
to override
Returns
string|string[]

Reimplemented from MediaWiki\Installer\Task\Task.

Definition at line 27 of file CreateExternalDomainsTask.php.

◆ getName()

MediaWiki\Installer\Task\CreateExternalDomainsTask::getName ( )

Get the symbolic name of the task.

Returns
string

Reimplemented from MediaWiki\Installer\Task\Task.

Definition at line 23 of file CreateExternalDomainsTask.php.


The documentation for this class was generated from the following file: