tasks/system/EchoTask.php

Echos a message to the logging system or to a file

Parent(s)

\Task < \ProjectComponent

Children

\WarnTask

Author

Andreas Aderhold, andi@binarycloud.com  

Version

$Revision: 1335 $ $Date: 2011-10-28 21:22:27 +0200 (Fri, 28 Oct 2011) $  

Properties

 $append= 'false'

Default valuefalseDetails

Type

n/a

 $file= '""'

Default value""Details

Type

n/a

 $filesets= 'array()'

Default valuearray()Details

Type

n/a

 $level= '"info"'

Default value"info"Details

Type

n/a

 $msg= '""'

Default value""Details

Type

n/a

Methods

addFileSet( \FileSet $fs ) : void

Adds a fileset to echo the files of

Parameters

Name	Type	Description
$fs	\FileSet	Set of files to echo

addText(  $msg ) : void

Supporting the Message syntax.

Parameters

Name	Type	Description
$msg

getDescription( ) : void

getFilesetsMsg( ) : string

Merges all filesets into a string to be echoed out

Returns

Type	Description
string	String to echo

getLocation( ) : void

getOwningTarget( ) : void

getProject( ) : void

getRegisterSlot( ) : void

getRuntimeConfigurableWrapper( ) : void

getTaskName( ) : void

getTaskType( ) : void

init( ) : void

log( ) : void

main( ) : void

maybeConfigure( ) : void

perform( ) : void

setAppend(  $append ) : void

setter for append

Parameters

Name	Type	Description
$append

setDescription( ) : void

setFile(  $file ) : void

setter for file

Parameters

Name	Type	Description
$file

setLevel(  $level ) : void

setter for level

Parameters

Name	Type	Description
$level

setLocation( ) : void

setMessage(  $msg ) : void

alias setter

Parameters

Name	Type	Description
$msg

setMsg(  $msg ) : void

setter for message

Parameters

Name	Type	Description
$msg

setOwningTarget( ) : void

setProject( ) : void

setRuntimeConfigurableWrapper( ) : void

setTaskName( ) : void

setTaskType( ) : void