SMF Function DB - ParsePackageInfo

Mobile Main Menu

Navigation

Parses the actions in package-info.xml.

array ParsePackageInfo (object &$packageXML[, bool $testing_only[, string $method[, string $previous_version]]])

Expected type: Object
Description: An xmlArray object

Expected type: Boolean
Description: If true, indicates that this is only a test and no changes should actually be made. Default is true.

Expected type: Enumerated String
Description: What method of installation should be used

Possible string values
Allowed values	Description
'install'	Install the package (default)
'uninstall'	Uninstall the package
'upgrade'	Upgrade from an older version of the package

Expected type: String
Description: The version of this package that was previously installed (used for upgrading)

Expected type: Array
Description: An array of information about everything this package does

Package should be an xmlArray with package-info as its base.
Testing_only should be true if the package should not actually be applied.
Method is upgrade, install, or uninstall. Its default is install.
Previous_version should be set to the previous installed version of this package, if any.
Does not handle failure very well; testing first is always better.
Returns an array of the changes made.