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

Class: File_Archive_Writer_Files

Source Location: /File_Archive-1.1.0/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::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 ]



Method Detail

File_Archive_Writer_Files (Constructor)   [line 46]

File_Archive_Writer_Files File_Archive_Writer_Files( [ $base = ''])


Parameters:

   $base   — 

[ Top ]

close   [line 165]

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 58]

void getFilename( $filename)


Parameters:

   $filename   — 

[ Top ]

newFile   [line 117]

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 144]

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 97]

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

Open a file for writing from a given position

Parameters:

   $filename   — 
   $pos   — 
   $stat   — 
   $mime   — 

[ Top ]

writeData   [line 140]

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 14:20:31 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.