Class: File_Archive_Reader_AddBaseName

Source Location: /File_Archive-1.5.1/File/Archive/Reader/ChangeName.php

Class Overview

File_Archive_Reader
   |
   --File_Archive_Reader_Relay
      |
      --File_Archive_Reader_AddBaseName

Add a directory to the public name of all the files of a reader

Inherited Variables

Class: File_Archive_Reader_Relay

File_Archive_Reader_Relay::$source

Inherited Methods

Class: File_Archive_Reader_Relay

File_Archive_Reader_Relay::File_Archive_Reader_Relay()
File_Archive_Reader_Relay::close()
File_Archive_Reader_Relay::getData()
File_Archive_Reader_Relay::getDataFilename()
File_Archive_Reader_Relay::getFilename()
File_Archive_Reader_Relay::getMime()
File_Archive_Reader_Relay::getStat()
File_Archive_Reader_Relay::makeAppendWriter()
File_Archive_Reader_Relay::makeWriterRemoveBlocks()
File_Archive_Reader_Relay::makeWriterRemoveFiles()
File_Archive_Reader_Relay::next()
File_Archive_Reader_Relay::rewind()
File_Archive_Reader_Relay::skip()
File_Archive_Reader_Relay::tell()

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 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 45]
Add a directory to the public name of all the files of a reader

Example: If archive.tar is a file archive containing files a.txt and foo/b.txt new File_Archive_Reader_AddBaseName('bar', new File_Archive_Reader_Tar( new File_Archive_Reader_File('archive.tar') ) ) is a reader containing files bar/a.txt and bar/foo/b.txt

[ Top ]

Class Variables

$baseName =

[line 47]

Type:

mixed

[ Top ]

Method Detail

File_Archive_Reader_AddBaseName (Constructor) [line 48]

File_Archive_Reader_AddBaseName File_Archive_Reader_AddBaseName(

$baseName, 
&$source)

Parameters:

	`$baseName`	—
	`&$source`	—

[ Top ]

getFileList [line 96]

void getFileList(
)

See: File_Archive_Reader::getFileList()

Overrides 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).)

[ Top ]

getFilename [line 89]

void getFilename(
)

See: File_Archive_Reader::getFilename()

Overrides File_Archive_Reader_Relay::getFilename() (parent method not documented)

[ Top ]

modifyName [line 57]

void modifyName(

$name)

Modify the name by adding baseName to it

Parameters:

$name —

[ Top ]

select [line 108]

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 ]

unmodifyName [line 68]

void unmodifyName(

$name)

Remove baseName from the name

Return false if the name doesn't start with baseName

Parameters:

$name —

[ Top ]