phing-tasks-ext
[ class tree: phing-tasks-ext ] [ index: phing-tasks-ext ] [ all elements ]

Class: ExtractBaseTask

Source Location: /tasks/ext/ExtractBaseTask.php

Class Overview

ProjectComponent
   |
   --Task
      |
      --MatchingTask
         |
         --ExtractBaseTask

Base class for extracting tasks such as Unzip and Untar.


Author(s):

Version:

  • $Id: ExtractBaseTask.php 552 2009-08-29 12:18:13Z mrook $

Copyright:

  • � 2001,2002 THYRELL. All rights reserved

Variables

Methods


Child classes:

UnzipTask
Extracts one or several zip archives using ZipArchive class.
UntarTask
Extracts one or several tar archives using PEAR Archive_Tar

Inherited Variables

Inherited Methods

Class: MatchingTask

MatchingTask::__construct()
Create instance; set fileset to new FileSet.
MatchingTask::appendSelector()
Add a new selector into this container.
MatchingTask::createAnd()
add an "And" selector entry on the selector list
MatchingTask::createContains()
add a contains selector entry on the selector list
MatchingTask::createCustom()
add an extended selector entry on the selector list
MatchingTask::createDate()
add a selector date entry on the selector list
MatchingTask::createDepend()
add a depends selector entry on the selector list
MatchingTask::createDepth()
add a depth selector entry on the selector list
MatchingTask::createExclude()
add a name entry on the exclude list
MatchingTask::createExcludesFile()
add a name entry on the include files list
MatchingTask::createFilename()
add a selector filename entry on the selector list
MatchingTask::createInclude()
add a name entry on the include list
MatchingTask::createIncludesFile()
add a name entry on the include files list
MatchingTask::createMajority()
add a majority selector entry on the selector list
MatchingTask::createNone()
add a "None" selector entry on the selector list
MatchingTask::createNot()
add a "Not" selector entry on the selector list
MatchingTask::createOr()
add an "Or" selector entry on the selector list
MatchingTask::createPatternSet()
add a set of patterns
MatchingTask::createPresent()
add a present selector entry on the selector list
MatchingTask::createSelector()
add a "Select" selector entry on the selector list
MatchingTask::createSize()
add a selector size entry on the selector list
MatchingTask::getDirectoryScanner()
Returns the directory scanner needed to access the files to process.
MatchingTask::getImplicitFileSet()
Accessor for the implict fileset.
MatchingTask::getSelectors()
Returns the set of selectors as an array.
MatchingTask::hasSelectors()
Indicates whether there are any selectors here.
MatchingTask::selectorCount()
Gives the count of the number of selectors in this container
MatchingTask::selectorElements()
Returns an enumerator for accessing the set of selectors.
MatchingTask::setCaseSensitive()
Sets case sensitivity of the file system
MatchingTask::setDefaultexcludes()
Sets whether default exclusions should be used or not.
MatchingTask::setExcludes()
Sets the set of exclude patterns. Patterns may be separated by a comma or a space.
MatchingTask::setExcludesfile()
Sets the name of the file containing the includes patterns.
MatchingTask::setFollowSymlinks()
Sets whether or not symbolic links should be followed.
MatchingTask::setIncludes()
Sets the set of include patterns. Patterns may be separated by a comma or a space.
MatchingTask::setIncludesfile()
Sets the name of the file containing the includes patterns.
MatchingTask::setProject()

Class: Task

