MediaWiki\Installer\Task\CallbackTask Class Reference

An installer task which calls a callback function. More...

Inherits MediaWiki\Installer\Task\Task.

Collaboration diagram for MediaWiki\Installer\Task\CallbackTask:

Public Member Functions
	__construct ( $spec)
	execute ()
	Execute the 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.
	getName ()
	Get the symbolic name of the task.
	isPostInstall ()
	If this returns true, the task will be scheduled after tasks for which it returns false.
Public Member Functions inherited from MediaWiki\Installer\Task\Task
	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.
	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

An installer task which calls a callback function.

Access: internal

For use by the installer

Definition at line 13 of file CallbackTask.php.

Constructor & Destructor Documentation

__construct()

MediaWiki\Installer\Task\CallbackTask::__construct

(

$spec

)

See also

\MediaWiki\Installer\Task\TaskFactory::create

Parameters

array

$spec

Definition at line 31 of file CallbackTask.php.

Member Function Documentation

execute()

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

getAliases()

MediaWiki\Installer\Task\CallbackTask::getAliases

(

)

Get alternative names of this task.

These aliases can be used to fulfill dependencies of other tasks.

Stability: stable

to override

Returns

string|string[]

Reimplemented from MediaWiki\Installer\Task\Task.

Definition at line 51 of file CallbackTask.php.

getDependencies()

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

getDescription()

MediaWiki\Installer\Task\CallbackTask::getDescription

(

)

Get a human-readable description of what this task does, for use as a progress message.

This may either be English text or a MessageSpecifier. It is unsafe to use an extension message.

Stability: stable

to override

Returns

MessageSpecifier|string

Reimplemented from MediaWiki\Installer\Task\Task.

Definition at line 44 of file CallbackTask.php.

getName()

MediaWiki\Installer\Task\CallbackTask::getName

(

)

Get the symbolic name of the task.

Returns

string

Reimplemented from MediaWiki\Installer\Task\Task.

Definition at line 40 of file CallbackTask.php.

isPostInstall()

MediaWiki\Installer\Task\CallbackTask::isPostInstall

(

)

If this returns true, the task will be scheduled after tasks for which it returns false.

Subclasses can override this to return true for tasks that respond to the successful complete installation of the wiki.

Stability: stable

to override

Returns

bool

Reimplemented from MediaWiki\Installer\Task\Task.

Definition at line 59 of file CallbackTask.php.

---

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

• includes/installer/Task/CallbackTask.php