Référence de la classe InstallerHelper

Fonctions membres publiques statiques
static	downloadPackage ($url, $target=false)
static	unpack ($packageFilename, $alwaysReturnArray=false)
static	detectType ($packageDirectory)
static	getFilenameFromUrl ($url)
static	cleanupInstall ($package, $resultdir)
static	isChecksumValid ($packagefile, $updateObject)

Champs de données
const	HASH_NOT_VALIDATED = 0
const	HASH_VALIDATED = 1
const	HASH_NOT_PROVIDED = 2

Description détaillée

Installer helper class

Depuis

3.1

Documentation des fonctions membres

cleanupInstall()

static cleanupInstall (   $package,   $resultdir  )

static

Clean up temporary uploaded package and unpacked extension

Paramètres

string	$package	Path to the uploaded package file
string	$resultdir	Path to the unpacked extension

Renvoie

boolean True on success

Depuis

3.1

Références Path\clean(), File\delete(), Folder\delete(), elseif, et Factory\getApplication().

Référencé par LanguagesModel\install(), ExtensionInstallCommand\processPathInstallation(), ExtensionInstallCommand\processUrlInstallation(), et UpdateCoreCommand\updateJoomlaCore().

detectType()

static detectType (   $packageDirectory )

static

Method to detect the extension type from a package directory

Paramètres

string

$packageDirectory

Path to package directory

Renvoie

mixed Extension type string or boolean false on fail

Depuis

3.1

Références $type, $xml, Text\_(), Log\add(), Folder\files(), et Log\WARNING.

Référencé par PackageAdapter\copyBaseFiles().

downloadPackage()

static downloadPackage (   $url,   $target = false  )

static

Downloads a package

Paramètres

string	$url	URL of file to download
string | bool	$target	Download target filename or false to get the filename from the URL

Renvoie

string|boolean Path to downloaded package or boolean false on failure

Depuis

3.1

Références $parts, $target, $url, $version, Log\add(), elseif, Factory\getApplication(), HttpFactory\getHttp(), PluginHelper\importPlugin(), Text\sprintf(), Log\WARNING, et File\write().

Référencé par UpdateCoreCommand\downloadFile(), LanguagesModel\downloadPackage(), et ExtensionInstallCommand\processUrlInstallation().

getFilenameFromUrl()

static getFilenameFromUrl (   $url )

static

Gets a file name out of a url

Paramètres

string

$url

URL to get name from

Renvoie

string Clean version of the filename or a unique id

Depuis

3.1

Références $default, $parts, et $url.

isChecksumValid()

static isChecksumValid (   $packagefile,   $updateObject  )

static

Return the result of the checksum of a package with the SHA256/SHA384/SHA512 tags in the update server manifest

Paramètres

string	$packagefile	Location of the package to be installed
Update	$updateObject	The Update Object

Renvoie

integer one if the hashes match, zero if hashes doesn't match, two if hashes not found

Depuis

3.9.0

Références $hash.

unpack()

static unpack (   $packageFilename,   $alwaysReturnArray = false  )

static

Unpacks a file and verifies it as a Joomla element package Supports .gz .tar .tar.gz and .zip

Paramètres

string	$packageFilename	The uploaded package filename or install directory
boolean	$alwaysReturnArray	If should return false (and leave garbage behind) or return $retval['type']=false

Renvoie

array|boolean Array on success or boolean false on failure

Depuis

3.1

Références Path\clean(), Folder\exists(), Folder\files(), Folder\folders(), Factory\getApplication(), et null.

Référencé par PackageAdapter\copyBaseFiles(), LanguagesModel\downloadPackage(), UpdateCoreCommand\extractFile(), ExtensionInstallCommand\processPathInstallation(), et ExtensionInstallCommand\processUrlInstallation().

Documentation des champs

HASH_NOT_PROVIDED

const HASH_NOT_PROVIDED = 2

HASH_NOT_VALIDATED

const HASH_NOT_VALIDATED = 0

HASH_VALIDATED

const HASH_VALIDATED = 1

---

La documentation de cette classe a été générée à partir du fichier suivant :

• libraries/src/Installer/InstallerHelper.php