tasks/ext/ZipTask.php

Show:

inherited

Classes
- \ZipFileSet
- \ZipTask

Table of Contents

Creates a zip archive using PHP ZipArchive extension/

Author: Michiel Rook
Package: phing.tasks.ext
Since: 2.1.0
Version: $Id: 6997b3f3abffedf1b2efabc40c3b2d012b2379cb $

\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
Author: Hans Lellelid (Phing)
Author: Arnout J. Kuiper (Ant)
Author: Stefano Mazzocchi (Ant)
Author: Sam Ruby (Ant)
Author: Jon S. Stevens (Ant)
Author: Stefan Bodewig (Ant)
Author: Magesh Umasankar (Ant)
Version: $Id$

Properties


                 $additionalPatterns= 'array()'

inheritedInherited from: \AbstractFileSet::$$additionalPatterns \FileSet::$$additionalPatterns

Default valuearray()Details

Type: n/a
Inherited_from: \AbstractFileSet::$$additionalPatterns
Inherited_from: \FileSet::$$additionalPatterns

boolean
                 $checked= 'true'

inherited

Are we sure we don't hold circular references?

Inherited from: \DataType::$$checked \AbstractFileSet::$$checked \FileSet::$$checked

Subclasses are responsible for setting this value to false if we'd need to investigate this condition (usually because a child element has been added that is a subclass of DataType).

Default valuetrueDetails

Type: boolean
Inherited_from: \DataType::$$checked
Inherited_from: \AbstractFileSet::$$checked
Inherited_from: \FileSet::$$checked

\PatternSet
                 $defaultPatterns= ''

inherited

Inherited from: \AbstractFileSet::$$defaultPatterns \FileSet::$$defaultPatterns

Details

Type: \PatternSet
Inherited_from: \AbstractFileSet::$$defaultPatterns
Inherited_from: \FileSet::$$defaultPatterns


                 $description= 'null'

inherited

The descriptin the user has set.

Inherited from: \DataType::$$description \AbstractFileSet::$$description \FileSet::$$description

Default valuenullDetails

Type: n/a
Inherited_from: \DataType::$$description
Inherited_from: \AbstractFileSet::$$description
Inherited_from: \FileSet::$$description


                 $dir= ''

inheritedInherited from: \AbstractFileSet::$$dir \FileSet::$$dir

Details

Type: n/a
Inherited_from: \AbstractFileSet::$$dir
Inherited_from: \FileSet::$$dir

boolean
                 $expandSymbolicLinks= 'false'

inherited

Whether to expand/dereference symbolic links, default is false

Inherited from: \AbstractFileSet::$$expandSymbolicLinks \FileSet::$$expandSymbolicLinks

Default valuefalseDetails

Type: boolean
Inherited_from: \AbstractFileSet::$$expandSymbolicLinks
Inherited_from: \FileSet::$$expandSymbolicLinks


                 $files= 'null'

Default valuenullDetails

Type: n/a


                 $isCaseSensitive= 'true'

inheritedInherited from: \AbstractFileSet::$$isCaseSensitive \FileSet::$$isCaseSensitive

Default valuetrueDetails

Type: n/a
Inherited_from: \AbstractFileSet::$$isCaseSensitive
Inherited_from: \FileSet::$$isCaseSensitive

\Project
                 $project= 'null'

inherited

Holds a reference to the project that a project component (a task, a target, etc.) belongs to

A reference to the current project instanceInherited from: \ProjectComponent::$$project \DataType::$$project \AbstractFileSet::$$project \FileSet::$$project

Default valuenullDetails

Type: \Project
Inherited_from: \ProjectComponent::$$project
Inherited_from: \DataType::$$project
Inherited_from: \AbstractFileSet::$$project
Inherited_from: \FileSet::$$project


                 $ref= 'null'

inherited

Value to the refid attribute. Type of Reference

Inherited from: \DataType::$$ref \AbstractFileSet::$$ref \FileSet::$$ref

Default valuenullDetails

Type: n/a
Inherited_from: \DataType::$$ref
Inherited_from: \AbstractFileSet::$$ref
Inherited_from: \FileSet::$$ref


                 $selectors= 'array()'

inheritedInherited from: \AbstractFileSet::$$selectors \FileSet::$$selectors

Default valuearray()Details

Type: n/a
Inherited_from: \AbstractFileSet::$$selectors
Inherited_from: \FileSet::$$selectors

