tasks/system/PropertyPromptTask.php

Show:

inherited

Classes
- \PropertyPromptTask

Table of Contents

Deprecated task that uses console to prompt user for property values.

This class is very slightly simpler than the InputTask, but lacks the ability to use a non-console input handler. You should, therefore, use InputTask. This class can serve as a reference, but will be removed in the future.

Author: Hans Lellelid (Phing)
Author: Anthony J. Young-Garner (Ant)
Deprecated: - in favor of the more capable InputTask
Package: phing.tasks.system
Version: $Id$

\PropertyPromptTask
jump to top

Package: phing\tasks\system

Deprecated task that uses console to prompt user for property values.

Parent(s): \Task < \ProjectComponent
Author: Hans Lellelid (Phing)
Author: Anthony J. Young-Garner (Ant)
Copyright: 2001,2002 THYRELL. All rights reserved
Deprecated: - in favor of the more capable InputTask
Version: $Id$

Properties

string
                 $defaultValue= ''

The default value to use if no input is entered.

Details

Type: string

string
                 $description= ''

inherited

Description of the task

Inherited from: \Task::$$description

Details

Type: string
Inherited_from: \Task::$$description

\Location
                 $location= ''

inherited

Stored buildfile location

Inherited from: \Task::$$location

Details

Type: \Location
Inherited_from: \Task::$$location

\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 \Task::$$project

Default valuenullDetails

Type: \Project
Inherited_from: \ProjectComponent::$$project
Inherited_from: \Task::$$project

string
                 $promptCharacter= ''

The character to put after the text.

Details

Type: string

string
                 $promptText= ''

The text to use for the prompt.

Details

Type: string

string
                 $propertyName= ''

The property name to set with the output.

Details

Type: string

string
                 $proposedValue= ''

The entered value.

Details

Type: string

\Target
                 $target= ''

inherited

Owning Target object

Inherited from: \Task::$$target

Details

Type: \Target
Inherited_from: \Task::$$target

string
                 $taskName= ''

inherited

Taskname for logger

Inherited from: \Task::$$taskName

Details

Type: string
Inherited_from: \Task::$$taskName

string
                 $taskType= ''

inherited

Internal taskname (req)

Inherited from: \Task::$$taskType

Details

Type: string
Inherited_from: \Task::$$taskType


                 $useExistingValue= ''

Details

Type: n/a

\RuntimeConfigurable
                 $wrapper= ''

inherited

Wrapper of the task

Inherited from: \Task::$$wrapper

Details

Type: \RuntimeConfigurable
Inherited_from: \Task::$$wrapper

Methods

addText(
          string $prompt
          )
        
        :
          void

Sets the prompt text that will be presented to the user.

Parameters

Name	Type	Description
$prompt	string

getDefaultMessage(
          
          )
        
        :
          void

Returns a string to be inserted in the log message indicating whether a default response was specified in the build file.

getDefaultValue(
          
          )
        
        :
          string

Returns defaultValue specified in this task for the Property being set.

Returns

Type	Description
string

getDescription(
          
          )
        
        :
          string

inherited

Returns the textual description of the task

Inherited from: \Task::getDescription()

Returns

Type	Description
string	The text description of the task

getLocation(
          
          )
        
        :
          \Location

inherited

Returns the location within the buildfile this task occurs. Used by {@link BuildException} to give detailed error messages.

Inherited from: \Task::getLocation()

Returns

Type	Description
\Location	The location object describing the position of this task within the buildfile.

getOwningTarget(
          
          )
        
        :
          \Target

inherited

Returns the owning target of this task.

Inherited from: \Task::getOwningTarget()

Returns

Type	Description
\Target	The target object that owns this task

getProject(
          
          )
        
        :
          \Project

inherited

Returns a reference to current project

Inherited from: \ProjectComponent::getProject()\Task::getProject()

Returns

Type	Description
\Project	Reference to current porject object

getPromptCharacter(
          
          )
        
        :
          string

Returns the terminating character used to punctuate the prompt text.

Returns

Type	Description
string

getPromptText(
          
          )
        
        :
          \java.lang.String

Returns text of the prompt.

Returns

Type	Description
\java.lang.String

getPropertyName(
          
          )
        
        :
          string

Returns name of the Ant Project Property being set by this task.

Returns

Type	Description
string

getRegisterSlot(
          string $slotName
          )
        
        :
          void

inherited

Returns a name

Inherited from: \Task::getRegisterSlot()

Parameters

Name	Type	Description
$slotName	string

getRuntimeConfigurableWrapper(
          
          )
        
        :
          \RuntimeConfigurable

