CRM_Extension_Downloader

class CRM_Extension_Downloader

This class handles downloads of remotely-provided extensions

Properties

CRM_Extension_Container_Basic $container
string $tmpDir

Methods

__construct(CRM_Extension_Manager $manager, string $containerDir, string $tmpDir)

No description

array
checkRequirements(CRM_EXtension_Info $extensionInfo = NULL)

Determine whether downloading is supported.

bool
download(string $key, string $downloadUrl)

Install or upgrade an extension from a remote URL.

bool
fetch(string $remoteFile, string $localFile)

Download the remote zipfile.

string|FALSE
extractFiles(string $key, string $zipFile)

Extract an extension from a zip file.

bool
validateFiles($key, $extractedZipPath)

Validate that $extractedZipPath contains valid for extension $key

Details

at line 51
__construct(CRM_Extension_Manager $manager, string $containerDir, string $tmpDir)

Parameters

CRM_Extension_Manager $manager
string $containerDir The place to store downloaded & extracted extensions.
string $tmpDir

at line 65
array checkRequirements(CRM_EXtension_Info $extensionInfo = NULL)

Determine whether downloading is supported.

Parameters

CRM_EXtension_Info $extensionInfo Optional info for (updated) extension

Return Value

array list of error messages; empty if OK

at line 119
bool download(string $key, string $downloadUrl)

Install or upgrade an extension from a remote URL.

Parameters

string $key The name of the extension being installed.
string $downloadUrl URL of a .zip file.

Return Value

bool TRUE for success

Exceptions

CRM_Extension_Exception

at line 155
bool fetch(string $remoteFile, string $localFile)

Download the remote zipfile.

Parameters

string $remoteFile URL of a .zip file.
string $localFile Path at which to store the .zip file.

Return Value

bool Whether the download was successful.

at line 176
string|FALSE extractFiles(string $key, string $zipFile)

Extract an extension from a zip file.

Parameters

string $key The name of the extension being installed; this usually matches the basedir in the .zip.
string $zipFile The local path to a .zip file.

Return Value

string|FALSE zip file path

at line 216
bool validateFiles($key, $extractedZipPath)

Validate that $extractedZipPath contains valid for extension $key

Parameters

$key
$extractedZipPath

Return Value

bool