boolean
                 $useDefaultExcludes= 'true'

inherited

Inherited from: \AbstractFileSet::$$useDefaultExcludes \FileSet::$$useDefaultExcludes

Default valuetrueDetails

Type: boolean
Inherited_from: \AbstractFileSet::$$useDefaultExcludes
Inherited_from: \FileSet::$$useDefaultExcludes

Methods

__clone(
          
          )
        
        :
          void

inherited

Return a FileSet that has the same basedir and same patternsets as this one.

Inherited from: \FileSet::__clone()

__construct(
           $fileset
              =
              null
          )
        
        :
          void

inherited

Inherited from: \FileSet::__construct()

Parameters

Name	Type	Description
$fileset

appendSelector(
          \selector $selector
          )
        
        :
          void

inherited

Add a new selector into this container.

Inherited from: \AbstractFileSet::appendSelector()\FileSet::appendSelector()

Parameters

Name	Type	Description
$selector	\selector	the new selector to add

circularReference(
          
          )
        
        :
          void

inherited

Creates an exception that indicates the user has generated a loop of data types referencing each other.

Inherited from: \DataType::circularReference()\AbstractFileSet::circularReference()\FileSet::circularReference()

createAnd(
          
          )
        
        :
          void

inherited

add an "And" selector entry on the selector list

Inherited from: \AbstractFileSet::createAnd()\FileSet::createAnd()

createContains(
          
          )
        
        :
          void

inherited

add a contains selector entry on the selector list

Inherited from: \AbstractFileSet::createContains()\FileSet::createContains()

createContainsRegexp(
          
          )
        
        :
          void

inherited

add a contains selector entry on the selector list

Inherited from: \AbstractFileSet::createContainsRegexp()\FileSet::createContainsRegexp()

createCustom(
          
          )
        
        :
          void

inherited

add an extended selector entry on the selector list

Inherited from: \AbstractFileSet::createCustom()\FileSet::createCustom()

createDate(
          
          )
        
        :
          void

inherited

add a selector date entry on the selector list

Inherited from: \AbstractFileSet::createDate()\FileSet::createDate()

createDepend(
          
          )
        
        :
          void

inherited

add a depends selector entry on the selector list

Inherited from: \AbstractFileSet::createDepend()\FileSet::createDepend()

createDepth(
          
          )
        
        :
          void

inherited

add a depth selector entry on the selector list

Inherited from: \AbstractFileSet::createDepth()\FileSet::createDepth()

createExclude(
          
          )
        
        :
          void

inherited

add a name entry on the exclude list

Inherited from: \AbstractFileSet::createExclude()\FileSet::createExclude()

createExcludesFile(
          
          )
        
        :
          void

inherited

add a name entry on the include files list

Inherited from: \AbstractFileSet::createExcludesFile()\FileSet::createExcludesFile()

createFilename(
          
          )
        
        :
          void

inherited

add a selector filename entry on the selector list

Inherited from: \AbstractFileSet::createFilename()\FileSet::createFilename()

createInclude(
          
          )
        
        :
          void

inherited

add a name entry on the include list

Inherited from: \AbstractFileSet::createInclude()\FileSet::createInclude()

createIncludesFile(
          
          )
        
        :
          void

inherited

add a name entry on the include files list

Inherited from: \AbstractFileSet::createIncludesFile()\FileSet::createIncludesFile()

createMajority(
          
          )
        
        :
          void

inherited

add a majority selector entry on the selector list

Inherited from: \AbstractFileSet::createMajority()\FileSet::createMajority()

createNone(
          
          )
        
        :
          void

inherited

add a "None" selector entry on the selector list

Inherited from: \AbstractFileSet::createNone()\FileSet::createNone()

createNot(
          
          )
        
        :
          void

inherited

add a "Not" selector entry on the selector list

Inherited from: \AbstractFileSet::createNot()\FileSet::createNot()

createOr(
          
          )
        
        :
          void

inherited

add an "Or" selector entry on the selector list

Inherited from: \AbstractFileSet::createOr()\FileSet::createOr()

createPatternSet(
          
          )
        
        :
          void

inherited

Inherited from: \AbstractFileSet::createPatternSet()\FileSet::createPatternSet()

createPresent(
          
          )
        
        :
          void

inherited

add a present selector entry on the selector list

Inherited from: \AbstractFileSet::createPresent()\FileSet::createPresent()

