tasks/ext/ZipTask.php

Show: inherited
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

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

Propertypublic  $additionalPatterns= 'array()'
Default valuearray()Details
Type
n/a
Inherited_from
\AbstractFileSet::$$additionalPatterns  
Inherited_from
\FileSet::$$additionalPatterns  
Propertyprotectedboolean  $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  
Propertypublic\PatternSet  $defaultPatterns= ''
Details
Type
\PatternSet
Inherited_from
\AbstractFileSet::$$defaultPatterns  
Inherited_from
\FileSet::$$defaultPatterns  
Propertypublic  $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  
Propertypublic  $dir= ''
inheritedInherited from: \AbstractFileSet::$$dir\FileSet::$$dir
Details
Type
n/a
Inherited_from
\AbstractFileSet::$$dir  
Inherited_from
\FileSet::$$dir  
Propertyprotectedboolean  $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  
Propertyprivate  $files= 'null'
Default valuenullDetails
Type
n/a
Propertypublic  $isCaseSensitive= 'true'
Default valuetrueDetails
Type
n/a
Inherited_from
\AbstractFileSet::$$isCaseSensitive  
Inherited_from
\FileSet::$$isCaseSensitive  
Propertyprotected\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  
Propertypublic  $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  
Propertypublic  $selectors= 'array()'
Default valuearray()Details
Type
n/a
Inherited_from
\AbstractFileSet::$$selectors  
Inherited_from
\FileSet::$$selectors  
Propertypublicboolean  $useDefaultExcludes= 'true'
Default valuetrueDetails
Type
boolean
Inherited_from
\AbstractFileSet::$$useDefaultExcludes  
Inherited_from
\FileSet::$$useDefaultExcludes  

Methods

methodpublic__clone( ) : void
inherited

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

Inherited from: \FileSet::__clone()
methodpublic__construct(  $fileset = null ) : void
inherited

