Class: File_Archive_Reader_Cab

Source Location: /File_Archive-1.5.5/File/Archive/Reader/Cab.php

Class Overview

File_Archive_Reader
   |
   --File_Archive_Reader_Archive
      |
      --File_Archive_Reader_Cab

Read a CAB file without uncompressing the data

Variables

Methods

Inherited Variables

Class: File_Archive_Reader_Archive

File_Archive_Reader_Archive::$source

Inherited Methods

Class: File_Archive_Reader_Archive

File_Archive_Reader_Archive::File_Archive_Reader_Archive()
File_Archive_Reader_Archive::close(): Close the source if it was given closed in the constructor
File_Archive_Reader_Archive::next()

Class: File_Archive_Reader

File_Archive_Reader::close(): Put back the reader in the state it was before the first call
File_Archive_Reader::extract(): Sends the whole reader to $writer and close the reader
File_Archive_Reader::extractFile(): Extract only one file (given by the URL)
File_Archive_Reader::getData(): Reads some data from the current file
File_Archive_Reader::getDataFilename(): If the current file of the archive is a physical file,
File_Archive_Reader::getFileList(): Returns the list of filenames from the current pos to the end of the source The source will be closed after having called this function This function goes through the whole archive (which may be slow).
File_Archive_Reader::getFilename(): Returns the name of the file currently read by the reader
File_Archive_Reader::getMime(): Returns the MIME associated with the current file
File_Archive_Reader::getStandardURL(): Returns the standard path
File_Archive_Reader::getStat(): Returns an array of statistics about the file (see the PHP stat function for more information)
File_Archive_Reader::makeAppendWriter(): Return a writer that allows appending files to the archive After having called makeAppendWriter, $this is closed and should not be used until the returned writer is closed.
File_Archive_Reader::makeWriterRemove(): Returns a writer that removes the current file
File_Archive_Reader::makeWriterRemoveBlocks(): Return a writer that has the same properties as the one returned by makeWriter, but after having removed a block of data from the current file. The writer will append data to the current file no data (other than the block) will be removed
File_Archive_Reader::makeWriterRemoveFiles(): Return a writer that has the same properties as the one returned by makeAppendWriter, but after having removed all the files that follow a given predicate.
File_Archive_Reader::next(): Move to the next file or folder in the reader
File_Archive_Reader::remove(): Removes the current file from the reader
File_Archive_Reader::rewind(): Move the current position back of a given amount of bytes.
File_Archive_Reader::select(): Move to the next file whose name is in directory $filename or is exactly $filename
File_Archive_Reader::sendData(): Sends the current file to the Writer $writer
File_Archive_Reader::skip(): Skip some data and returns how many bytes have been skipped
File_Archive_Reader::tell(): Returns the current offset in the current file

Class Details

[line 41]
Read a CAB file without uncompressing the data

This is not intented to be used directly by the end user, but by the cab reader which adds the uncompression layer

[ Top ]

Class Variables

$blockOffset = 0

[line 67]

Var: Current offset inside the block

Type:

int

[ Top ]

$data = ''

[line 77]

Var: Data read from last data block

Type:

string

[ Top ]

$fileIndex = 0

[line 57]

Var: Index of the file being read in the current folder

Type:

int

[ Top ]

$folderIndex = 0

[line 52]

Var: Index of the folder being read

Type:

int

[ Top ]

$header = null

[line 72]

Var: Header of the cabinet file

Type:

array

[ Top ]

$offset = 0

[line 62]

Var: Current offset inside the folder

Type:

int

[ Top ]

Method Detail

close [line 424]

void close(
)

See: File_Archive_Reader::close()

Overrides File_Archive_Reader_Archive::close() (Close the source if it was given closed in the constructor)

[ Top ]

getData [line 286]

void getData(
[
$length = -1])

See: File_Archive_Reader::getData()

Overrides File_Archive_Reader::getData() (Reads some data from the current file)

Parameters:

$length —

[ Top ]

getFilename [line 439]

void getFilename(
)

See: File_Archive_Reader::getFilename()

Overrides File_Archive_Reader::getFilename() (Returns the name of the file currently read by the reader)

[ Top ]

getStat [line 446]

void getStat(
)

See: File_Archive_Reader::getStat()

Overrides File_Archive_Reader::getStat() (Returns an array of statistics about the file (see the PHP stat function for more information))

[ Top ]

next [line 82]

void next(
)

See: File_Archive_Reader::next()

Overrides File_Archive_Reader_Archive::next() (parent method not documented)

[ Top ]

rewind [line 385]

void rewind(
[
$length = -1])

See: File_Archive_Reader::rewind()

Overrides File_Archive_Reader::rewind() (Move the current position back of a given amount of bytes.)

Parameters:

$length —

[ Top ]

select [line 468]

void select(

$filename, [
$close = true])

See: File_Archive_Reader::select()

Overrides File_Archive_Reader::select() (Move to the next file whose name is in directory $filename or is exactly $filename)

Parameters:

	`$filename`	—
	`$close`	—

[ Top ]

skip [line 371]

void skip(
[
$length = -1])

See: File_Archive_Reader::skip()

Overrides File_Archive_Reader::skip() (Skip some data and returns how many bytes have been skipped)

Parameters:

$length —

[ Top ]

tell [line 415]

void tell(
)

See: File_Archive_Reader::tell()

Overrides File_Archive_Reader::tell() (Returns the current offset in the current file)

[ Top ]