X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=inc%2Fclasses%2Fmain%2Fcompressor%2Fclass_NullCompressor.php;h=6edb301235f6b197e153d3fa758a3a6e325d540e;hb=8d140268002471697ef53b428b99202ea4d5519e;hp=9a078c80b82abbc16b39330c4dc2d1a8b7997b2f;hpb=a3fa89c7cbc54491fc74f13db0927d14acf550c8;p=core.git diff --git a/inc/classes/main/compressor/class_NullCompressor.php b/inc/classes/main/compressor/class_NullCompressor.php index 9a078c80..6edb3012 100644 --- a/inc/classes/main/compressor/class_NullCompressor.php +++ b/inc/classes/main/compressor/class_NullCompressor.php @@ -2,11 +2,11 @@ /** * Null 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 - 2013 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 @@ -35,28 +35,28 @@ class NullCompressor 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 static final function createNullCompressor () { // Get new instance - $cInstance = new NullCompressor(); + $compressorInstance = new NullCompressor(); // Return the compressor instance - return $cInstance; + return $compressorInstance; } /** * Null 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 $streamData; @@ -66,14 +66,14 @@ class NullCompressor extends BaseFrameworkSystem implements Compressor { * Null 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 // Return the decompressed stream return $streamData; @@ -82,10 +82,10 @@ class NullCompressor extends BaseFrameworkSystem implements Compressor { /** * Getter for the file extension of this compressor * - * @return $string Returns always "null" + * @return $string Returns always 'null' */ public final function getCompressorExtension () { - return "null"; + return 'null'; } }