Growl notification task for Phing, the PHP build tool.
PHP version 5
| category | Tasks |
|---|---|
| package | phing.tasks.ext |
| version | $Id: ce70adb17e218cf71024241b4970fbbc35cc22f9 $ |
| author | Laurent Laville |
| license | BSD License |
| link | https://github.com/llaville/phing-GrowlNotifyTask |
| copyright | 2001,2002 THYRELL. All rights reserved |
__construct(\Net_Growl $growl)
\Net_Growl(optional) mock instance
getDescription() : string
| inherited_from | \Task::getDescription() |
|---|
stringThe text description of the taskgetLocation() : \Location
Used by BuildException to give detailed error messages.
| inherited_from | \Task::getLocation() |
|---|
\LocationThe location object describing the position of this
task within the buildfile.getProject() : \Project
| inherited_from | \ProjectComponent::getProject() |
|---|---|
| inherited_from | \Task::getProject() |
\ProjectReference to current porject objectgetRuntimeConfigurableWrapper() : \RuntimeConfigurable
| inherited_from | \Task::getRuntimeConfigurableWrapper() |
|---|
\RuntimeConfigurableThe wrapper object used by this taskgetTaskName() : string
| inherited_from | \Task::getTaskName() |
|---|
stringName of this taskgetTaskType() : string
| inherited_from | \Task::getTaskType() |
|---|
stringThe type of this task (XML Tag)init() : void
Should throw a BuildException if something goes wrong with the build
This is abstract here, but may not be overloaded by subclasses.
\BuildException |
|---|
log(string $msg, integer $level)
| see | \BuildEvent |
|---|---|
| see | \BuildListener |
| inherited_from | \Task::log() |
stringThe message to log
integerThe priority of the message
main() : void
This method may be called more than once, if the task is invoked more than once. For example, if target1 and target2 both depend on target3, then running phing target1 target2 will run all tasks in target3 twice.
Should throw a BuildException if someting goes wrong with the build
This is abstract here. Must be overloaded by real tasks.
\BuildException |
|---|
maybeConfigure()
| inherited_from | \Task::maybeConfigure() |
|---|
perform()
| inherited_from | \Task::perform() |
|---|
setAppicon(string $icon) : void
Must be a valid file type (png, jpg, gif, ico). Can be any of the following: - absolute url (http://domain/image.png) - absolute file path (c:\temp\image.png) - relative file path (.\folder\image.png) (relative file paths must start with a dot and are relative to GrowlNotify's phing task location
stringIcon of the application
\BuildException |
|---|
setDescription(string $desc)
| inherited_from | \Task::setDescription() |
|---|
stringThe text describing the task
setHost(string $host) : void
If any value other than 'localhost' or '127.0.0.1' is provided, the host is considered a remote host and the "pass" attribute must also be provided. Default: 127.0.0.1
stringRemote host name/ip Default: 127.0.0.1
\BuildException |
|---|
setIcon(string $icon) : void
Must be a valid file type (png, jpg, gif, ico). Can be any of the following: - absolute url (http://domain/image.png) - absolute file path (c:\temp\image.png) - relative file path (.\folder\image.png) (relative file paths must start with a dot and are relative to GrowlNotify's phing task location
stringIcon of the message
\BuildException |
|---|
setLocation(\Location $location)
Called by the parser to set location information.
| inherited_from | \Task::setLocation() |
|---|
setMessage(string $message) : void
Use \n to specify a line break.
stringNotification's text
\BuildException |
|---|
setName(string $name) : void
string(optional) Name of the application that appears in your Growl preferences Default: "Growl for Phing"
\BuildException |
|---|
setNotification(string $notification) : void
setOwningTarget(\Target $target)
setPassword(string $password) : void
A password is required to send a request to a remote host. If host attribute is specified and is any value other than 'localhost' or '127.0.0.1', then "pass" attribute is also required. Default: no password
stringPassword to send request to a remote host
\BuildException |
|---|
setPriority(string $priority) : void
Valid values are : low, moderate, normal, high, emergency Default: normal
stringNotification priority Default: normal
\BuildException |
|---|
setProject(\Project $project)
| inherited_from | \ProjectComponent::setProject() |
|---|---|
| inherited_from | \Task::setProject() |
setProtocol(string $protocol) : void
With TCP (GNTP) protocol, port is always 23053 With UDP protocol, port is always 9887 Default: 23053
stringProtocol to use to send request to remote host Default: gntp
\BuildException |
|---|
setRuntimeConfigurableWrapper(\RuntimeConfigurable $wrapper)
| inherited_from | \Task::setRuntimeConfigurableWrapper() |
|---|
setSticky(bool $sticky) : void
setTaskName(string $name) : string
| inherited_from | \Task::setTaskName() |
|---|
string
stringA string representing the name of this task for logsetTaskType(string $name)
Usually this is the name of the XML tag
| inherited_from | \Task::setTaskType() |
|---|
stringThe type of this task (XML Tag)
setTitle(string $title) : void
Use \n to specify a line break.
string(optional) Notification's title Default: GrowlNotify
\BuildException |
|---|
getRegisterSlot(string $slotName)
| inherited_from | \Task::getRegisterSlot() |
|---|
string
$appicon
$description : string
| inherited_from | \Task::$$description |
|---|
$growl
$host
$icon
$name
$notification
$password
$priority
$project : \Project
| inherited_from | \ProjectComponent::$$project |
|---|---|
| inherited_from | \Task::$$project |
$protocol
$sticky
$taskName : string
| inherited_from | \Task::$$taskName |
|---|
$taskType : string
| inherited_from | \Task::$$taskType |
|---|
$title