tasks/system/LoadFileTask.php

Show: inherited
Table of Contents

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

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

Propertyprivate\PhingFile  $file= ''

File to read

file
Details
Type
\PhingFile
Propertyprivate\FilterChain[]  $filterChains= 'array()'

Array of FilterChain objects

Default valuearray()Details
Type
\FilterChain[]
Propertyprivatestring  $property= ''

Property to be set

Details
Type
string

Methods

methodpubliccreateFilterChain( ) : object

Creates a filterchain

Returns
Type Description
object The created filterchain object
methodpublicgetDescription( ) : void

methodpublicgetLocation( ) : void

methodpublicgetOwningTarget( ) : void

methodpublicgetProject( ) : void

methodprotectedgetRegisterSlot( ) : void

methodpublicgetRuntimeConfigurableWrapper( ) : void

methodpublicgetTaskName( ) : void

methodpublicgetTaskType( ) : void

methodpublicinit( ) : void

methodpubliclog( ) : void

methodpublicmain( ) : void

Main method

Throws
Exception Description
\BuildException
methodpublicmaybeConfigure( ) : void

methodpublicperform( ) : void

methodpublicsetDescription( ) : void

methodpublicsetFile( \PhingFile $file ) : void

Set file to read

Parameters
Name Type Description
$file \PhingFile
methodpublicsetLocation( ) : void

methodpublicsetOwningTarget( ) : void

methodpublicsetProject( ) : void

methodpublicsetProperty(  $property ) : void

Set name of property to be set

Parameters
Name Type Description
$property
methodpublicsetRuntimeConfigurableWrapper( ) : void

methodpublicsetSrcFile(  $srcFile ) : void

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

Parameters
Name Type Description
$srcFile
methodpublicsetTaskName( ) : void

methodpublicsetTaskType( ) : void

Documentation was generated by DocBlox 0.17.1.