SystemUpdater class

Class SystemUpdater

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the SystemUpdater class also inherits all the methods and properties of: WireData and Wire.

Show class?     Show args?       Only hookable?    

Common

NameReturnSummary 
SystemUpdater::apply($version)
bool

Manually apply a update

 
SystemUpdater::error(string $text)
SystemUpdater WireData

Error notice

 
SystemUpdater::getUpdate(int $version)
null SystemUpdate

Get a specific SystemUpdate class instance by version number and return it (without executing it)

 
SystemUpdater::getUpdatesApplied()
array

Get array of updates (update version numbers) that were automatically applied during this request

 
SystemUpdater::log(string $str)
None

Log a message to system-updater.txt log file

 
SystemUpdater::message(string $text)
SystemUpdater WireData

Message notice

 
SystemUpdater::saveSystemVersion(int $version)
bool

Save the system version as the given version number

 
SystemUpdater::setConfigData(array $data)
None

Part of the ConfigurableModule interface, sets config data to the module

 
SystemUpdater::warning(string $text)
SystemUpdater WireData

Warning notice

 

Additional methods and properties

In addition to the methods and properties above, SystemUpdater also inherits the methods and properties of these classes:

API reference based on ProcessWire core version 3.0.257