Abstract Class JInstallerHelper

Description

Installer helper class

  • abstract:
  • since: 3.1

Located in /libraries/cms/installer/helper.php (line 23)


	
			
Method Summary
 static boolean cleanupInstall (string $package, string $resultdir)
 static mixed detectType (string $p_dir)
 static mixed downloadPackage (string $url, [string $target = false])
 static mixed getFilenameFromURL (string $url)
 static array splitSql (string $query)
 static mixed unpack (string $p_filename, [boolean $alwaysReturnArray = false])
Methods
static cleanupInstall (line 259)

Clean up temporary uploaded package and unpacked extension

  • return: True on success
  • since: 3.1
  • access: public
static boolean cleanupInstall (string $package, string $resultdir)
  • string $package: Path to the uploaded package file
  • string $resultdir: Path to the unpacked extension
static detectType (line 186)

Method to detect the extension type from a package directory

  • return: Extension type string or boolean false on fail
  • since: 3.1
  • access: public
static mixed detectType (string $p_dir)
  • string $p_dir: Path to package directory
static downloadPackage (line 35)

Downloads a package

  • return: Path to downloaded package or boolean false on failure
  • since: 3.1
  • access: public
static mixed downloadPackage (string $url, [string $target = false])
  • string $url: URL of file to download
  • string $target: Download target filename [optional]
static getFilenameFromURL (line 238)

Gets a file name out of a url

  • return: String filename or boolean false if failed
  • since: 3.1
  • access: public
static mixed getFilenameFromURL (string $url)
  • string $url: URL to get name from
static splitSql (line 293)

Splits contents of a sql file into array of discreet queries.

Queries need to be delimited with end of statement marker ';'

  • return: Array of queries
  • deprecated: 13.3 Use JDatabaseDriver::splitSql() directly
  • since: 3.1
  • access: public
static array splitSql (string $query)
  • string $query: The SQL statement.
static unpack (line 101)

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

  • return: Array on success or boolean false on failure
  • since: 3.1
  • access: public
static mixed unpack (string $p_filename, [boolean $alwaysReturnArray = false])
  • string $p_filename: The uploaded package filename or install directory
  • boolean $alwaysReturnArray: If should return false (and leave garbage behind) or return $retval['type']=false

Documentation generated on Tue, 19 Nov 2013 15:04:24 +0100 by phpDocumentor 1.4.3