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

Class: PHP_Archive

Source Location: /PHP_Archive-0.5.0/Archive.php

Class Overview


PHP_Archive Class (implements .phar)


Author(s):

Version:

  • $Id: Archive.php,v 1.12 2005/05/03 18:35:48 cellog Exp $

Variables

Methods


Inherited Variables

Inherited Methods


Class Details

[line 27]
PHP_Archive Class (implements .phar)

PHAR files a singular archive from which an entire application can run. To use it, simply package it using {@see PHP_Archive_Creator} and use phar:// URIs to your includes. i.e. require_once 'phar://config.php' will include config.php from the root of the PHAR file.

Tar/Gz code borrowed from the excellent File_Archive package by Vincent Lascaux.



[ Top ]


Class Variables

$archiveName =  null

[line 35]

  • Var: Archive filename

Type:   string


[ Top ]

$currentFilename =  null

[line 44]

Current file name in the tar

Type:   string


[ Top ]

$currentStat =  null

[line 39]

Current Stat info of the current file in the tar

Type:   mixed


[ Top ]

$file =  null

[line 58]

  • Var: Content of the file being requested

Type:   string


[ Top ]

$footerLength =  0

[line 54]

Length of the current tar file's footer

Type:   int


[ Top ]

$internalFileLength =  0

[line 49]

Length of the current tar file

Type:   int


[ Top ]

$position =  0

[line 70]

  • Var: Current Position of the pointer

Type:   int


[ Top ]



Method Detail

APIVersion   [line 526]

void APIVersion( )


[ Top ]

cacheStat   [line 76]

void cacheStat( string $pharname)


Parameters:

string   $pharname   —  basename of the phar to cache stat from.

[ Top ]

dir_closedir   [line 513]

void dir_closedir( )


[ Top ]

dir_opendir   [line 462]

void dir_opendir( $path)

Open a directory in the .phar for reading

Parameters:

   $path   — 

[ Top ]

dir_readdir   [line 503]

void dir_readdir( )


[ Top ]

dir_rewinddir   [line 520]

void dir_rewinddir( )


[ Top ]

extractFile   [line 237]

void extractFile( $path)


Parameters:

   $path   — 

[ Top ]

initializeStream   [line 263]

bool initializeStream( string $file)

Start the stream

Opens the PHP Archive, which is the file being called


Parameters:

string   $file   — 

[ Top ]

stream_eof   [line 379]

void stream_eof( )

Whether we've hit the end of the file

[ Top ]

stream_open   [line 301]

void stream_open( string $file)

Open the requested file

Parameters:

string   $file   —  String provided by the Stream wrapper

[ Top ]

stream_read   [line 368]

void stream_read( int $count)

Read the data

Parameters:

int   $count   —  offset of the file to return

[ Top ]

stream_seek   [line 388]

void stream_seek( $pos, $whence)

For seeking the stream

Parameters:

   $pos   — 
   $whence   — 

[ Top ]

stream_stat   [line 427]

void stream_stat( )

The result of an fstat call, returns mod time from tar, and file size

[ Top ]

stream_tell   [line 418]

void stream_tell( )

The current position in the stream

[ Top ]

url_stat   [line 451]

void url_stat( $url, $flags)


Parameters:

   $url   — 
   $flags   — 

[ Top ]


Documentation generated on Mon, 11 Mar 2019 14:20:29 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.