Growl notification task for Phing, the PHP build tool.
PHP version 5
category |
Tasks |
---|---|
package |
phing.tasks.ext |
version |
$Id: ce70adb17e218cf71024241b4970fbbc35cc22f9 $ |
author |
Laurent Laville pear@laurent-laville.org |
license |
http://www.opensource.org/licenses/bsd-license.php BSD License |
link |
https://github.com/llaville/phing-GrowlNotifyTask |
__construct(\Net_Growl $growl = null)
\Net_Growl
(optional) mock instance
init()
Should throw a BuildException if something goes wrong with the build
This is abstract here, but may not be overloaded by subclasses.
throws |
---|
setName(string $name = '') : void
throws |
---|
string
(optional) Name of the application that appears in your Growl preferences Default: "Growl for Phing"
setSticky(bool $sticky = true) : void
throws |
---|
bool
(optional) Notification should be sticky
setMessage(string $message = '') : void
Use \n to specify a line break.
throws |
---|
string
Notification's text
setTitle(string $title = '') : void
Use \n to specify a line break.
throws |
---|
string
(optional) Notification's title Default: GrowlNotify
setNotification(string $notification = '') : void
throws |
---|
string
Name/type Default: "General Notification"
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
throws |
---|
string
Icon of the application
setHost(string $host = '127.0.0.1') : 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
throws |
---|
string
Remote host name/ip Default: 127.0.0.1
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
throws |
---|
string
Password to send request to a remote host
setPriority(string $priority = '') : void
Valid values are : low, moderate, normal, high, emergency Default: normal
throws |
---|
string
Notification priority Default: normal
setProtocol(string $protocol = '') : void
With TCP (GNTP) protocol, port is always 23053 With UDP protocol, port is always 9887 Default: 23053
throws |
---|
string
Protocol to use to send request to remote host Default: gntp
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
throws |
---|
string
Icon of the message
main()
Should throw a BuildException if someting goes wrong with the build
This is abstract here. Must be overloaded by real tasks.
setOwningTarget(\Target $target)
getOwningTarget() : \Target
getTaskName() : string
string
Name of this task
setTaskName(string $name) : string
string
string
A string representing the name of this task for log
getTaskType() : string
string
The type of this task (XML Tag)
setTaskType($name)
getRegisterSlot(string $slotName)
string
log(string $msg, integer $level = \Project::MSG_INFO)
string
The message to be logged.
integer
The message's priority at this message should have
setDescription(string $desc)
string
The text describing the task
getDescription() : string
string
The text description of the task
getLocation() : \Location
setLocation(\Location $location)
getRuntimeConfigurableWrapper() : \RuntimeConfigurable
setRuntimeConfigurableWrapper(\RuntimeConfigurable $wrapper)
maybeConfigure()
perform()
setProject(\Project $project)
getProject() : \Project
growl :
name :
sticky :
title :
notification :
appicon :
host :
password :
priority :
protocol :
icon :
description : string
var |
---|
string
taskType : string
var |
---|
string
taskName : string
var |
---|
string
project : \Project