Joomla! 1.5 API

Packages

Package: Joomla-Framework

License

Content on this site is copyright © 2005 - 2011 Open Source Matters Inc and can be used in accordance with the Joomla! Electronic Documentation License. Some parts of this website may be subject to other licenses.

 Class JInstallerHelper

Description

Installer helper class

  • since: 1.5

Located in /joomla/installer/helper.php (line 31)

Class JInstallerHelper   (Subpackage Installer)
Method Summary
Static method static boolean cleanupInstall (string $package, string $resultdir)
Static method static mixed detectType (string $p_dir)
Static method static mixed downloadPackage (string $url, [string $target = false])
Static method static mixed getFilenameFromURL (string $url)
Static method static Array unpack (string $p_filename)
Method array splitSql (string $sql)
Methods
cleanupInstall (line 248)

Clean up temporary uploaded package and unpacked extension

  • return: True on success
  • since: 1.5
boolean cleanupInstall (string $package, string $resultdir)
  • string $package: Path to the uploaded package file
  • string $resultdir: Path to the unpacked extension
detectType (line 179)

Method to detect the extension type from a package directory

  • return: Extension type string or boolean false on fail
  • since: 1.5
mixed detectType (string $p_dir)
  • string $p_dir: Path to package directory
downloadPackage (line 42)

Downloads a package

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

Gets a file name out of a url

  • return: String filename or boolean false if failed
  • since: 1.5
mixed getFilenameFromURL (string $url)
  • string $url: URL to get name from
splitSql (line 272)

Splits contents of a sql file into array of discreet queries

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

array splitSql (string $sql)
  • string $sql
unpack (line 108)

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

  • return: Two elements - extractdir and packagefile
  • since: 1.5
Array unpack (string $p_filename)
  • string $p_filename: The uploaded package filename or install directory
Support Joomla!