apidoc
[ class tree: apidoc ] [ index: apidoc ] [ all elements ]
Packages:
File_Archive


Classes:
File_Archive-0.2.0
   File_Archive
   File_Archive_Predicate
   File_Archive_Predicate_And
   File_Archive_Predicate_Custom
   File_Archive_Predicate_Ereg
   File_Archive_Predicate_Eregi
   File_Archive_Predicate_Extension
   File_Archive_Predicate_False
   File_Archive_Predicate_MaxDepth
   File_Archive_Predicate_MIME
   File_Archive_Predicate_MinSize
   File_Archive_Predicate_MinTime
   File_Archive_Predicate_Not
   File_Archive_Predicate_Or
   File_Archive_Predicate_TARCompatible
   File_Archive_Predicate_True
   File_Archive_Reader
   File_Archive_Reader_AddBaseName
   File_Archive_Reader_Archive
   File_Archive_Reader_ChangeBaseName
   File_Archive_Reader_Concat
   File_Archive_Reader_Directory
   File_Archive_Reader_File
   File_Archive_Reader_Filter
   File_Archive_Reader_Gzip
   File_Archive_Reader_Memory
   File_Archive_Reader_Multi
   File_Archive_Reader_Relay
   File_Archive_Reader_Select
   File_Archive_Reader_Tar
   File_Archive_Reader_Uncompress
   File_Archive_Reader_Zip
   File_Archive_Writer
   File_Archive_Writer_Archive
   File_Archive_Writer_Files
   File_Archive_Writer_Gzip
   File_Archive_Writer_Mail
   File_Archive_Writer_Memory
   File_Archive_Writer_MemoryArchive
   File_Archive_Writer_Multi
   File_Archive_Writer_Output
   File_Archive_Writer_Tar
   File_Archive_Writer_Zip
   Test

Class: File_Archive_Writer_MemoryArchive

Source Location: /File_Archive-0.2.0/File/Archive/Writer/MemoryArchive.php

Class Overview

File_Archive_Writer
   |
   --File_Archive_Writer_Archive
      |
      --File_Archive_Writer_MemoryArchive

Base class for all the archiveWriters that can only work on complete files

Variables

Methods

Child classes:

File_Archive_Writer_Gzip
Compress a single file to Gzip format
File_Archive_Writer_Tar
Write the files as a TAR archive
File_Archive_Writer_Zip
ZIP archive writer

Inherited Variables

Inherited Methods

Class: File_Archive_Writer_Archive

File_Archive_Writer_Archive::File_Archive_Writer_Archive()
File_Archive_Writer_Archive::close()
File_Archive_Writer_Archive::getMime()

Class: File_Archive_Writer

File_Archive_Writer::close()
Close the writer, eventually flush the data, write the footer...
File_Archive_Writer::newFile()
Create a new file in the writer
File_Archive_Writer::writeData()
Append the specified data to the writer
File_Archive_Writer::writeFile()
Append the content of the physical file $filename to the writer writeFile($filename) must be equivalent to writeData(file_get_contents($filename)) but can be more efficient

Class Details

[line 40]
Base class for all the archiveWriters that can only work on complete files

(the write data function may be called with small chunks of data)



[ Top ]

Class Variables

$nbFiles =  0

[line 67]

  • Var: Number of times newFile function has been called
  • Access: protected

Type:   int


[ Top ]


Method Detail

File_Archive_Writer_MemoryArchive (Constructor)   [line 72]

File_Archive_Writer_MemoryArchive File_Archive_Writer_MemoryArchive( mixed $filename, mixed &$t, [mixed $stat = array()], [mixed $autoClose = true])

  • See: File_Archive_Writer::File_Archive_Writer()

[ Top ]

appendFile   [line 193]

void appendFile( mixed $filename, mixed $dataFilename)

The subclass may rewrite this class if it knows an efficient way to treat a physical file.
  • Access: protected

Overridden in child classes as:

File_Archive_Writer_Tar::appendFile()

[ Top ]

appendFileData   [line 170]

void appendFileData( mixed $filename, mixed $stat, mixed $data)

The subclass must treat the data $data $data is the entire data of the filename $filename $stat is the stat of the file
  • Access: protected

Overridden in child classes as:

File_Archive_Writer_Gzip::appendFileData()
File_Archive_Writer_Tar::appendFileData()
File_Archive_Writer_Zip::appendFileData()

[ Top ]

close   [line 106]

void close( )

  • See: File_Archive_Writer::close()

Overrides File_Archive_Writer_Archive::close() (parent method not documented)
[ Top ]

newFile   [line 81]

void newFile( mixed $filename, [mixed $stat = array()], [mixed $mime = "application/octet-stream"])

  • See: File_Archive_Writer::newFile()

Overrides File_Archive_Writer::newFile() (Create a new file in the writer)
[ Top ]

sendFooter   [line 186]

void sendFooter( )

The subclass may rewrite the sendFooter function if it needs to execute code before closing the archive
  • Access: protected

Overridden in child classes as:

File_Archive_Writer_Tar::sendFooter()
File_Archive_Writer_Zip::sendFooter()

[ Top ]

sendHeader   [line 179]

void sendHeader( )

The subclass may rewrite the sendHeader function if it needs to execute code before the first file
  • Access: protected

[ Top ]

writeData   [line 149]

void writeData( mixed $data)

  • See: File_Archive_Writer::writeData()

Overrides File_Archive_Writer::writeData() (Append the specified data to the writer)
[ Top ]

writeFile   [line 153]

void writeFile( mixed $filename)

  • See: File_Archive_Writer::writeFile()

Overrides File_Archive_Writer::writeFile() (Append the content of the physical file $filename to the writer writeFile($filename) must be equivalent to writeData(file_get_contents($filename)) but can be more efficient)
[ Top ]
Documentation generated on Thu, 24 Feb 2005 12:50:18 -0500 by phpDocumentor 1.2.3. PEAR Logo Copyright © PHP Group 2004.