PHP Class rg\broker\customizations\ZipArchive

Author: Baldur Rensch ([email protected])
Inheritance: extends ZipArchive
Show file Open project: researchgate/broker Class Usage Examples

Public Properties

Property Type Description
$archiveBaseDir string Contains the "base path" of the archive. This means that files will be added relative to this base path, instead of with absolute paths.

Protected Properties

Property Type Description
$excludeDirectories array Array containing directory names to exclude

Public Methods

Method Description
addDir ( String $path ) Add directories recursively
addExcludeDirectory ( [type] $dir ) Add a directory name to the list of directories to exclude
getArchiveBaseDir ( ) : String
getExcludeDirectories ( ) : array
setArchiveBaseDir ( $newArchiveBaseDir ) : ZipArchive
setExcludeDirectories ( array $newExcludeDirectories ) : ZipArchive

Method Details

addDir() public method

Add directories recursively
public addDir ( String $path )
$path String

addExcludeDirectory() public method

Add a directory name to the list of directories to exclude
public addExcludeDirectory ( [type] $dir )
$dir [type]

getArchiveBaseDir() public method

public getArchiveBaseDir ( ) : String
return String

getExcludeDirectories() public method

public getExcludeDirectories ( ) : array
return array

setArchiveBaseDir() public method

public setArchiveBaseDir ( $newArchiveBaseDir ) : ZipArchive
return ZipArchive

setExcludeDirectories() public method

public setExcludeDirectories ( array $newExcludeDirectories ) : ZipArchive
$newExcludeDirectories array
return ZipArchive

Property Details

$archiveBaseDir public property

Contains the "base path" of the archive. This means that files will be added relative to this base path, instead of with absolute paths.
public string $archiveBaseDir
return string

$excludeDirectories protected property

Array containing directory names to exclude
protected array $excludeDirectories
return array