createSelector(
          
          )
        
        :
          void

inherited

add a "Select" selector entry on the selector list

Inherited from: \AbstractFileSet::createSelector()\FileSet::createSelector()

createSize(
          
          )
        
        :
          void

inherited

add a selector size entry on the selector list

Inherited from: \AbstractFileSet::createSize()\FileSet::createSize()

createType(
          
          )
        
        :
          void

inherited

add a type selector entry on the selector list

Inherited from: \AbstractFileSet::createType()\FileSet::createType()

dieOnCircularReference(
           $stk,  $p
          )
        
        :
          void

inherited

Check to see whether any DataType we hold references to is included in the Stack (which holds all DataType instances that directly or indirectly reference this instance, including this instance itself).

Inherited from: \DataType::dieOnCircularReference()\AbstractFileSet::dieOnCircularReference()\FileSet::dieOnCircularReference()

If one is included, throw a BuildException created by circularReference

This implementation is appropriate only for a DataType that cannot hold other DataTypes as children.

The general contract of this method is that it shouldn't do anything if checked is true and set it to true on exit.

Parameters

Name	Type	Description
$stk
$p

getCheckedRef(
           $requiredClass,  $dataTypeName
          )
        
        :
          void

inherited

Performs the check for circular references and returns the referenced object.

Inherited from: \DataType::getCheckedRef()\AbstractFileSet::getCheckedRef()\FileSet::getCheckedRef()

Parameters

Name	Type	Description
$requiredClass
$dataTypeName

getDescription(
          
          )
        
        :
          void

inherited

Return the description for the current data type.

Inherited from: \DataType::getDescription()\AbstractFileSet::getDescription()\FileSet::getDescription()

getDir(
           $p
          )
        
        :
          void

inherited

Inherited from: \AbstractFileSet::getDir()\FileSet::getDir()

Parameters

Name	Type	Description
$p

getDirectoryScanner(
           $p
          )
        
        :
          void

inherited

returns a reference to the dirscanner object belonging to this fileset

Inherited from: \AbstractFileSet::getDirectoryScanner()\FileSet::getDirectoryScanner()

Parameters

Name	Type	Description
$p

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(
          
          )
        
        :
          \Project

inherited

Returns a reference to current project

Inherited from: \ProjectComponent::getProject()\DataType::getProject()\AbstractFileSet::getProject()\FileSet::getProject()

Returns

Type	Description
\Project	Reference to current porject object

getRef(
           $p
          )
        
        :
          void

inherited

Performs the check for circular references and returns the referenced FileSet.

Inherited from: \AbstractFileSet::getRef()\FileSet::getRef()

Parameters

Name	Type	Description
$p

getSelectors(
           $p
          )
        
        :
          \an

inherited

Returns the set of selectors as an array.

Inherited from: \AbstractFileSet::getSelectors()\FileSet::getSelectors()

Parameters

Name	Type	Description
$p

Returns

Type	Description
\an	array of selectors in this container

hasPatterns(
          
          )
        
        :
          boolean

inherited

Indicates whether there are any patterns here.

Inherited from: \AbstractFileSet::hasPatterns()\FileSet::hasPatterns()

Returns

Type	Description
boolean	Whether any patterns are in this container.

hasSelectors(
          
          )
        
        :
          boolean

inherited

Indicates whether there are any selectors here.

Inherited from: \AbstractFileSet::hasSelectors()\FileSet::hasSelectors()

Returns

Type	Description
boolean	Whether any selectors are in this container

isReference(
          
          )
        
        :
          void

inherited

Has the refid attribute of this element been set?

Inherited from: \DataType::isReference()\AbstractFileSet::isReference()\FileSet::isReference()

log(
          string $msg, integer $level
              =
              Project::MSG_INFO
          )
        
        :
          void

inherited

Logs a message with the given priority.

Inherited from: \ProjectComponent::log()\DataType::log()\AbstractFileSet::log()\FileSet::log()

Parameters

Name	Type	Description
$msg	string	The message to be logged.
$level	integer	The message's priority at this message should have

noChildrenAllowed(
          
          )
        
        :
          void

inherited

Creates an exception that indicates that this XML element must not have child elements if the refid attribute is set.

Inherited from: \DataType::noChildrenAllowed()\AbstractFileSet::noChildrenAllowed()\FileSet::noChildrenAllowed()

parsingComplete(
          
          )
        
        :
          void

inherited

