diff options
Diffstat (limited to 'includes/ZipDirectoryReader.php')
| -rw-r--r-- | includes/ZipDirectoryReader.php | 46 |
1 files changed, 35 insertions, 11 deletions
diff --git a/includes/ZipDirectoryReader.php b/includes/ZipDirectoryReader.php index 37934aea..0e84583f 100644 --- a/includes/ZipDirectoryReader.php +++ b/includes/ZipDirectoryReader.php @@ -1,4 +1,24 @@ <?php +/** + * ZIP file directories reader, for the purposes of upload verification. + * + * 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 + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License along + * with this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + * http://www.gnu.org/copyleft/gpl.html + * + * @file + */ /** * A class for reading ZIP file directories, for the purposes of upload @@ -297,7 +317,7 @@ class ZipDirectoryReader { * Find the location of the central directory, as would be seen by a * ZIP64-compliant reader. * - * @return List containing offset, size and end position. + * @return array List containing offset, size and end position. */ function findZip64CentralDirectory() { // The spec is ambiguous about the exact rules of precedence between the @@ -426,6 +446,7 @@ class ZipDirectoryReader { /** * Interpret ZIP64 "extra field" data and return an associative array. + * @return array|bool */ function unpackZip64Extra( $extraField ) { $extraHeaderInfo = array( @@ -473,8 +494,8 @@ class ZipDirectoryReader { * Get the file contents from a given offset. If there are not enough bytes * in the file to satisfy the request, an exception will be thrown. * - * @param $start The byte offset of the start of the block. - * @param $length The number of bytes to return. If omitted, the remainder + * @param $start int The byte offset of the start of the block. + * @param $length int The number of bytes to return. If omitted, the remainder * of the file will be returned. * * @return string @@ -520,6 +541,7 @@ class ZipDirectoryReader { * If there are not enough bytes in the file to satsify the request, the * return value will be truncated. If a request is made for a segment beyond * the end of the file, an empty string will be returned. + * @return string */ function getSegment( $segIndex ) { if ( !isset( $this->buffer[$segIndex] ) ) { @@ -542,6 +564,7 @@ class ZipDirectoryReader { /** * Get the size of a structure in bytes. See unpack() for the format of $struct. + * @return int */ function getStructSize( $struct ) { $size = 0; @@ -560,9 +583,9 @@ class ZipDirectoryReader { * Unpack a binary structure. This is like the built-in unpack() function * except nicer. * - * @param $string The binary data input + * @param $string string The binary data input * - * @param $struct An associative array giving structure members and their + * @param $struct array An associative array giving structure members and their * types. In the key is the field name. The value may be either an * integer, in which case the field is a little-endian unsigned integer * encoded in the given number of bytes, or an array, in which case the @@ -571,9 +594,9 @@ class ZipDirectoryReader { * - "string": The second array element gives the length of string. * Not null terminated. * - * @param $offset The offset into the string at which to start unpacking. + * @param $offset int The offset into the string at which to start unpacking. * - * @return Unpacked associative array. Note that large integers in the input + * @return array Unpacked associative array. Note that large integers in the input * may be represented as floating point numbers in the return value, so * the use of weak comparison is advised. */ @@ -628,7 +651,8 @@ class ZipDirectoryReader { * boolean. * * @param $value integer - * @param $bitIndex The index of the bit, where 0 is the LSB. + * @param $bitIndex int The index of the bit, where 0 is the LSB. + * @return bool */ function testBit( $value, $bitIndex ) { return (bool)( ( $value >> $bitIndex ) & 1 ); @@ -672,10 +696,10 @@ class ZipDirectoryReader { * Internal exception class. Will be caught by private code. */ class ZipDirectoryReaderError extends Exception { - var $code; + var $errorCode; function __construct( $code ) { - $this->code = $code; + $this->errorCode = $code; parent::__construct( "ZipDirectoryReader error: $code" ); } @@ -683,6 +707,6 @@ class ZipDirectoryReaderError extends Exception { * @return mixed */ function getErrorCode() { - return $this->code; + return $this->errorCode; } } |