Class: VArchiveZip

Source Location: /libraries/vwp/archive/drivers/zip.php

Class Overview [line 47]

VType
   |
   --VObject
      |
      --VArchive
         |
         --VArchiveZip

VWP Zip archive driver

Author(s):

Version:

Copyright:

  • (c) Ralph Ritoch - All Rights Reserved

Variables

Constants

Methods

Inherited Variables

Class: VArchive

VArchive::$_vfile
VArchive::$_vfolder

Class: VObject

VObject::$_nosave_errors
VObject::$_nosave_original_state

Inherited Constants

Inherited Methods

Class: VArchive

VArchive::__construct()
Class constructor
VArchive::create()
Create an archive
VArchive::extract()
Extract an archive
VArchive::getDriver()
Get archive driver
VArchive::getInstance()
Get a VArchive object
VArchive::_cleanPath()
Clean file path
VArchive::_createArchiveFileList()
Reformat a list of files into an archive file list

Class: VObject

VObject::__construct()
Class Constructor
VObject::bind()
Bind values to this object
VObject::delete()
Delete Object
VObject::get()
Get value
VObject::getAll()
Get all object values
VObject::getError()
Get error message
VObject::getErrors()
Get errors
VObject::getMethods()
Get object methods
VObject::getProperties()
Get object properties
VObject::save()
Save Object
VObject::set()
Set a value
VObject::setError()
Set error value
VObject::setProperties()
Set property values
VObject::setProperty()
Set property value
VObject::toString()
Convert object to string
VObject::__destruct()
Class Destructor
VObject::__get()
VObject::__isset()
VObject::__set()
VObject::__toString()
Return object as a string
VObject::__unset()

Class Details

VWP Zip archive driver

This class provides the VWP Zip archive driver

Tags:

[ Top ]

Class Variables

$_ctrlDirEnd =  "\x50\x4b\x05\x06\x00\x00\x00\x00"

[line 84]

End of central directory record.

Tags:

  • var - Central Directory Footer
  • access - protected

Type: string

Overrides:

[ Top ]

$_ctrlDirHeader =  "\x50\x4b\x01\x02"

[line 75]

Beginning of central directory record.

Tags:

  • var - Central Directory Header
  • access - protected

Type: string

Overrides:

[ Top ]

$_data =  null

[line 102]

ZIP file data buffer

Tags:

  • var - File data
  • access - protected

Type: string

Overrides:

[ Top ]

$_fileHeader =  "\x50\x4b\x03\x04"

[line 93]

Beginning of file contents.

Tags:

  • var - File Header
  • access - protected

Type: string

Overrides:

[ Top ]

$_metadata =  null

[line 111]

ZIP file metadata array

Tags:

  • var - Metadata
  • access - protected

Type: array

Overrides:

[ Top ]

$_methods = array (
                             0x0 => 'None',
                             0x1 => 'Shrunk',
                             0x2 => 'Super Fast',
                             0x3 => 'Fast',
                             0x4 => 'Normal',
                             0x5 => 'Maximum',
                             0x6 => 'Imploded',
                             0x8 => 'Deflated'
                            )

[line 57]

ZIP compression methods.

Tags:

  • var - array
  • access - protected

Type: $_methods

Overrides:

[ Top ]

Class Methods

checkZipData

boolean checkZipData( &$data, string $data)

[line 186]

Checks to see if the data is a valid ZIP file.

Tags:

  • return - True if valid, false if invalid.
  • access - public

Parameters:

  • string $data - ZIP archive data buffer
  • &$data -

[ Top ]

create

boolean|object True create( string $archive, array $files, [array $options = array ()], [string $compress = 'zip'], [string $addPath = ''], [string $removePath = ''], [boolean $autoExt = false], [boolean $cleanUp = false])

[line 128]

Create a ZIP compressed file from an array of file data.

Tags:

  • return - if successful object or warning on failure
  • access - public

Overrides VArchive::create() (Create an archive)

Parameters:

  • string $archive - Path to save archive
  • array $files - Array of files to add to archive
  • array $options - Compression options [unused]
  • string $compress - Compression method
  • string $addPath - add Path
  • string $removePath - remove path
  • boolean $autoExt - Auto extension
  • boolean $cleanUp - Clean Up

[ Top ]

extract

boolean extract( string $archive, string $destination, [array $options = array ()])

[line 152]

Extract a ZIP compressed file to a given path

Tags:

  • return - True if successful
  • access - public

Overrides VArchive::extract() (Extract an archive)

Parameters:

  • string $archive - Path to ZIP archive to extract
  • string $destination - Path to extract archive into
  • array $options - Extraction options [unused]

[ Top ]

hasNativeSupport

boolean hasNativeSupport( )

[line 173]

Method to determine if the server has native zip support for faster handling

Tags:

  • return - True if php has native ZIP support
  • access - public

Parameters:

[ Top ]

Class Constants

Documentation generated on Sun, 06 Mar 2011 02:22:35 -0600 by phpDocumentor 1.4.3