X-Git-Url: https://git.mxchange.org/?p=core.git;a=blobdiff_plain;f=inc%2Fclasses%2Fmain%2Fcompressor%2Fclass_Bzip2Compressor.php;h=1b3824f80038642263365dbd54d82c5acfdcdec1;hp=50a4bad2136717d9fa130c4bd32e206654563f73;hb=664da2f2a33949d1c60f3c8d47dd120701a0dae5;hpb=c6d73b0e3246efc824cb98338d4be7ee5bc9f308 diff --git a/inc/classes/main/compressor/class_Bzip2Compressor.php b/inc/classes/main/compressor/class_Bzip2Compressor.php index 50a4bad2..1b3824f8 100644 --- a/inc/classes/main/compressor/class_Bzip2Compressor.php +++ b/inc/classes/main/compressor/class_Bzip2Compressor.php @@ -4,7 +4,7 @@ * * @author Roland Haeder * @version 0.0.0 - * @copyright Copyright (c) 2007, 2008 Roland Haeder, this is free software + * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Core Developer Team * @license GNU GPL 3.0 or any newer version * @link http://www.ship-simu.org * @@ -35,34 +35,34 @@ class Bzip2Compressor extends BaseFrameworkSystem implements Compressor { /** * Create a new compressor channel based a given compression handler * - * @return $cInstance An instance of this class + * @return $compressorInstance An instance of this class */ - 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 + * @param $streamData Mixed non-object 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); @@ -71,15 +71,15 @@ class Bzip2Compressor extends BaseFrameworkSystem implements Compressor { /** * BZIP2 decompression stream * - * @param $streamData Mixed non-object stream data - * @return $streamData The decompressed stream data + * @param $streamData Mixed non-object 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 // Return the decompressed stream return bzdecompress($streamData); @@ -88,10 +88,10 @@ class Bzip2Compressor extends BaseFrameworkSystem implements Compressor { /** * 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'; } }