Template method being called when the data type has been parsed completely.

Inherited from: \DataType::parsingComplete()\AbstractFileSet::parsingComplete()\FileSet::parsingComplete()

selectorCount(
          
          )
        
        :
          int

inherited

Gives the count of the number of selectors in this container

Inherited from: \AbstractFileSet::selectorCount()\FileSet::selectorCount()

Returns

Type	Description
int	The number of selectors in this container

selectorElements(
          
          )
        
        :
          array

inherited

Returns an array for accessing the set of selectors.

Inherited from: \AbstractFileSet::selectorElements()\FileSet::selectorElements()

Returns

Type	Description
array	The array of selectors

setCaseSensitive(
           $isCaseSensitive
          )
        
        :
          void

inherited

Sets case sensitivity of the file system

Inherited from: \AbstractFileSet::setCaseSensitive()\FileSet::setCaseSensitive()

Parameters

Name	Type	Description
$isCaseSensitive

setDefaultexcludes(
          \$useDefaultExcludes $useDefaultExcludes
          )
        
        :
          void

inherited

Sets whether default exclusions should be used or not.

Inherited from: \AbstractFileSet::setDefaultexcludes()\FileSet::setDefaultexcludes()

Parameters

Name	Type	Description
$useDefaultExcludes	\$useDefaultExcludes	"true"\|"on"\|"yes" when default exclusions should be used, "false"\|"off"\|"no" when they shouldn't be used.

setDescription(
           $desc
          )
        
        :
          void

inherited

Sets a description of the current data type. It will be useful in commenting what we are doing.

Inherited from: \DataType::setDescription()\AbstractFileSet::setDescription()\FileSet::setDescription()

Parameters

Name	Type	Description
$desc

setDir(
           $dir
          )
        
        :
          void

inherited

Inherited from: \AbstractFileSet::setDir()\FileSet::setDir()

Parameters

Name	Type	Description
$dir

setExcludes(
           $excludes
          )
        
        :
          void

inherited

Sets the set of exclude patterns. Patterns may be separated by a comma or a space.

Inherited from: \AbstractFileSet::setExcludes()\FileSet::setExcludes()

Parameters

Name	Type	Description
$excludes

setExcludesfile(
          \$excl $excl
          )
        
        :
          void

inherited

Sets the name of the file containing the includes patterns.

Inherited from: \AbstractFileSet::setExcludesfile()\FileSet::setExcludesfile()

Parameters

Name	Type	Description
$excl	\$excl	The file to fetch the exclude patterns from.

Throws

Exception	Description
\BE

setExpandSymbolicLinks(
           $expandSymbolicLinks
          )
        
        :
          void

inherited

Sets whether to expand/dereference symbolic links, default is false

Inherited from: \AbstractFileSet::setExpandSymbolicLinks()\FileSet::setExpandSymbolicLinks()

Parameters

Name	Type	Description
$expandSymbolicLinks

Details

: boolean

setIncludes(
           $includes
          )
        
        :
          void

inherited

Sets the set of include patterns. Patterns may be separated by a comma or a space.

Inherited from: \AbstractFileSet::setIncludes()\FileSet::setIncludes()

Parameters

Name	Type	Description
$includes

setIncludesfile(
          \$incl $incl
          )
        
        :
          void

inherited

Sets the name of the file containing the includes patterns.

Inherited from: \AbstractFileSet::setIncludesfile()\FileSet::setIncludesfile()

Parameters

Name	Type	Description
$incl	\$incl	The file to fetch the include patterns from.

Throws

Exception	Description
\BE

setProject(
          \Project $project
          )
        
        :
          void

inherited

References the project to the current component.

Inherited from: \ProjectComponent::setProject()\DataType::setProject()\AbstractFileSet::setProject()\FileSet::setProject()

Parameters

Name	Type	Description
$project	\Project	The reference to the current project

setRefid(
          \Reference $r
          )
        
        :
          void

inherited

Makes this instance in effect a reference to another PatternSet instance.

Inherited from: \AbstractFileSet::setRefid()\FileSet::setRefid()

You must not set another attribute or nest elements inside this element if you make it a reference.

Parameters

Name	Type	Description
$r	\Reference

setupDirectoryScanner(
           $ds,  $p
          )
        
        :
          void

inherited

feed dirscanner with infos defined by this fileset

Inherited from: \AbstractFileSet::setupDirectoryScanner()\FileSet::setupDirectoryScanner()

