tasks/ext/ZipTask.php
Show:
inherited
inherited
Classes
\ZipFileSet
Package: phing\tasks\ext
Parameters
This is a FileSet with the to specify permissions.
Permissions are currently not implemented by PEAR Archive_Tar, but hopefully they will be in the future.
- Parent(s)
- \FileSet < \AbstractFileSet < \DataType < \ProjectComponent
Properties
Methods
__clone(
)
:
void__construct(
)
:
voidappendSelector(
)
:
voidcircularReference(
)
:
voidcreateAnd(
)
:
voidcreateContains(
)
:
voidcreateContainsRegexp(
)
:
voidcreateCustom(
)
:
voidcreateDate(
)
:
voidcreateDepend(
)
:
voidcreateDepth(
)
:
voidcreateExclude(
)
:
voidcreateExcludesFile(
)
:
voidcreateFilename(
)
:
voidcreateInclude(
)
:
voidcreateIncludesFile(
)
:
voidcreateMajority(
)
:
voidcreateNone(
)
:
voidcreateNot(
)
:
voidcreateOr(
)
:
voidcreatePatternSet(
)
:
voidcreatePresent(
)
:
voidcreateSelector(
)
:
voidcreateSize(
)
:
voidcreateType(
)
:
voiddieOnCircularReference(
)
:
voidgetCheckedRef(
)
:
voidgetDescription(
)
:
voidgetDir(
)
:
voidgetDirectoryScanner(
)
:
voidgetFiles(
$p, $includeEmpty
=
true
)
:
voidGet a list of files and directories specified in the fileset.
@return array a list of file and directory names, relative to the baseDir for the project.
| Name | Type | Description |
|---|---|---|
| $p | ||
| $includeEmpty |
getProject(
)
:
voidgetRef(
)
:
voidgetSelectors(
)
:
voidhasPatterns(
)
:
voidhasSelectors(
)
:
voidisReference(
)
:
voidlog(
)
:
voidnoChildrenAllowed(
)
:
voidparsingComplete(
)
:
voidselectorCount(
)
:
voidselectorElements(
)
:
voidsetCaseSensitive(
)
:
voidsetDefaultexcludes(
)
:
voidsetDescription(
)
:
voidsetDir(
)
:
voidsetExcludes(
)
:
voidsetExcludesfile(
)
:
voidsetExpandSymbolicLinks(
)
:
voidsetIncludes(
)
:
voidsetIncludesfile(
)
:
voidsetProject(
)
:
voidsetRefid(
)
:
voidsetupDirectoryScanner(
)
:
voidtooManyAttributes(
)
:
void\ZipTask
Package: phing\tasks\ext
Creates a zip archive using PHP ZipArchive extension/
- Parent(s)
- \MatchingTask < \Task < \ProjectComponent
- Author
- Michiel Rook
- Since
- 2.1.0
- Version
- $Id: ZipTask.php 1379 2011-12-07 19:59:40Z mrook $
Properties
$fileSetFiles= 'array()'
Default value
array()Details- Type
- n/a
$filesets= 'array()'
Default value
array()Details- Type
- n/a
$includeEmpty= 'true'
Whether to include empty dirs in the archive.
Default value
trueDetails- Type
- n/a
string
$prefix= 'null'
File path prefix in zip archive
Default value
nullDetails- Type
- string
Methods
__construct(
)
:
voidappendSelector(
)
:
voidarchiveIsUpToDate(
array $files, \PhingFile $dir
)
:
boolean
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $files | array | array of filenames |
| $dir | \PhingFile |
| Type | Description |
|---|---|
| boolean |
createAnd(
)
:
voidcreateContains(
)
:
voidcreateCustom(
)
:
voidcreateDate(
)
:
voidcreateDepend(
)
:
voidcreateDepth(
)
:
voidcreateExclude(
)
:
voidcreateExcludesFile(
)
:
voidcreateFilename(
)
:
voidcreateInclude(
)
:
voidcreateIncludesFile(
)
:
voidcreateMajority(
)
:
voidcreateNone(
)
:
voidcreateNot(
)
:
voidcreateOr(
)
:
voidcreatePatternSet(
)
:
voidcreatePresent(
)
:
voidcreateSelector(
)
:
voidcreateSize(
)
:
voidgetDescription(
)
:
voidgetDirectoryScanner(
)
:
voidgetImplicitFileSet(
)
:
void
final
getLocation(
)
:
voidgetOwningTarget(
)
:
voidgetProject(
)
:
voidgetRegisterSlot(
)
:
voidgetRuntimeConfigurableWrapper(
)
:
voidgetSelectors(
)
:
voidgetTaskName(
)
:
voidgetTaskType(
)
:
voidhasSelectors(
)
:
voidinit(
)
:
voidlog(
)
:
voidmaybeConfigure(
)
:
voidperform(
)
:
voidselectorCount(
)
:
voidselectorElements(
)
:
voidsetBasedir(
\PhingFile $baseDir
)
:
voidThis is the base directory to look in for things to zip.
Parameters
| Name | Type | Description |
|---|---|---|
| $baseDir | \PhingFile |
setCaseSensitive(
)
:
voidsetDefaultexcludes(
)
:
voidsetDescription(
)
:
voidsetDestFile(
\PhingFile $destFile
)
:
voidSet is the name/location of where to create the zip file.
Parameters
| Name | Type | Description |
|---|---|---|
| $destFile | \PhingFile | The output of the zip |
setExcludes(
)
:
voidsetExcludesfile(
)
:
voidsetFollowSymlinks(
)
:
voidsetIncludeEmptyDirs(
boolean $bool
)
:
voidSet the include empty dirs flag.
Parameters
Details
| Name | Type | Description |
|---|---|---|
| $bool | boolean | Flag if empty dirs should be tarred too |
- Access
- public
setIncludes(
)
:
voidsetIncludesfile(
)
:
voidsetLocation(
)
:
voidsetOwningTarget(
)
:
voidsetPrefix(
string $prefix
)
:
voidSets the file path prefix for file in the zip file.
Parameters
| Name | Type | Description |
|---|---|---|
| $prefix | string | Prefix |
setProject(
)
:
voidsetRuntimeConfigurableWrapper(
)
:
voidsetTaskName(
)
:
voidsetTaskType(
)
:
void