Inherited from: \FileSet::__construct()
Parameters
Name Type Description
$fileset
methodpublicappendSelector( \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

methodpubliccircularReference( ) : 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()
methodpubliccreateAnd( ) : void
inherited

add an "And" selector entry on the selector list

Inherited from: \AbstractFileSet::createAnd()\FileSet::createAnd()
methodpubliccreateContains( ) : void
inherited

add a contains selector entry on the selector list

Inherited from: \AbstractFileSet::createContains()\FileSet::createContains()
methodpubliccreateContainsRegexp( ) : void
inherited

add a contains selector entry on the selector list

Inherited from: \AbstractFileSet::createContainsRegexp()\FileSet::createContainsRegexp()
methodpubliccreateCustom( ) : void
inherited

add an extended selector entry on the selector list

Inherited from: \AbstractFileSet::createCustom()\FileSet::createCustom()
methodpubliccreateDate( ) : void
inherited

add a selector date entry on the selector list

Inherited from: \AbstractFileSet::createDate()\FileSet::createDate()
methodpubliccreateDepend( ) : void
inherited

add a depends selector entry on the selector list

Inherited from: \AbstractFileSet::createDepend()\FileSet::createDepend()
methodpubliccreateDepth( ) : void
inherited

add a depth selector entry on the selector list

Inherited from: \AbstractFileSet::createDepth()\FileSet::createDepth()
methodpubliccreateExclude( ) : void
inherited

add a name entry on the exclude list

Inherited from: \AbstractFileSet::createExclude()\FileSet::createExclude()
methodpubliccreateExcludesFile( ) : void
inherited

add a name entry on the include files list

Inherited from: \AbstractFileSet::createExcludesFile()\FileSet::createExcludesFile()
methodpubliccreateFilename( ) : void
inherited

add a selector filename entry on the selector list

Inherited from: \AbstractFileSet::createFilename()\FileSet::createFilename()
methodpubliccreateInclude( ) : void
inherited

add a name entry on the include list

Inherited from: \AbstractFileSet::createInclude()\FileSet::createInclude()
methodpubliccreateIncludesFile( ) : void
inherited

add a name entry on the include files list

Inherited from: \AbstractFileSet::createIncludesFile()\FileSet::createIncludesFile()
methodpubliccreateMajority( ) : void
inherited

add a majority selector entry on the selector list

Inherited from: \AbstractFileSet::createMajority()\FileSet::createMajority()
methodpubliccreateNone( ) : void
inherited

add a "None" selector entry on the selector list

Inherited from: \AbstractFileSet::createNone()\FileSet::createNone()
methodpubliccreateNot( ) : void
inherited

add a "Not" selector entry on the selector list

Inherited from: \AbstractFileSet::createNot()\FileSet::createNot()
methodpubliccreateOr( ) : void
inherited

add an "Or" selector entry on the selector list

Inherited from: \AbstractFileSet::createOr()\FileSet::createOr()
methodpubliccreatePatternSet( ) : void
methodpubliccreatePresent( ) : void
inherited

add a present selector entry on the selector list

Inherited from: \AbstractFileSet::createPresent()\FileSet::createPresent()
methodpubliccreateSelector( ) : void
inherited

add a "Select" selector entry on the selector list

Inherited from: \AbstractFileSet::createSelector()\FileSet::createSelector()
methodpubliccreateSize( ) : void
inherited

add a selector size entry on the selector list

Inherited from: \AbstractFileSet::createSize()\FileSet::createSize()
methodpubliccreateType( ) : void
inherited

add a type selector entry on the selector list

Inherited from: \AbstractFileSet::createType()\FileSet::createType()
methodpublicdieOnCircularReference(  $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
methodpublicgetCheckedRef(  $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
methodpublicgetDescription( ) : void
inherited

Return the description for the current data type.

Inherited from: \DataType::getDescription()\AbstractFileSet::getDescription()\FileSet::getDescription()
methodpublicgetDir(  $p ) : void
Parameters
Name Type Description
$p
methodpublicgetDirectoryScanner(  $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
methodpublicgetFiles(  $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
methodpublicgetProject( ) : \Project
Returns
Type Description
\Project Reference to current porject object
methodpublicgetRef(  $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
methodpublicgetSelectors(  $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
methodpublichasPatterns( ) : 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.
methodpublichasSelectors( ) : 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
methodpublicisReference( ) : void
inherited

Has the refid attribute of this element been set?

Inherited from: \DataType::isReference()\AbstractFileSet::isReference()\FileSet::isReference()
methodpubliclog( 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

methodpublicnoChildrenAllowed( ) : 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()
methodpublicparsingComplete( ) : void
inherited

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

Inherited from: \DataType::parsingComplete()\AbstractFileSet::parsingComplete()\FileSet::parsingComplete()
methodpublicselectorCount( ) : 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
methodpublicselectorElements( ) : 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
methodpublicsetCaseSensitive(  $isCaseSensitive ) : void
inherited

Sets case sensitivity of the file system

Inherited from: \AbstractFileSet::setCaseSensitive()\FileSet::setCaseSensitive()
Parameters
Name Type Description
$isCaseSensitive
methodpublicsetDefaultexcludes( \$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.

methodpublicsetDescription(  $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
methodpublicsetDir(  $dir ) : void
Parameters
Name Type Description
$dir
methodpublicsetExcludes(  $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
methodpublicsetExcludesfile( \$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
methodpublicsetExpandSymbolicLinks(  $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
methodpublicsetIncludes(  $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
methodpublicsetIncludesfile( \$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
methodpublicsetProject( \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

methodpublicsetRefid( \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
methodprotectedsetupDirectoryScanner(  $ds,  $p ) : void
inherited

feed dirscanner with infos defined by this fileset

Inherited from: \AbstractFileSet::setupDirectoryScanner()\FileSet::setupDirectoryScanner()
Parameters
Name Type Description
$ds
$p
methodpublictooManyAttributes( ) : 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

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

Propertyprivate\PhingFile  $baseDir= ''

Details
Type
\PhingFile
Propertyprotectedstring  $description= ''
inherited

Description of the task

Inherited from: \Task::$$description\MatchingTask::$$description
Details
Type
string
Inherited_from
\Task::$$description  
Inherited_from
\MatchingTask::$$description  
Propertyprivate  $fileSetFiles= 'array()'
Default valuearray()Details
Type
n/a
Propertyprotected\FileSet  $fileset= ''
inherited

Inherited from: \MatchingTask::$$fileset
Details
Type
\FileSet
Inherited_from
\MatchingTask::$$fileset  
Propertyprivate  $filesets= 'array()'
Default valuearray()Details
Type
n/a
Propertyprivate  $includeEmpty= 'true'

Whether to include empty dirs in the archive.

Default valuetrueDetails
Type
n/a
Propertyprotected\Location  $location= ''
inherited

Stored buildfile location

Inherited from: \Task::$$location\MatchingTask::$$location
Details
Type
\Location
Inherited_from
\Task::$$location  
Inherited_from
\MatchingTask::$$location  
Propertyprivatestring  $prefix= 'null'

File path prefix in zip archive

Default valuenullDetails
Type
string
Propertyprotected\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  
Propertyprotected\Target  $target= ''
inherited

Owning Target object

Inherited from: \Task::$$target\MatchingTask::$$target
Details
Type
\Target
Inherited_from
\Task::$$target  
Inherited_from
\MatchingTask::$$target  
Propertyprotectedstring  $taskName= ''
inherited

Taskname for logger

Inherited from: \Task::$$taskName\MatchingTask::$$taskName
Details
Type
string
Inherited_from
\Task::$$taskName  
Inherited_from
\MatchingTask::$$taskName  
Propertyprotectedstring  $taskType= ''
inherited

Internal taskname (req)

Inherited from: \Task::$$taskType\MatchingTask::$$taskType
Details
Type
string
Inherited_from
\Task::$$taskType  
Inherited_from
\MatchingTask::$$taskType  
Propertyprotectedboolean  $useDefaultExcludes= 'true'
inherited

Inherited from: \MatchingTask::$$useDefaultExcludes
Default valuetrueDetails
Type
boolean
Inherited_from
\MatchingTask::$$useDefaultExcludes  
Propertyprotected\RuntimeConfigurable  $wrapper= ''
inherited

Wrapper of the task

Inherited from: \Task::$$wrapper\MatchingTask::$$wrapper
Details
Type
\RuntimeConfigurable
Inherited_from
\Task::$$wrapper  
Inherited_from
\MatchingTask::$$wrapper  
Propertyprivate\PhingFile  $zipFile= ''

Details
Type
\PhingFile

Methods

methodpublic__construct( ) : void
inherited

Create instance; set fileset to new FileSet.

Inherited from: \MatchingTask::__construct()
methodpublicappendSelector( \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

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

Parameters
Name Type Description
$files array

array of filenames

$dir \PhingFile
Returns
Type Description
boolean
methodpubliccreateAnd( ) : \AndSelector
inherited

add an "And" selector entry on the selector list

Inherited from: \MatchingTask::createAnd()
Returns
Type Description
\AndSelector
methodpubliccreateContains( ) : \ContainsSelector
inherited

add a contains selector entry on the selector list

Inherited from: \MatchingTask::createContains()
Returns
Type Description
\ContainsSelector
methodpubliccreateCustom( ) : \ExtendSelector
inherited

add an extended selector entry on the selector list

Inherited from: \MatchingTask::createCustom()
Returns
Type Description
\ExtendSelector
methodpubliccreateDate( ) : \DateSelector
inherited

add a selector date entry on the selector list

Inherited from: \MatchingTask::createDate()
Returns
Type Description
\DateSelector
methodpubliccreateDepend( ) : \DependSelector
inherited

add a depends selector entry on the selector list

Inherited from: \MatchingTask::createDepend()
Returns
Type Description
\DependSelector
methodpubliccreateDepth( ) : \DepthSelector
inherited

add a depth selector entry on the selector list

Inherited from: \MatchingTask::createDepth()
Returns
Type Description
\DepthSelector
methodpubliccreateExclude( ) : \PatternSetNameEntry
inherited

add a name entry on the exclude list

Inherited from: \MatchingTask::createExclude()
Returns
Type Description
\PatternSetNameEntry
methodpubliccreateExcludesFile( ) : \PatternSetNameEntry
inherited

add a name entry on the include files list

Inherited from: \MatchingTask::createExcludesFile()
Returns
Type Description
\PatternSetNameEntry
methodpubliccreateFileSet( ) : \FileSet

Add a new fileset.

Returns
Type Description
\FileSet
methodpubliccreateFilename( ) : \FilenameSelector
inherited

add a selector filename entry on the selector list

Inherited from: \MatchingTask::createFilename()
Returns
Type Description
\FilenameSelector
methodpubliccreateInclude( ) : \PatternSetNameEntry
inherited

add a name entry on the include list

Inherited from: \MatchingTask::createInclude()
Returns
Type Description
\PatternSetNameEntry
methodpubliccreateIncludesFile( ) : \PatternSetNameEntry
inherited

add a name entry on the include files list

Inherited from: \MatchingTask::createIncludesFile()
Returns
Type Description
\PatternSetNameEntry
methodpubliccreateMajority( ) : \MajoritySelector
inherited

add a majority selector entry on the selector list

Inherited from: \MatchingTask::createMajority()
Returns
Type Description
\MajoritySelector
methodpubliccreateNone( ) : \NoneSelector
inherited

add a "None" selector entry on the selector list

Inherited from: \MatchingTask::createNone()
Returns
Type Description
\NoneSelector
methodpubliccreateNot( ) : \NotSelector
inherited

add a "Not" selector entry on the selector list

Inherited from: \MatchingTask::createNot()
Returns
Type Description
\NotSelector
methodpubliccreateOr( ) : void
inherited

add an "Or" selector entry on the selector list

Inherited from: \MatchingTask::createOr()
methodpubliccreatePatternSet( ) : \PatternSet
inherited

add a set of patterns

Inherited from: \MatchingTask::createPatternSet()
Returns
Type Description
\PatternSet
methodpubliccreatePresent( ) : \PresentSelector
inherited

add a present selector entry on the selector list

Inherited from: \MatchingTask::createPresent()
Returns
Type Description
\PresentSelector
methodpubliccreateSelector( ) : \SelectSelector
inherited

add a "Select" selector entry on the selector list

Inherited from: \MatchingTask::createSelector()
Returns
Type Description
\SelectSelector
methodpubliccreateSize( ) : \SizeSelector
inherited

add a selector size entry on the selector list

Inherited from: \MatchingTask::createSize()
Returns
Type Description
\SizeSelector
methodpublicgetDescription( ) : 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
methodprotectedgetDirectoryScanner(  $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
methodprotectedgetImplicitFileSet( ) : \FileSet
finalinherited

Accessor for the implict fileset.

Inherited from: \MatchingTask::getImplicitFileSet()
Returns
Type Description
\FileSet
methodpublicgetLocation( ) : \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.
methodpublicgetOwningTarget( ) : \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
methodpublicgetProject( ) : \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
methodprotectedgetRegisterSlot( string $slotName ) : void
inherited

Returns a name

Inherited from: \Task::getRegisterSlot()\MatchingTask::getRegisterSlot()
Parameters
Name Type Description
$slotName string
methodpublicgetRuntimeConfigurableWrapper( ) : \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
methodpublicgetSelectors(  $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
methodpublicgetTaskName( ) : 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
methodpublicgetTaskType( ) : 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)
methodpublichasSelectors( ) : boolean
inherited

Indicates whether there are any selectors here.

Inherited from: \MatchingTask::hasSelectors()
Returns
Type Description
boolean Whether any selectors are in this container
methodpublicinit( ) : void
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
methodpubliclog( 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  
methodpublicmain( ) : void

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
methodpublicmaybeConfigure( ) : void
inherited

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

Inherited from: \Task::maybeConfigure()\MatchingTask::maybeConfigure()
methodpublicperform( ) : void
inherited

Perfrom this task

Inherited from: \Task::perform()\MatchingTask::perform()
methodpublicselectorCount( ) : 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
methodpublicselectorElements( ) : \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
methodpublicsetBasedir( \PhingFile $baseDir ) : void

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

Parameters
Name Type Description
$baseDir \PhingFile
methodpublicsetCaseSensitive( 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.

methodpublicsetDefaultexcludes( 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.

methodpublicsetDescription( 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

methodpublicsetDestFile( \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

methodpublicsetExcludes( 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

methodpublicsetExcludesfile( \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.

methodpublicsetFollowSymlinks( 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

methodpublicsetIncludeEmptyDirs( 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  
methodpublicsetIncludes( 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

methodpublicsetIncludesfile( \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.

methodpublicsetLocation( \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.

methodpublicsetOwningTarget( \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

methodpublicsetPrefix( string $prefix ) : void

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

Parameters
Name Type Description
$prefix string

Prefix

methodpublicsetProject( \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()  
methodpublicsetRuntimeConfigurableWrapper( \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

methodpublicsetTaskName( 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
methodpublicsetTaskType( 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)

Documentation was generated by DocBlox 0.18.1.