# types/selectors/TypeSelector.php

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

Author
  Hans Lellelid (Phing)
Author
  Jeff Turner (Ant)
Package
  phing.types.selectors
Version
  $Revision: 526 $

## \TypeSelector
jump to top

Package: phing\types\selectors

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

Parent(s)
  \BaseExtendSelector < \BaseSelector < \DataType < \ProjectComponent
Author
  Hans Lellelid (Phing)
Author
  Jeff Turner (Ant)
Version
  $Revision: 526 $

### Constants

`TYPE_KEY = "type"`

Key to used for parameterized custom selector

### Properties

`$type= ''`
Details

Type
  n/a

`$types= 'array('file''`
static

Valid types

Default value `array('file'`Details

Type
  n/a

### Methods

`circularReference( ) : void`

`dieOnCircularReference( ) : void`

`getCheckedRef( ) : void`

`getDescription( ) : void`

`getError( ) : void`

`getParameters( ) : void`

`getProject( ) : void`

`isReference( ) : void`

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

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

Parameters

Name | Type | Description
--- | --- | ---
$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

Returns

Type | Description
--- | ---
boolean | Whether the file should be selected or not

`log( ) : void`

`noChildrenAllowed( ) : void`

`parsingComplete( ) : void`

`setDescription( ) : void`

`setError( ) : void`

`setParameters( array $parameters ) : void`

When using this as a custom selector, this method will be called.

It translates each parameter into the appropriate setXXX() call.

Parameters

Name | Type | Description
--- | --- | ---
$parameters | array | the complete set of parameters for this selector

`setProject( ) : void`

`setRefid( ) : void`

`setType( string $type ) : void`

Set the type of file to require.

Parameters

Name | Type | Description
--- | --- | ---
$type | string | The type of file - 'file' or 'dir'

`toString( ) : string`

Returns

Type | Description
--- | ---
string | A string describing this object

`tooManyAttributes( ) : void`

`validate( ) : void`

`verifySettings( ) : void`

Checks to make sure all settings are kosher. In this case, it means that the pattern attribute has been set.

Documentation was generated by DocBlox 0.17.1.