X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=inc%2Fclasses%2Fmain%2Fcompressor%2Fclass_Bzip2Compressor.php;h=0df4b8081a938ea9b1fb68fe3afc2899ec2cf794;hb=9fc7596702ceb1dc9f8bfda402a98b0351159a23;hp=69b0196dfd994fa465dcf439d9a1e5f8f57011ea;hpb=84e2207412d3c6ea9f940a83b2cdd4503509808a;p=core.git diff --git a/inc/classes/main/compressor/class_Bzip2Compressor.php b/inc/classes/main/compressor/class_Bzip2Compressor.php index 69b0196d..0df4b808 100644 --- a/inc/classes/main/compressor/class_Bzip2Compressor.php +++ b/inc/classes/main/compressor/class_Bzip2Compressor.php @@ -2,11 +2,11 @@ /** * BZIP2 compression and decompression class * - * @author Roland Haeder + * @author Roland Haeder * @version 0.0.0 - * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009, 2010 Core Developer Team + * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team * @license GNU GPL 3.0 or any newer version - * @link http://www.ship-simu.org + * @link http://www.shipsimu.org * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -33,36 +33,36 @@ class Bzip2Compressor extends BaseFrameworkSystem implements Compressor { } /** - * Create a new compressor channel based a given compression handler + * Create a new compressor channel based a given compression handler or NULL if the required PHP functions are not found. * - * @return $cInstance An instance of this class + * @return $compressorInstance An instance of this class or NULL if the required PHP functions are not found. */ - public final static function createBzip2Compressor () { + public static final function createBzip2Compressor () { + // Routines not found by default + $compressorInstance = NULL; + // Get new instance if ((function_exists('bzcompress')) && (function_exists('bzdecompress'))) { // Compressor can maybe be used - $cInstance = new Bzip2Compressor(); - } else { - // Routines not found! - $cInstance = null; - } + $compressorInstance = new Bzip2Compressor(); + } // END - if // Return the compressor instance - return $cInstance; + return $compressorInstance; } /** * BZIP2 compression stream * * @param $streamData Mixed non-object stream data - * @return $streamData The compressed stream data + * @return $streamData The compressed stream data * @throws InvalidObjectException If the stream is an object */ public function compressStream ($streamData) { if (is_object($streamData)) { // Throw an exception throw new InvalidObjectException($streamData, self::EXCEPTION_UNEXPECTED_OBJECT); - } + } // END - if // Return the compressed stream return bzcompress($streamData, 1); @@ -72,26 +72,29 @@ class Bzip2Compressor extends BaseFrameworkSystem implements Compressor { * BZIP2 decompression stream * * @param $streamData Mixed non-object stream data - * @return $streamData The decompressed stream data + * @return $streamData The decompressed stream data * @throws InvalidObjectException If the stream is an object */ public function decompressStream ($streamData) { if (is_object($streamData)) { // Throw an exception throw new InvalidObjectException($streamData, self::EXCEPTION_UNEXPECTED_OBJECT); - } + } // END - if + + // Decompress it + $streamData = bzdecompress($streamData, TRUE); // Return the decompressed stream - return bzdecompress($streamData); + return $streamData; } /** * Getter for the file extension of this compressor * - * @return $string Returns always "bz2" + * @return $string Returns always 'bz2' */ public final function getCompressorExtension () { - return "bz2"; + return 'bz2'; } }