Updater Class Reference

Public Member Functions
	__construct (Queue $queue)
	createUpdaterTask (array $packages, $type, array $additionalOptions=[])

Data Fields
const	TASK_TYPE_UPDATE = 'update'
const	TASK_TYPE_UNINSTALL = 'uninstall'
const	TASK_TYPE_MAINTENANCE_MODE = 'maintenance_mode'

Detailed Description

Class Updater passes information to the updater application

Definition at line 15 of file Updater.php.

Constructor & Destructor Documentation

__construct()

__construct

(

Queue

$queue

)

Constructor

Parameters

Queue

$queue

Definition at line 33 of file Updater.php.

    {
        $this->queue = $queue;
    }

Member Function Documentation

createUpdaterTask()

createUpdaterTask	(	array	$packages,
			$type,
		array	$additionalOptions = []
	)

Create an update task for Updater app

Parameters

array	$packages
string	$type
array	$additionalOptions

Returns

string

Definition at line 46 of file Updater.php.

    {
        try {
            // write to .update_queue.json file
            $params = [];
            if (!empty($packages)) {
                $params['components'] = $packages;
            }
            foreach ($additionalOptions as $key => $value) {
                $params[$key] = $value;
            }

            $this->queue->addJobs([['name' => $type, 'params' => $params]]);
            return '';
        } catch (\Exception $e) {
            return $e->getMessage();
        }
    }

Field Documentation

TASK_TYPE_MAINTENANCE_MODE

const TASK_TYPE_MAINTENANCE_MODE = 'maintenance_mode'

Definition at line 22 of file Updater.php.

TASK_TYPE_UNINSTALL

const TASK_TYPE_UNINSTALL = 'uninstall'

Definition at line 21 of file Updater.php.

TASK_TYPE_UPDATE

const TASK_TYPE_UPDATE = 'update'

#+ Task types

Definition at line 20 of file Updater.php.

---

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

• vendor/magento/magento2-base/setup/src/Magento/Setup/Model/Updater.php