Parameters

Name	Type	Description
$ds
$p

tooManyAttributes(
          
          )
        
        :
          void

inherited

Creates an exception that indicates that refid has to be the only attribute if it is set.

Inherited from: \DataType::tooManyAttributes()\AbstractFileSet::tooManyAttributes()\FileSet::tooManyAttributes()

\ZipTask
jump to top

Package: phing\tasks\ext

Creates a zip archive using PHP ZipArchive extension/

This is very closely based on the ANT class of the same name.

Parent(s): \MatchingTask < \SelectorContainer < \ProjectComponent
Author: Michiel Rook
Copyright: 2001,2002 THYRELL. All rights reserved
Since: 2.1.0
Version: $Id: 6997b3f3abffedf1b2efabc40c3b2d012b2379cb $

Properties

\PhingFile
                 $baseDir= ''

Details

Type: \PhingFile

string
                 $description= ''

inherited

Description of the task

Inherited from: \Task::$$description \MatchingTask::$$description

Details

Type: string
Inherited_from: \Task::$$description
Inherited_from: \MatchingTask::$$description


                 $fileSetFiles= 'array()'

Default valuearray()Details

Type: n/a

\FileSet
                 $fileset= ''

inherited

Inherited from: \MatchingTask::$$fileset

Details

Type: \FileSet
Inherited_from: \MatchingTask::$$fileset


                 $filesets= 'array()'

Default valuearray()Details

Type: n/a


                 $includeEmpty= 'true'

Whether to include empty dirs in the archive.

Default valuetrueDetails

Type: n/a

\Location
                 $location= ''

inherited

Stored buildfile location

Inherited from: \Task::$$location \MatchingTask::$$location

Details

Type: \Location
Inherited_from: \Task::$$location
Inherited_from: \MatchingTask::$$location

string
                 $prefix= 'null'

File path prefix in zip archive

Default valuenullDetails

Type: string

\Project
                 $project= 'null'

inherited

Holds a reference to the project that a project component (a task, a target, etc.) belongs to

A reference to the current project instanceInherited from: \ProjectComponent::$$project \Task::$$project \MatchingTask::$$project

Default valuenullDetails

Type: \Project
Inherited_from: \ProjectComponent::$$project
Inherited_from: \Task::$$project
Inherited_from: \MatchingTask::$$project

\Target
                 $target= ''

inherited

Owning Target object

Inherited from: \Task::$$target \MatchingTask::$$target

Details

Type: \Target
Inherited_from: \Task::$$target
Inherited_from: \MatchingTask::$$target

string
                 $taskName= ''

inherited

Taskname for logger

Inherited from: \Task::$$taskName \MatchingTask::$$taskName

Details

Type: string
Inherited_from: \Task::$$taskName
Inherited_from: \MatchingTask::$$taskName

string
                 $taskType= ''

inherited

Internal taskname (req)

Inherited from: \Task::$$taskType \MatchingTask::$$taskType

Details

Type: string
Inherited_from: \Task::$$taskType
Inherited_from: \MatchingTask::$$taskType

boolean
                 $useDefaultExcludes= 'true'

inherited

Inherited from: \MatchingTask::$$useDefaultExcludes

Default valuetrueDetails

Type: boolean
Inherited_from: \MatchingTask::$$useDefaultExcludes

\RuntimeConfigurable
                 $wrapper= ''

inherited

Wrapper of the task

Inherited from: \Task::$$wrapper \MatchingTask::$$wrapper

Details

Type: \RuntimeConfigurable
Inherited_from: \Task::$$wrapper
Inherited_from: \MatchingTask::$$wrapper

\PhingFile
                 $zipFile= ''

Details

Type: \PhingFile

Methods

__construct(
          
          )
        
        :
          void

inherited

Create instance; set fileset to new FileSet.

Inherited from: \MatchingTask::__construct()

appendSelector(
          \FileSelector $selector
          )
        
        :
          void

inherited

Add a new selector into this container.

Inherited from: \MatchingTask::appendSelector()

Parameters

Name	Type	Description
$selector	\FileSelector	the new selector to add

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

Parameters

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

Returns

Type	Description
boolean

createAnd(
          
          )
        
        :
          \AndSelector

inherited

add an "And" selector entry on the selector list

Inherited from: \MatchingTask::createAnd()

Returns

Type	Description
\AndSelector

