InstallerHelper
Installer helper class
| since |
3.1 |
|---|
Methods
cleanupInstall
Clean up temporary uploaded package and unpacked extension
cleanupInstall(string $package, string $resultdir) : boolean
| since |
3.1 |
|---|
Arguments
- $package
stringPath to the uploaded package file- $resultdir
stringPath to the unpacked extension
Response
booleanTrue on success
detectType
Method to detect the extension type from a package directory
detectType(string $packageDirectory) : mixed
| since |
3.1 |
|---|
Arguments
- $packageDirectory
stringPath to package directory
Response
mixedExtension type string or boolean false on fail
downloadPackage
Downloads a package
downloadPackage(string $url, mixed $target = false) : string|boolean
| since |
3.1 |
|---|
Arguments
- $url
stringURL of file to download- $target
mixedDownload target filename or false to get the filename from the URL
Response
string|booleanPath to downloaded package or boolean false on failure
getFilenameFromUrl
Gets a file name out of a url
getFilenameFromUrl(string $url) : string
| since |
3.1 |
|---|
Arguments
- $url
stringURL to get name from
Response
stringClean version of the filename or a unique id
isChecksumValid
Return the result of the checksum of a package with the SHA256/SHA384/SHA512 tags in the update server manifest
isChecksumValid(string $packagefile, \Joomla\CMS\Installer\JUpdate $updateObject) : integer
| since |
3.9.0 |
|---|
Arguments
- $packagefile
stringLocation of the package to be installed- $updateObject
\Joomla\CMS\Installer\JUpdateThe Update Object
Response
integerone if the hashes match, zero if hashes doesn't match, two if hashes not found
splitSql
Splits contents of a sql file into array of discreet queries.
splitSql(string $query) : array
Queries need to be delimited with end of statement marker ';'
| since |
3.1 |
|---|---|
| deprecated |
4.0 Use \JDatabaseDriver::splitSql() directly |
Arguments
- $query
stringThe SQL statement.
Response
arrayArray of queries
unpack
Unpacks a file and verifies it as a Joomla element package Supports .gz .tar .tar.gz and .zip
unpack(string $packageFilename, boolean $alwaysReturnArray = false) : array|boolean
| since |
3.1 |
|---|
Arguments
- $packageFilename
stringThe uploaded package filename or install directory- $alwaysReturnArray
booleanIf should return false (and leave garbage behind) or return $retval['type']=false
Response
array|booleanArray on success or boolean false on failure
Constants
HASH_NOT_VALIDATED
Hash not validated identifier.
| Value | 0 |
|---|---|
| since |
3.9.0 |
Type(s)
integer
HASH_VALIDATED
Hash validated identifier.
| Value | 1 |
|---|---|
| since |
3.9.0 |
Type(s)
integer
HASH_NOT_PROVIDED
Hash not provided identifier.
| Value | 2 |
|---|---|
| since |
3.9.0 |
Type(s)
integer