Implements getTasks.

Parameters

array $install_state: An array of information about the current installation state.

Return value

array A keyed array of tasks the profile will perform during the final stage of the installation. Each key represents the name of a method (usually a method defined by this profile, although that is not strictly required) that is called when that task is run. The values are associative arrays containing the following key-value pairs (all of which are optional):

• display_name: The human-readable name of the task. This will be displayed to the user while the installer is running, along with a list of other tasks that are being run. Leave this unset to prevent the task from appearing in the list.
• display: This is a boolean which can be used to provide finer-grained control over whether or not the task will display. This is mostly useful for tasks that are intended to display only under certain conditions; for these tasks, you can set 'display_name' to the name that you want to display, but then use this boolean to hide the task only when certain conditions apply.
• type: A string representing the type of task. This parameter has three possible values:
  • normal: (default) This indicates that the task will be treated as a regular callback method, which does its processing and optionally returns HTML output.
  • batch: This indicates that the task method will return a batch API definition suitable for batch_set() or an array of batch definitions suitable for consecutive batch_set() calls. The installer will then take care of automatically running the task via batch processing.
  • form: This indicates that the task method will return a standard form API definition (and separately define validation and submit handlers, as appropriate). The installer will then take care of automatically directing the user through the form submission process.
• run: A constant representing the manner in which the task will be run. This parameter has three possible values:
  • INSTALL_TASK_RUN_IF_NOT_COMPLETED: (default) This indicates that the task will run once during the installation of the profile.
  • INSTALL_TASK_SKIP: This indicates that the task will not run during the current installation page request. It can be used to skip running an installation task when certain conditions are met, even though the task may still show on the list of installation tasks presented to the user.
  • INSTALL_TASK_RUN_IF_REACHED: This indicates that the task will run on each installation page request that reaches it. This is rarely necessary for an installation profile to use; it is primarily used by the Drupal installer for bootstrap-related tasks.
• function: Normally this does not need to be set, but it can be used to force the installer to call a different method when the task is run (rather than the method whose name is given by the array key). This could be used, for example, to allow the same method to be called by two different tasks.

Overrides TasksInterface::getTasks

File

core/profiles/tests/testing_install_tasks_interface/src/Install/Tasks/TestingInstallTasksInterfaceTasks.php, line 17

Class

TestingInstallTasksInterfaceTasks

Install tasks.

Namespace

Drupal\testing_install_tasks_interface\Install\Tasks

Code

public function getTasks(array &$install_state) : array {
  \Drupal::keyValue('testing_install_tasks_interface')->set('task', 'ran');
  return [];
}

---