Umil.run actions

From phpBB Development Wiki

umil::run_actions –– Run a list of actions using the Umil Library.

Contents

Description

string umil::run_actions ( string $action, array $versions, string $version_config_name [, string $version_select ] )

Parameters

Parameter Required/Default Usage
action Required The action to perform, 'install', 'update', or 'uninstall'
update performs an install if the mod is not currently installed
versions Required The array of versions and the actions for each
version_config_name Required The name of the config setting which holds/will hold the currently installed version
version_select default '' Allows you to select the version you want to install/update/uninstall to.
Leave blank to ignore and install/update to the latest or completely remove in the case of uninstall

Return Values

Does not return anything

Examples

For examples, see the Documentation Package
Specifically, look at the umil_auto_example with the $version array, that array gets sent to this function when using the UMIL Auto system.

This article is a stub. You can help in improving Olympus Documentation by expanding it.


See Also