Files
server/usr/share/psa-pear/pear/php/Horde/Compress/Fast.php
2026-01-07 20:52:11 +01:00

119 lines
3.2 KiB
PHP

<?php
/**
* Copyright 2013-2016 Horde LLC (http://www.horde.org/)
*
* See the enclosed file COPYING for license information (LGPL). If you
* did not receive this file, see http://www.horde.org/licenses/lgpl21.
*
* @category Horde
* @copyright 2013-2016 Horde LLC
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @package Compress_Fast
*/
/**
* Provides fast compression of strings using the best-available algorithm.
*
* @author Michael Slusarz <slusarz@horde.org>
* @category Horde
* @copyright 2013-2016 Horde LLC
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @package Compress_Fast
*
* @property string $driver Returns the name of the compression driver used.
*/
class Horde_Compress_Fast
{
/**
* Compression driver
*
* @var Horde_Compress_Fast_Base
*/
protected $_compress;
/**
* Constructor.
*
* @param array $opts Options:
* <pre>
* - drivers: (array) A list of driver names (Horde_Compress_Fast_Base
* class names) to use instead of auto-detecting.
* - zlib: (boolean) Consider zlib to be a "fast" compression algorithm.
* Only used if 'drivers' is empty. (@since 1.1.0).
* </pre>
*
* @throws Horde_Compress_Fast_Exception
*/
public function __construct(array $opts = array())
{
if (empty($opts['drivers'])) {
$opts['drivers'] = array(
'Horde_Compress_Fast_Lz4',
'Horde_Compress_Fast_Lzf',
'Horde_Compress_Fast_Null'
);
if (!empty($opts['zlib'])) {
array_unshift($opts['drivers'], 'Horde_Compress_Fast_Zlib');
}
}
foreach ($opts['drivers'] as $val) {
if (($ob = new $val()) &&
($ob instanceof Horde_Compress_Fast_Base) &&
$val::supported()) {
$this->_compress = $ob;
break;
}
}
if (!isset($this->_compress)) {
throw new Horde_Compress_Fast_Exception('Could not load a valid compression driver.');
}
}
/**
*/
public function __get($name)
{
switch ($name) {
case 'driver':
return get_class($this->_compress);
}
}
/**
* Compresses a string.
*
* @param string $text The string to compress.
*
* @return string The compressed string.
* @throws Horde_Compress_Fast_Exception
*/
public function compress($text)
{
if (!is_scalar($text) && !is_null($text)) {
throw new Horde_Compress_Fast_Exception('Data to compress must be a string.');
}
return $this->_compress->compress(strval($text));
}
/**
* Decompresses a string.
*
* @param string $text The compressed string.
*
* @return string The decompressed string.
* @throws Horde_Compress_Fast_Exception
*/
public function decompress($text)
{
if (!is_scalar($text) && !is_null($text)) {
throw new Horde_Compress_Fast_Exception('Data to decompress must be a string.');
}
return $this->_compress->decompress(strval($text));
}
}