createContains(
          
          )
        
        :
          \ContainsSelector

inherited

add a contains selector entry on the selector list

Inherited from: \MatchingTask::createContains()

Returns

Type	Description
\ContainsSelector

createCustom(
          
          )
        
        :
          \ExtendSelector

inherited

add an extended selector entry on the selector list

Inherited from: \MatchingTask::createCustom()

Returns

Type	Description
\ExtendSelector

createDate(
          
          )
        
        :
          \DateSelector

inherited

add a selector date entry on the selector list

Inherited from: \MatchingTask::createDate()

Returns

Type	Description
\DateSelector

createDepend(
          
          )
        
        :
          \DependSelector

inherited

add a depends selector entry on the selector list

Inherited from: \MatchingTask::createDepend()

Returns

Type	Description
\DependSelector

createDepth(
          
          )
        
        :
          \DepthSelector

inherited

add a depth selector entry on the selector list

Inherited from: \MatchingTask::createDepth()

Returns

Type	Description
\DepthSelector

createExclude(
          
          )
        
        :
          \PatternSetNameEntry

inherited

add a name entry on the exclude list

Inherited from: \MatchingTask::createExclude()

Returns

Type	Description
\PatternSetNameEntry

createExcludesFile(
          
          )
        
        :
          \PatternSetNameEntry

inherited

add a name entry on the include files list

Inherited from: \MatchingTask::createExcludesFile()

Returns

Type	Description
\PatternSetNameEntry

createFileSet(
          
          )
        
        :
          \FileSet

Add a new fileset.

Returns

Type	Description
\FileSet

createFilename(
          
          )
        
        :
          \FilenameSelector

inherited

add a selector filename entry on the selector list

Inherited from: \MatchingTask::createFilename()

Returns

Type	Description
\FilenameSelector

createInclude(
          
          )
        
        :
          \PatternSetNameEntry

inherited

add a name entry on the include list

Inherited from: \MatchingTask::createInclude()

Returns

Type	Description
\PatternSetNameEntry

createIncludesFile(
          
          )
        
        :
          \PatternSetNameEntry

inherited

add a name entry on the include files list

Inherited from: \MatchingTask::createIncludesFile()

Returns

Type	Description
\PatternSetNameEntry

createMajority(
          
          )
        
        :
          \MajoritySelector

inherited

add a majority selector entry on the selector list

Inherited from: \MatchingTask::createMajority()

Returns

Type	Description
\MajoritySelector

createNone(
          
          )
        
        :
          \NoneSelector

inherited

add a "None" selector entry on the selector list

Inherited from: \MatchingTask::createNone()

Returns

Type	Description
\NoneSelector

createNot(
          
          )
        
        :
          \NotSelector

inherited

add a "Not" selector entry on the selector list

Inherited from: \MatchingTask::createNot()

Returns

Type	Description
\NotSelector

createOr(
          
          )
        
        :
          void

inherited

add an "Or" selector entry on the selector list

Inherited from: \MatchingTask::createOr()

createPatternSet(
          
          )
        
        :
          \PatternSet

inherited

add a set of patterns

Inherited from: \MatchingTask::createPatternSet()

Returns

Type	Description
\PatternSet

createPresent(
          
          )
        
        :
          \PresentSelector

inherited

add a present selector entry on the selector list

Inherited from: \MatchingTask::createPresent()

Returns

Type	Description
\PresentSelector

createSelector(
          
          )
        
        :
          \SelectSelector

inherited

add a "Select" selector entry on the selector list

Inherited from: \MatchingTask::createSelector()

Returns

Type	Description
\SelectSelector

createSize(
          
          )
        
        :
          \SizeSelector

inherited

add a selector size entry on the selector list

Inherited from: \MatchingTask::createSize()

Returns

Type	Description
\SizeSelector

getDescription(
          
          )
        
        :
          string

inherited

Returns the textual description of the task

Inherited from: \Task::getDescription()\MatchingTask::getDescription()

Returns

Type	Description
string	The text description of the task

getDirectoryScanner(
           $baseDir
          )
        
        :
          \DirectoryScanner

inherited

Returns the directory scanner needed to access the files to process.

Inherited from: \MatchingTask::getDirectoryScanner()

Parameters

Name	Type	Description
$baseDir

Returns

Type	Description
\DirectoryScanner

getImplicitFileSet(
          
          )
        
        :
          \FileSet

finalinherited

Accessor for the implict fileset.

