# types/FileList.php

## \FileList
jump to top

Package: phing\types

FileList represents an explicitly named list of files. FileLists are useful when you want to capture a list of files regardless of whether they currently exist.

OR

(or a mixture of files="" and listfile="" can be used)

Parent(s)
  \DataType < \ProjectComponent
Author
  Hans Lellelid
Version
  $Revision: 526 $

### Properties

`boolean $checked= 'true'`
inherited

Are we sure we don't hold circular references?

Inherited from: \DataType::$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 value `true` Details

Type
  boolean
Inherited_from
  \DataType::$checked

`$description= 'null'`
inherited

The descriptin the user has set.

Inherited from: \DataType::$description
Default value `null` Details

Type
Inherited_from
  \DataType::$description

`$dir= ''`

Base directory for this file list.

Details

Type

`$filenames= 'array()'`

Array containing all filenames.

Default value `array()`Details

Type

`$listfile= ''`

PhingFile that contains a list of files (one per line).

Details

Type

`\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
Default value `null` Details

Type
  \Project
Inherited_from
  \ProjectComponent::$project

`$ref= 'null'`
inherited

Value to the refid attribute. Type of Reference

Inherited from: \DataType::$ref
Default value `null` Details

Type
Inherited_from
  \DataType::$ref

### Methods

`__construct( $filelist = null ) : void`

Construct a new FileList.

Parameters

Name | Type | Description
--- | --- | ---
$filelist |  |

`circularReference( ) : void`
inherited

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

Inherited from: \DataType::circularReference()
`dieOnCircularReference( $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()

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

`getCheckedRef( $requiredClass, $dataTypeName ) : void`
inherited

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

Inherited from: \DataType::getCheckedRef()
Parameters

Name | Type | Description
--- | --- | ---
$requiredClass |  |
$dataTypeName |  |

`getDescription( ) : void`
inherited

Return the description for the current data type.

Inherited from: \DataType::getDescription()
`getDir( $p ) : \PhingFile`

Get the basedir for files in list.

Parameters

Name | Type | Description
--- | --- | ---
$p |  |

Returns

Type | Description
--- | ---
\PhingFile |

`getFiles( \Project $p ) : array`

Returns the list of files represented by this FileList.

Parameters

Name | Type | Description
--- | --- | ---
$p | \Project |

Returns

Type | Description
--- | ---
array |

`getListFile( \Project $p ) : \PhingFile`

Get the source "list" file that contains file names.

Parameters

Name | Type | Description
--- | --- | ---
$p | \Project |

Returns

Type | Description
--- | ---
\PhingFile |

`getProject( ) : \Project`
inherited

Returns a reference to current project

Inherited from: \ProjectComponent::getProject()
Returns

Type | Description
--- | ---
\Project | Reference to current porject object

`getRef( \Project $p ) : void`

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

Parameters

Name | Type | Description
--- | --- | ---
$p | \Project |

`isReference( ) : void`
inherited

Has the refid attribute of this element been set?

Inherited from: \DataType::isReference()
`log( $msg, integer $level = Project::MSG_INFO ) : void`
inherited

Logs a message with the given priority.

Inherited from: \ProjectComponent::log()

@param string $msg The message to be logged.

Parameters

Name | Type | Description
--- | --- | ---
$msg |  |
$level | integer | The message's priority at this message should have

`noChildrenAllowed( ) : 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()
`parsingComplete( ) : void`
inherited

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

Inherited from: \DataType::parsingComplete()
`readListFile( \Project $p ) : void`

Reads file names from a file and adds them to the files array.

Parameters

Name | Type | Description
--- | --- | ---
$p | \Project |

`setDescription( $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()
Parameters

Name | Type | Description
--- | --- | ---
$desc |  |

`setDir( \PhingFile $dir ) : void`

Base directory for files in list.

Parameters

Name | Type | Description
--- | --- | ---
$dir | \PhingFile |

`setFiles( array $filenames ) : void`

Set the array of files in list.

Parameters

Name | Type | Description
--- | --- | ---
$filenames | array |

`setListFile( string $file ) : void`

Sets a source "list" file that contains filenames to add -- one per line.

Parameters

Name | Type | Description
--- | --- | ---
$file | string |

`setProject( \Project $project ) : void`
inherited

References the project to the current component.

Inherited from: \ProjectComponent::setProject()
Parameters

Name | Type | Description
--- | --- | ---
$project | \Project | The reference to the current project

`setRefid( \Reference $r ) : void`

Makes this instance in effect a reference to another FileList instance.

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

Parameters

Name | Type | Description
--- | --- | ---
$r | \Reference |

`tooManyAttributes( ) : void`
inherited

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

Inherited from: \DataType::tooManyAttributes()
Documentation was generated by DocBlox 0.15.1.