# tasks/system/LoadFileTask.php

LoadFileTask

Loads a (text) file and stores the contents in a property. Supports filterchains.

Author
  Michiel Rook
Package
  phing.tasks.ext
Version
  $Id: LoadFileTask.php 1126 2011-05-31 20:49:04Z mrook $

## \LoadFileTask
jump to top

Package: phing\tasks\ext

LoadFileTask

Loads a (text) file and stores the contents in a property. Supports filterchains.

Parent(s)
  \Task < \ProjectComponent
Author
  Michiel Rook
Version
  $Id: LoadFileTask.php 1126 2011-05-31 20:49:04Z mrook $

### Properties

`\PhingFile $file= ''`

File to read

file
Details

Type
  \PhingFile

`\FilterChain[] $filterChains= 'array()'`

Array of FilterChain objects

Default value `array()`Details

Type
  \FilterChain[]

`string $property= ''`

Property to be set

Details

Type
  string

### Methods

`createFilterChain( ) : object`

Creates a filterchain

Returns

Type | Description
--- | ---
object | The created filterchain object

`getDescription( ) : void`

`getLocation( ) : void`

`getOwningTarget( ) : void`

`getProject( ) : void`

`getRegisterSlot( ) : void`

`getRuntimeConfigurableWrapper( ) : void`

`getTaskName( ) : void`

`getTaskType( ) : void`

`init( ) : void`

`log( ) : void`

`main( ) : void`

Main method

Throws

Exception | Description
--- | ---
\BuildException |

`maybeConfigure( ) : void`

`perform( ) : void`

`setDescription( ) : void`

`setFile( \PhingFile $file ) : void`

Set file to read

Parameters

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

`setLocation( ) : void`

`setOwningTarget( ) : void`

`setProject( ) : void`

`setProperty( $property ) : void`

Set name of property to be set

Parameters

Name | Type | Description
--- | --- | ---
$property |  |

`setRuntimeConfigurableWrapper( ) : void`

`setSrcFile( $srcFile ) : void`

Convenience setter to maintain Ant compatibility (@see setFile())

Parameters

Name | Type | Description
--- | --- | ---
$srcFile |  |

`setTaskName( ) : void`

`setTaskType( ) : void`

Documentation was generated by DocBlox 0.17.1.