Inherited from: \MatchingTask::getImplicitFileSet()

Returns

Type	Description
\FileSet

getLocation(
          
          )
        
        :
          \Location

inherited

Returns the location within the buildfile this task occurs. Used by {@link BuildException} to give detailed error messages.

Inherited from: \Task::getLocation()\MatchingTask::getLocation()

Returns

Type	Description
\Location	The location object describing the position of this task within the buildfile.

getOwningTarget(
          
          )
        
        :
          \Target

inherited

Returns the owning target of this task.

Inherited from: \Task::getOwningTarget()\MatchingTask::getOwningTarget()

Returns

Type	Description
\Target	The target object that owns this task

getProject(
          
          )
        
        :
          \Project

inherited

Returns a reference to current project

Inherited from: \ProjectComponent::getProject()\Task::getProject()\MatchingTask::getProject()

Returns

Type	Description
\Project	Reference to current porject object

getRegisterSlot(
          string $slotName
          )
        
        :
          void

inherited

Returns a name

Inherited from: \Task::getRegisterSlot()\MatchingTask::getRegisterSlot()

Parameters

Name	Type	Description
$slotName	string

getRuntimeConfigurableWrapper(
          
          )
        
        :
          \RuntimeConfigurable

inherited

Returns the wrapper object for runtime configuration

Inherited from: \Task::getRuntimeConfigurableWrapper()\MatchingTask::getRuntimeConfigurableWrapper()

Returns

Type	Description
\RuntimeConfigurable	The wrapper object used by this task

getSelectors(
           $p
          )
        
        :
          array

inherited

Returns the set of selectors as an array.

Inherited from: \MatchingTask::getSelectors()

Parameters

Name	Type	Description
$p

Returns

Type	Description
array	FileSelector[] An array of selectors in this container

getTaskName(
          
          )
        
        :
          string

inherited

Returns the name of task, used only for log messages

Inherited from: \Task::getTaskName()\MatchingTask::getTaskName()

Returns

Type	Description
string	Name of this task

getTaskType(
          
          )
        
        :
          string

inherited

Returns the name of the task under which it was invoked, usually the XML tagname

Inherited from: \Task::getTaskType()\MatchingTask::getTaskType()

Returns

Type	Description
string	The type of this task (XML Tag)

hasSelectors(
          
          )
        
        :
          boolean

inherited

Indicates whether there are any selectors here.

Inherited from: \MatchingTask::hasSelectors()

Returns

Type	Description
boolean	Whether any selectors are in this container

inherited

Called by the parser to let the task initialize properly.

Inherited from: \Task::init()\MatchingTask::init()

Should throw a BuildException if something goes wrong with the build

This is abstract here, but may not be overloaded by subclasses.

Throws

Exception	Description
\BuildException

log(
          string $msg, integer $level
              =
              Project::MSG_INFO
          )
        
        :
          void

inherited

Provides a project level log event to the task.

Inherited from: \Task::log()\MatchingTask::log()

Parameters

Name	Type	Description
$msg	string	The message to log
$level	integer	The priority of the message

Details

See: \BuildEvent
See: \BuildListener

do the work

Should throw a BuildException if someting goes wrong with the build

This is abstract here. Must be overloaded by real tasks.

Throws

Exception	Description
\BuildException

maybeConfigure(
          
          )
        
        :
          void

inherited

Configure this task if it hasn't been done already.

Inherited from: \Task::maybeConfigure()\MatchingTask::maybeConfigure()

perform(
          
          )
        
        :
          void

inherited

Perfrom this task

Inherited from: \Task::perform()\MatchingTask::perform()

selectorCount(
          
          )
        
        :
          int

inherited

Gives the count of the number of selectors in this container

Inherited from: \MatchingTask::selectorCount()

Returns

Type	Description
int	The number of selectors in this container

selectorElements(
          
          )
        
        :
          \an

inherited

Returns an enumerator for accessing the set of selectors.

Inherited from: \MatchingTask::selectorElements()

Returns

Type	Description
\an	enumerator that goes through each of the selectors

setBasedir(
          \PhingFile $baseDir
          )
        
        :
          void

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

Parameters

Name	Type	Description
$baseDir	\PhingFile

setCaseSensitive(
          boolean $isCaseSensitive
          )
        
        :
          void

inherited

Sets case sensitivity of the file system

Inherited from: \MatchingTask::setCaseSensitive()

