Class Horde_Compress

Description

The Horde_Compress:: class provides an API for various compression techniques that can be used by Horde applications.

$Horde: framework/Compress/Compress.php,v 1.7.12.14 2009/01/06 15:22:58 jan Exp $

Copyright 2003-2009 The Horde Project (http://www.horde.org/)

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.fsf.org/copyleft/lgpl.html.

Located in /Compress/Compress.php (line 17)


	
			
Direct descendents
Class Description
 class Horde_Compress_dbx The Horde_Compress_dbx class allows dbx files (e.g. from Outlook Express) to be read.
 class Horde_Compress_gzip The Horde_Compress_gzip class allows gzip files to be read.
 class Horde_Compress_tar The Horde_Compress_tar class allows tar files to be read.
 class Horde_Compress_tnef The Horde_Compress_tnef class allows MS-TNEF data to be displayed.
 class Horde_Compress_zip The Horde_Compress_zip class allows ZIP files to be created and read.
Method Summary
 Horde_Compress Horde_Compress ([array $params = array()])
 mixed compress (string $data, [array $params = array()])
 array decompress (string $data, [array $params = array()])
 Horde_Compress &factory (mixed $driver, [array $params = array()])
 Horde_Compress &singleton (mixed $driver, [array $params = array()])
Methods
Constructor Horde_Compress (line 88)

Constructor.

Horde_Compress Horde_Compress ([array $params = array()])
  • array $params: Parameter array.
compress (line 101)

Compress the data.

  • return: The compressed data. Returns PEAR_Error object on error.
mixed compress (string $data, [array $params = array()])
  • string $data: The data to compress.
  • array $params: An array of arguments needed to compress the data.

Redefined in descendants as:
decompress (line 116)

Decompress the data.

  • return: The decompressed data. Returns PEAR_Error object on error.
array decompress (string $data, [array $params = array()])
  • string $data: The data to decompress.
  • array $params: An array of arguments needed to decompress the data.

Redefined in descendants as:
factory (line 32)

Attempts to return a concrete Horde_Compress instance based on $driver.

  • return: The newly created concrete Horde_Compress instance, or false on an error.
Horde_Compress &factory (mixed $driver, [array $params = array()])
  • mixed $driver: The type of concrete Horde_Compress subclass to return. If $driver is an array, then we will look in $driver[0]/lib/Compress/ for the subclass implementation named $driver[1].php.
  • array $params: A hash containing any additional configuration or parameters a subclass might need.
singleton (line 71)

Attempts to return a reference to a concrete Horde_Compress instance based on $driver. It will only create a new instance if no Horde_Compress instance with the same parameters currently exists.

This method must be invoked as: $var = &Horde_Compress::singleton();

  • return: The concrete Horde_Compress reference, or false on an error.
Horde_Compress &singleton (mixed $driver, [array $params = array()])
  • mixed $driver: See Horde_Compress::factory().
  • array $params: See Horde_Compress::factory().

Documentation generated on Sun, 30 Jan 2011 05:15:56 +0000 by phpDocumentor 1.4.3