# tasks/ext/ZipTask.php

## \ZipFileSet
jump to top

Package: phing\tasks\ext

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

`$files= 'null'`
Default value `null` Details

Type
  n/a

### Methods

`__clone( ) : void`

`__construct( ) : void`

`appendSelector( ) : void`

`circularReference( ) : void`

`createAnd( ) : void`

`createContains( ) : void`

`createContainsRegexp( ) : void`

`createCustom( ) : void`

`createDate( ) : void`

`createDepend( ) : void`

`createDepth( ) : void`

`createExclude( ) : void`

`createExcludesFile( ) : void`

`createFilename( ) : void`

`createInclude( ) : void`

`createIncludesFile( ) : void`

`createMajority( ) : void`

`createNone( ) : void`

`createNot( ) : void`

`createOr( ) : void`

`createPatternSet( ) : void`

`createPresent( ) : void`

`createSelector( ) : void`

`createSize( ) : void`

`createType( ) : void`

`dieOnCircularReference( ) : void`

`getCheckedRef( ) : void`

`getDescription( ) : void`

`getDir( ) : void`

`getDirectoryScanner( ) : void`

`getFiles( $p, $includeEmpty = true ) : void`

Get 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.

Parameters

Name | Type | Description
--- | --- | ---
$p |  |
$includeEmpty |  |

`getProject( ) : void`

`getRef( ) : void`

`getSelectors( ) : void`

`hasPatterns( ) : void`

`hasSelectors( ) : void`

`isReference( ) : void`

`log( ) : void`

`noChildrenAllowed( ) : void`

`parsingComplete( ) : void`

`selectorCount( ) : void`

`selectorElements( ) : void`

`setCaseSensitive( ) : void`

`setDefaultexcludes( ) : void`

`setDescription( ) : void`

`setDir( ) : void`

`setExcludes( ) : void`

`setExcludesfile( ) : void`

`setExpandSymbolicLinks( ) : void`

`setIncludes( ) : void`

`setIncludesfile( ) : void`

`setProject( ) : void`

`setRefid( ) : void`

`setupDirectoryScanner( ) : void`

`tooManyAttributes( ) : void`

## \ZipTask
jump to top

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

`\PhingFile $baseDir= ''`

Details

Type
  \PhingFile

`$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 `true` Details

Type
  n/a

`string $prefix= 'null'`

File path prefix in zip archive

Default value `null` Details

Type
  string

`\PhingFile $zipFile= ''`

Details

Type
  \PhingFile

### Methods

`__construct( ) : void`

`appendSelector( ) : void`

`archiveIsUpToDate( array $files, \PhingFile $dir ) : boolean`

Parameters

Name | Type | Description
--- | --- | ---
$files | array | array of filenames
$dir | \PhingFile |

Returns

Type | Description
--- | ---
boolean |

`createAnd( ) : void`

`createContains( ) : void`

`createCustom( ) : void`

`createDate( ) : void`

`createDepend( ) : void`

`createDepth( ) : void`

`createExclude( ) : void`

`createExcludesFile( ) : void`

`createFileSet( ) : \FileSet`

Add a new fileset.

Returns

Type | Description
--- | ---
\FileSet |

`createFilename( ) : void`

`createInclude( ) : void`

`createIncludesFile( ) : void`

`createMajority( ) : void`

`createNone( ) : void`

`createNot( ) : void`

`createOr( ) : void`

`createPatternSet( ) : void`

`createPresent( ) : void`

`createSelector( ) : void`

`createSize( ) : void`

`getDescription( ) : void`

`getDirectoryScanner( ) : void`

`getImplicitFileSet( ) : void`
final

`getLocation( ) : void`

`getOwningTarget( ) : void`

`getProject( ) : void`

`getRegisterSlot( ) : void`

`getRuntimeConfigurableWrapper( ) : void`

`getSelectors( ) : void`

`getTaskName( ) : void`

`getTaskType( ) : void`

`hasSelectors( ) : void`

`init( ) : void`

`log( ) : void`

`main( ) : void`

do the work

Throws

Exception | Description
--- | ---
\BuildException |

`maybeConfigure( ) : void`

`perform( ) : void`

`selectorCount( ) : void`

`selectorElements( ) : void`

`setBasedir( \PhingFile $baseDir ) : void`

This is the base directory to look in for things to zip.

Parameters

Name | Type | Description
--- | --- | ---
$baseDir | \PhingFile |

`setCaseSensitive( ) : void`

`setDefaultexcludes( ) : void`

`setDescription( ) : void`

`setDestFile( \PhingFile $destFile ) : void`

Set is the name/location of where to create the zip file.

Parameters

Name | Type | Description
--- | --- | ---
$destFile | \PhingFile | The output of the zip

`setExcludes( ) : void`

`setExcludesfile( ) : void`

`setFollowSymlinks( ) : void`

`setIncludeEmptyDirs( boolean $bool ) : void`

Set the include empty dirs flag.

Parameters

Name | Type | Description
--- | --- | ---
$bool | boolean | Flag if empty dirs should be tarred too

Details

Access
  public

`setIncludes( ) : void`

`setIncludesfile( ) : void`

`setLocation( ) : void`

`setOwningTarget( ) : void`

`setPrefix( string $prefix ) : void`

Sets the file path prefix for file in the zip file.

Parameters

Name | Type | Description
--- | --- | ---
$prefix | string | Prefix

`setProject( ) : void`

`setRuntimeConfigurableWrapper( ) : void`

`setTaskName( ) : void`

`setTaskType( ) : void`

Documentation was generated by DocBlox 0.17.1.