* valid ZIP64 file, and working out what non-ZIP64 readers will make
* of such a file is not trivial.
*
- * @return Status object. The following fatal errors are defined:
+ * @return Status A Status object. The following fatal errors are defined:
*
* - zip-file-open-error: The file could not be opened.
*
/**
* Private constructor
+ * @param string $fileName
+ * @param callable $callback
+ * @param array $options
*/
protected function __construct( $fileName, $callback, $options ) {
$this->fileName = $fileName;
/**
* Throw an error, and log a debug message
+ * @param mixed $code
+ * @param string $debugMessage
*/
function error( $code, $debugMessage ) {
wfDebug( __CLASS__ . ": Fatal error: $debugMessage\n" );
* Find the location of the central directory, as would be seen by a
* non-ZIP64 reader.
*
- * @return List containing offset, size and end position.
+ * @return array List containing offset, size and end position.
*/
function findOldCentralDirectory() {
$size = $this->eocdr['CD size'];
/**
* Read the central directory at the given location
+ * @param int $offset
+ * @param int $size
*/
function readCentralDirectory( $offset, $size ) {
$block = $this->getBlock( $offset, $size );
/**
* Interpret ZIP64 "extra field" data and return an associative array.
+ * @param string $extraField
* @return array|bool
*/
function unpackZip64Extra( $extraField ) {
/**
* Get the length of the file.
+ * @return int
*/
function getFileLength() {
if ( $this->fileLength === null ) {
/**
* Get the size of a structure in bytes. See unpack() for the format of $struct.
+ * @param array $struct
* @return int
*/
function getStructSize( $struct ) {
* Returns a bit from a given position in an integer value, converted to
* boolean.
*
- * @param $value integer
+ * @param int $value
* @param int $bitIndex The index of the bit, where 0 is the LSB.
* @return bool
*/
/**
* Debugging helper function which dumps a string in hexdump -C format.
+ * @param string $s
*/
function hexDump( $s ) {
$n = strlen( $s );