Parameters

Name	Type	Description
$isCaseSensitive	boolean	"true"\|"on"\|"yes" if file system is case sensitive, "false"\|"off"\|"no" when not.

setDefaultexcludes(
          boolean $useDefaultExcludes
          )
        
        :
          void

inherited

Sets whether default exclusions should be used or not.

Inherited from: \MatchingTask::setDefaultexcludes()

Parameters

Name	Type	Description
$useDefaultExcludes	boolean	"true"\|"on"\|"yes" when default exclusions should be used, "false"\|"off"\|"no" when they shouldn't be used.

setDescription(
          string $desc
          )
        
        :
          void

inherited

Sets a textual description of the task

Inherited from: \Task::setDescription()\MatchingTask::setDescription()

Parameters

Name	Type	Description
$desc	string	The text describing the task

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(
          string $excludes
          )
        
        :
          void

inherited

Sets the set of exclude patterns. Patterns may be separated by a comma or a space.

Inherited from: \MatchingTask::setExcludes()

Parameters

Name	Type	Description
$excludes	string	the string containing the exclude patterns

setExcludesfile(
          \PhingFile $excludesfile
          )
        
        :
          void

inherited

Sets the name of the file containing the includes patterns.

Inherited from: \MatchingTask::setExcludesfile()

Parameters

Name	Type	Description
$excludesfile	\PhingFile	A string containing the filename to fetch the include patterns from.

setFollowSymlinks(
          boolean $followSymlinks
          )
        
        :
          void

inherited

Sets whether or not symbolic links should be followed.

Inherited from: \MatchingTask::setFollowSymlinks()

Parameters

Name	Type	Description
$followSymlinks	boolean	whether or not symbolic links should be followed

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(
          string $includes
          )
        
        :
          void

inherited

Sets the set of include patterns. Patterns may be separated by a comma or a space.

Inherited from: \MatchingTask::setIncludes()

Parameters

Name	Type	Description
$includes	string	the string containing the include patterns

setIncludesfile(
          \PhingFile $includesfile
          )
        
        :
          void

inherited

Sets the name of the file containing the includes patterns.

Inherited from: \MatchingTask::setIncludesfile()

Parameters

Name	Type	Description
$includesfile	\PhingFile	A string containing the filename to fetch the include patterns from.

setLocation(
          \Location $location
          )
        
        :
          void

inherited

Sets the location within the buildfile this task occurs. Called by the parser to set location information.

Inherited from: \Task::setLocation()\MatchingTask::setLocation()

Parameters

Name	Type	Description
$location	\Location	The location object describing the position of this task within the buildfile.

setOwningTarget(
          \Target $target
          )
        
        :
          void

inherited

Sets the owning target this task belongs to.

Inherited from: \Task::setOwningTarget()\MatchingTask::setOwningTarget()

Parameters

Name	Type	Description
$target	\Target	Reference to owning target

setPrefix(
          string $prefix
          )
        
        :
          void

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

Parameters

Name	Type	Description
$prefix	string	Prefix

setProject(
          \Project $project
          )
        
        :
          void

inherited

References the project to the current component.

Inherited from: \MatchingTask::setProject()

Parameters

Name	Type	Description
$project	\Project	The reference to the current project

Details

See: \ProjectComponent::setProject()

setRuntimeConfigurableWrapper(
          \RuntimeConfigurable $wrapper
          )
        
        :
          void

inherited

Sets the wrapper object this task should use for runtime configurable elements.

Inherited from: \Task::setRuntimeConfigurableWrapper()\MatchingTask::setRuntimeConfigurableWrapper()

Parameters

Name	Type	Description
$wrapper	\RuntimeConfigurable	The wrapper object this task should use

setTaskName(
          string $name
          )
        
        :
          string

inherited

Sets the name of this task for log messages

Inherited from: \Task::setTaskName()\MatchingTask::setTaskName()

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
string	A string representing the name of this task for log

setTaskType(
          string $name
          )
        
        :
          void

inherited

Sets the type of the task. Usually this is the name of the XML tag

Inherited from: \Task::setTaskType()\MatchingTask::setTaskType()

Parameters

Name	Type	Description
$name	string	The type of this task (XML Tag)

tasks/ext/ZipTask.php

\ZipFileSetjump to top

Properties

Methods

\ZipTaskjump to top

Properties

Methods

\ZipFileSet
jump to top

\ZipTask
jump to top