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


Classes:
File_Archive
   File_Archive
   File_Archive_Predicate
   File_Archive_Predicate_And
   File_Archive_Predicate_Current
   File_Archive_Predicate_Custom
   File_Archive_Predicate_Duplicate
   File_Archive_Predicate_Ereg
   File_Archive_Predicate_Eregi
   File_Archive_Predicate_Extension
   File_Archive_Predicate_False
   File_Archive_Predicate_Index
   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_Preg
   File_Archive_Predicate_TARCompatible
   File_Archive_Predicate_True
   File_Archive_Reader
   File_Archive_Reader_Ar
   File_Archive_Reader_Archive
   File_Archive_Reader_Bzip2
   File_Archive_Reader_Cab
   File_Archive_Reader_Cache
   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_Rar
   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_AddBaseName
   File_Archive_Writer_Ar
   File_Archive_Writer_Archive
   File_Archive_Writer_Bzip2
   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_UniqueAppender
   File_Archive_Writer_Zip

Class: File_Archive_Writer_Files

Source Location: /File_Archive-1.5.5/File/Archive/Writer/Files.php

Class Overview

File_Archive_Writer
   |
   --File_Archive_Writer_Files

Writer to files

Variables

Methods

Inherited Variables

Inherited Methods

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::newFileNeedsMIME()
Returns whether the writer newFile function needs the $mime parameter
File_Archive_Writer::newFromTempFile()
Create a new file in the writer with the content of the physical file $filename and then unlink $filename.
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 37]
Writer to files


[ Top ]

Class Variables

$basePath =

[line 44]


Type:   mixed


[ Top ]

$filename =

[line 46]


Type:   mixed


[ Top ]

$stat = array()

[line 45]


Type:   mixed


[ Top ]


Method Detail

File_Archive_Writer_Files (Constructor)   [line 48]

File_Archive_Writer_Files File_Archive_Writer_Files( [ $base = ''])


Parameters:

   $base   — 

[ Top ]

close   [line 228]

void close( )

  • See: File_Archive_Writer::close()

Overrides File_Archive_Writer::close() (Close the writer, eventually flush the data, write the footer...)
[ Top ]

getFilename   [line 61]

void getFilename( $filename)


Parameters:

   $filename   — 

[ Top ]

newFile   [line 174]

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

  • See: File_Archive_Writer::newFile()

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

Parameters:

   $filename   — 
   $stat   — 
   $mime   — 

[ Top ]

newFromTempFile   [line 206]

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

  • See: File_Archive_Writer::newFromTempFile()

Overrides File_Archive_Writer::newFromTempFile() (Create a new file in the writer with the content of the physical file $filename and then unlink $filename.)

Parameters:

   $tmpfile   — 
   $filename   — 
   $stat   — 
   $mime   — 

[ Top ]

openFile   [line 104]

void openFile( string $filename, [int $pos = 0], $stat 2)

Open a file for writing from a given position

Parameters:

string   $filename   —  The name of the file to open
int   $pos   —  the initial position in the file
$stat   2   —  the stats of the file

[ Top ]

openFileRemoveBlock   [line 127]

void openFileRemoveBlock( $filename, $pos, $blocks)

Open a file for appending after having removed a block of data from it

See File_Archive_Reader::makeWriterRemoveBlocks


Parameters:

   $filename   — 
   $pos   — 
   $blocks   — 

[ Top ]

writeData   [line 202]

void writeData( $data)

  • See: File_Archive_Writer::writeData()

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

Parameters:

   $data   — 

[ Top ]
Documentation generated on Mon, 11 Mar 2019 15:48:27 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.