DepthSelector

Extends \BaseExtendSelector

Selector that filters files based on the how deep in the directory tree they are.

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 [email protected] (Phing)

author

Bruce Atherton [email protected] (Ant)

package

phing.types.selectors

Methods

__construct

__construct() 
inherited

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

circularReference() : \BuildException
inherited

Response

\BuildException

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

Throws
\BuildException

Arguments

$stk

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

getCheckedRef( $requiredClass,  $dataTypeName) : mixed
inherited
Throws
\BuildException

Arguments

$requiredClass

$dataTypeName

Response

mixed

Returns the description of the current action.

getDescription() : string
inherited

Response

string

the description of the current action, or null if no description is available.

Returns any error messages that have been set.

getError() : string
inherited

Response

string

the error condition

Returns the file/location where this task was defined.

getLocation() : \Location
inherited

Response

\Location

the file/location where this task was defined. Should not return null.

Allows access to the parameters gathered and set within the <custom> tag.

getParameters() : array
inherited

Response

array

the set of parameters defined for this selector

Returns a reference to current project

getProject() : \Project
inherited

Response

\Project

Reference to current porject object

Has the refid attribute of this element been set?

isReference() : boolean
inherited

Response

boolean

The heart of the matter. This is where the selector gets to decide on the inclusion of a file in a particular fileset. Most of the work for this selector is offloaded into SelectorUtils, a static class that provides the same services for both FilenameSelector and DirectoryScanner.

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

{@inheritdoc}

Throws
\BuildException

Arguments

$basedir

\PhingFile

base directory the scan is being done from

$filename

string

the name of the file to check

$file

\PhingFile

a PhingFile object the selector can use

Response

boolean

whether the file should be selected or not

Logs a message with the given priority.

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

Arguments

$msg

string

The message to be logged.

$level

integer

The message's priority at this message should have

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

noChildrenAllowed() : \BuildException
inherited

Response

\BuildException

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

parsingComplete() : void
inherited

{@inheritdoc}

pushAndInvokeCircularReferenceCheck

pushAndInvokeCircularReferenceCheck(\DataType $dt,  &$stk, \Project $p) 
inherited static

Arguments

$dt

\DataType

$stk

setChecked

setChecked(boolean $checked) 
inherited

Arguments

$checked

boolean

Sets a description of the current action. This may be used for logging purposes.

setDescription(string $desc) 
inherited

Arguments

$desc

string

Description of the current action. May be null, indicating that no description is available.

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

setError(string $msg, \Exception $cause = null) 
inherited

Arguments

$msg

string

The error message any BuildException should throw.

$cause

\Exception

Sets the file/location where this task was defined.

setLocation(\Location $location) 
inherited

Arguments

$location

\Location

The file/location where this task was defined. Should not be null

The minimum depth below the basedir before a file is selected.

setMax(integer $max) : void

Arguments

$max

integer

maximum directory levels below basedir to go

The minimum depth below the basedir before a file is selected.

setMin(integer $min) : void

Arguments

$min

integer

minimum directory levels below basedir to go

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

setParameters(array $parameters) : mixed|void
inherited

Arguments

$parameters

array

the complete set of parameters for this selector

Response

mixed|void

References the project to the current component.

setProject(\Project $project) : void
inherited

Arguments

$project

\Project

The reference to the current project

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

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

tooManyAttributes() : \BuildException
inherited

Response

\BuildException

toString

toString() : string

Response

string

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

validate() 
inherited
Throws
\BuildException

<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
Throws
\BuildException

Constants

MIN_KEY

MIN_KEY

MAX_KEY

MAX_KEY

Properties

min

min : integer
var

Type(s)

integer

max

max : integer
var

Type(s)

integer

The passed in parameter array.

parameters : 
inherited

Type(s)

errmsg

errmsg : string
inherited
var

Type(s)

string

cause

cause : \Exception
inherited
var

Type(s)

\Exception

Value to the refid attribute.

ref : \Reference
inherited
var

Type(s)

\Reference

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

location

location : \Location
inherited
var

Type(s)

\Location

description

description : string
inherited
var

Type(s)

string