inherited

Returns the wrapper object for runtime configuration

Inherited from: \Task::getRuntimeConfigurableWrapper()

Returns

Type	Description
\RuntimeConfigurable	The wrapper object used by this task

getTaskName(
          
          )
        
        :
          string

inherited

Returns the name of task, used only for log messages

Inherited from: \Task::getTaskName()

Returns

Type	Description
string	Name of this task

getTaskType(
          
          )
        
        :
          string

inherited

Returns the name of the task under which it was invoked, usually the XML tagname

Inherited from: \Task::getTaskType()

Returns

Type	Description
string	The type of this task (XML Tag)

Initializes this task.

Should throw a BuildException if something goes wrong with the build

This is abstract here, but may not be overloaded by subclasses.

Throws

Exception	Description
\BuildException

isUseExistingValue(
          
          )
        
        :
          boolean

Insert the method's description here.

Creation date: (12/10/2001 8:16:16 AM)

Returns

Type	Description
boolean

log(
          string $msg, integer $level
              =
              Project::MSG_INFO
          )
        
        :
          void

inherited

Provides a project level log event to the task.

Inherited from: \Task::log()

Parameters

Name	Type	Description
$msg	string	The message to log
$level	integer	The priority of the message

Details

See: \BuildEvent
See: \BuildListener

Run the PropertyPrompt task.

Should throw a BuildException if someting goes wrong with the build

This is abstract here. Must be overloaded by real tasks.

Throws

Exception	Description
\BuildException

maybeConfigure(
          
          )
        
        :
          void

inherited

Configure this task if it hasn't been done already.

Inherited from: \Task::maybeConfigure()

perform(
          
          )
        
        :
          void

inherited

Perfrom this task

Inherited from: \Task::perform()

setDefaultvalue(
          string $newDefaultvalue
          )
        
        :
          void

Sets defaultValue for the Property being set by this task.

Parameters

Name	Type	Description
$newDefaultvalue	string

setDescription(
          string $desc
          )
        
        :
          void

inherited

Sets a textual description of the task

Inherited from: \Task::setDescription()

Parameters

Name	Type	Description
$desc	string	The text describing the task

setLocation(
          \Location $location
          )
        
        :
          void

inherited

Sets the location within the buildfile this task occurs. Called by the parser to set location information.

Inherited from: \Task::setLocation()

Parameters

Name	Type	Description
$location	\Location	The location object describing the position of this task within the buildfile.

setOwningTarget(
          \Target $target
          )
        
        :
          void

inherited

Sets the owning target this task belongs to.

Inherited from: \Task::setOwningTarget()

Parameters

Name	Type	Description
$target	\Target	Reference to owning target

setProject(
          \Project $project
          )
        
        :
          void

inherited

References the project to the current component.

Inherited from: \ProjectComponent::setProject()\Task::setProject()

Parameters

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

setPromptCharacter(
          string $newPromptcharacter
          )
        
        :
          void

Sets the terminating character used to punctuate the prompt text (default is "?").

Parameters

Name	Type	Description
$newPromptcharacter	string

setPromptText(
          string $newPrompttext
          )
        
        :
          void

Sets text of the prompt.

Parameters

Name	Type	Description
$newPrompttext	string

setPropertyName(
          \newPropertyname $newPropertyname
          )
        
        :
          void

Specifies the Phing Project Property being set by this task.

Parameters

Name	Type	Description
$newPropertyname	\newPropertyname	java.lang.String

setRuntimeConfigurableWrapper(
          \RuntimeConfigurable $wrapper
          )
        
        :
          void

inherited

Sets the wrapper object this task should use for runtime configurable elements.

Inherited from: \Task::setRuntimeConfigurableWrapper()

Parameters

Name	Type	Description
$wrapper	\RuntimeConfigurable	The wrapper object this task should use

setTaskName(
          string $name
          )
        
        :
          string

inherited

Sets the name of this task for log messages

Inherited from: \Task::setTaskName()

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
string	A string representing the name of this task for log

setTaskType(
          string $name
          )
        
        :
          void

inherited

Sets the type of the task. Usually this is the name of the XML tag

Inherited from: \Task::setTaskType()

Parameters

Name	Type	Description
$name	string	The type of this task (XML Tag)

setUseExistingValue(
          boolean $newUseExistingValue
          )
        
        :
          void

Parameters

Name	Type	Description
$newUseExistingValue	boolean

tasks/system/PropertyPromptTask.php

\PropertyPromptTaskjump to top

Properties

Methods

\PropertyPromptTask
jump to top