Phing API Documentation
Back to top  

TypeSelector

Extends \BaseExtendSelector

Selector that selects a certain kind of file: directory or regular file.

It provides support for gathering the parameters together as well as for assigning an error message and throwing a build exception if an error is detected.

author

Hans Lellelid hans@xmpl.org (Phing)
author

Jeff Turner jefft@apache.org (Ant)
version

$Id: 95c34bb6a364dc0131e9e9c5c124d5074b4a2a21 $
package

phing.types.selectors

Methods

toString

toString() : string

Response

string

A string describing this object

Set the type of file to require.

setType(string $type)

Arguments

$type

string

The type of file - 'file' or 'dir'

Set all the Parameters for this custom selector, collected by the ExtendSelector class.

setParameters($parameters)
inherited

Arguments

$parameters

<p>Subclasses can override this method to provide checking of their state. So long as they call validate() from isSelected(), this will be called automatically (unless they override validate()).</p> <p>Implementations should check for incorrect settings and call setError() as necessary.</p>

verifySettings()
inherited

The heart of the matter. This is where the selector gets to decide on the inclusion of a file in a particular fileset.

isSelected(\PhingFile $basedir, string $filename, \PhingFile $file) : boolean

Arguments

$basedir

\PhingFile

the base directory the scan is being done from

$filename

string

is the name of the file to check

$file

\PhingFile

is a PhingFile object the selector can use

Response

boolean

Whether the file should be selected or not

Allows access to the parameters gathered and set within the &lt;custom&gt; tag.

getParameters() : \the
inherited

Response

\the

set of parameters defined for this selector

Allows all selectors to indicate a setup error. Note that only the first error message is recorded.

setError($msg)
inherited

Arguments

$msg

Returns any error messages that have been set.

getError() : \the
inherited

Response

\the

error condition

Subclasses can use this to throw the requisite exception in isSelected() in the case of an error condition.

validate()
inherited

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

setDescription($desc)
inherited

Arguments

$desc

Return the description for the current data type.

getDescription()
inherited

Has the refid attribute of this element been set?

isReference()
inherited

Set the value of the refid attribute.

setRefid(\Reference $r) : void
inherited

Subclasses may need to check whether any other attributes have been set as well or child elements have been created and thus override this method. if they do they must call parent::setRefid()

Arguments

$r

\Reference

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

dieOnCircularReference($stk, \Project $p)
inherited

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.

Arguments

$stk

$p

\Project

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

getCheckedRef($requiredClass, $dataTypeName)
inherited

Arguments

$requiredClass

$dataTypeName

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

tooManyAttributes()
inherited

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

noChildrenAllowed()
inherited

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

circularReference()
inherited

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

parsingComplete() : void
inherited

References the project to the current component.

setProject(\Project $project)
inherited

Arguments

$project

\Project

The reference to the current project

Returns a reference to current project

getProject() : \Project
inherited

Response

\Project

Reference to current porject object

Logs a message with the given priority.

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

Arguments

$msg

string

The message to be logged.

$level

integer

The message's priority at this message should have

Constants

Key to used for parameterized custom selector

TYPE_KEY

Properties

type

type :

Valid types

types :
static

The passed in parameter array.

parameters :
inherited

errmsg

errmsg :
inherited

The descriptin the user has set.

description :
inherited

Value to the refid attribute. Type of Reference

ref :
inherited

Are we sure we don't hold circular references?

checked : boolean
inherited

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

var

Type(s)

boolean

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

project : \Project
inherited
var

A reference to the current project instance

Type(s)

\Project