Task::getDescription()
Returns the textual description of the task
Task::getLocation()
Returns the location within the buildfile this task occurs. Used by BuildException to give detailed error messages.
Task::getOwningTarget()
Returns the owning target of this task.
Task::getRegisterSlot()
Returns a name
Task::getRuntimeConfigurableWrapper()
Returns the wrapper object for runtime configuration
Task::getTaskName()
Returns the name of task, used only for log messages
Task::getTaskType()
Returns the name of the task under which it was invoked, usually the XML tagname
Task::init()
Called by the parser to let the task initialize properly.
Task::log()
Provides a project level log event to the task.
Task::main()
Called by the project to let the task do it's work. This method may be called more than once, if the task is invoked more than once. For example, if target1 and target2 both depend on target3, then running <em>phing target1 target2</em> will run all tasks in target3 twice.
Task::maybeConfigure()
Configure this task if it hasn't been done already.
Task::perform()
Perfrom this task
Task::setDescription()
Sets a textual description of the task
Task::setLocation()
Sets the location within the buildfile this task occurs. Called by the parser to set location information.
Task::setOwningTarget()
Sets the owning target this task belongs to.
Task::setRuntimeConfigurableWrapper()
Sets the wrapper object this task should use for runtime configurable elements.
Task::setTaskName()
Sets the name of this task for log messages
Task::setTaskType()
Sets the type of the task. Usually this is the name of the XML tag

Class: ProjectComponent

ProjectComponent::getProject()
Returns a reference to current project
ProjectComponent::log()
Logs a message with the given priority.
ProjectComponent::setProject()
References the project to the current component.

Class Details

[line 31]
Base class for extracting tasks such as Unzip and Untar.



Tags:

author:  Joakim Bodin <joakim.bodin+phing@gmail.com>
version:  $Id: ExtractBaseTask.php 552 2009-08-29 12:18:13Z mrook $
copyright:  � 2001,2002 THYRELL. All rights reserved
abstract:  
since:  2.2.0


[ Top ]


Class Variables

$file =

[line 35]



Tags:

access:  protected

Type:   PhingFile


[ Top ]

$filesets = array()

[line 41]



Tags:

access:  protected

Type:   mixed


[ Top ]

$removepath =

[line 40]



Tags:

access:  protected

Type:   mixed


[ Top ]

$todir =

[line 39]



Tags:

access:  protected

Type:   PhingFile


[ Top ]



Class Methods


method createFileSet [line 47]

FileSet createFileSet( )

Add a new fileset.



Tags:

access:  public


[ Top ]

method extractArchive [line 116]

void extractArchive( $compressedArchiveFile)



Tags:

abstract:  
access:  protected


Overridden in child classes as:

UnzipTask::extractArchive()
Extract archive content into $this->todir directory
UntarTask::extractArchive()

Parameters:

PhingFile   $compressedArchiveFile  

[ Top ]

method isDestinationUpToDate [line 123]

boolean isDestinationUpToDate( $compressedArchiveFile, array $files, PhingFile $dir)



Tags:

access:  protected


Parameters:

array   $files   array of filenames
PhingFile   $dir  
PhingFile   $compressedArchiveFile  

[ Top ]

method listArchiveContent [line 151]

void listArchiveContent( $compressedArchiveFile)



Tags:

abstract:  
access:  protected


Overridden in child classes as:

UnzipTask::listArchiveContent()
List archive content
UntarTask::listArchiveContent()

Parameters:

PhingFile   $compressedArchiveFile  

[ Top ]

method main [line 78]

void main( )

do the work



Tags:

throws:  BuildException
access:  public


Overrides Task::main() (Called by the project to let the task do it's work. This method may be called more than once, if the task is invoked more than once. For example, if target1 and target2 both depend on target3, then running <em>phing target1 target2</em> will run all tasks in target3 twice.)

[ Top ]

method setFile [line 57]

void setFile( $file)

Set the name of the zip file to extract.



Tags:

access:  public


Parameters:

PhingFile   $file   zip file to extract

[ Top ]

method setRemovePath [line 69]

void setRemovePath( $removepath)



Tags:

access:  public


Parameters:

   $removepath  

[ Top ]

method setToDir [line 65]

void setToDir( $todir, PhingFile $baseDir)

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



Tags:

access:  public


Parameters:

PhingFile   $baseDir  
PhingFile   $todir  

[ Top ]

method validateAttributes [line 160]

void validateAttributes( )

Validates attributes coming in from XML



Tags:

throws:  BuildException
access:  protected


[ Top ]


Documentation generated on Mon, 19 Oct 2009 10:50:53 +0200 by phpDocumentor 1.4.3