Phing API Documentation
Back to top  

GrowlNotifyTask

Extends \Task

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

Methods

Initializes task with default options

__construct(\Net_Growl $growl = null)

Arguments

$growl

\Net_Growl

(optional) mock instance

Called by the parser to let the task initialize properly.

init()
inherited

Should throw a BuildException if something goes wrong with the build

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

throws

Defines the name of the application sending the notification

setName(string $name = '') : void
throws

Arguments

$name

string

(optional) Name of the application that appears in your Growl preferences Default: "Growl for Phing"

Indicates if the notification should be sticky

setSticky(bool $sticky = true) : void
throws

Arguments

$sticky

bool

(optional) Notification should be sticky

The notification's text is required.

setMessage(string $message = '') : void

Use \n to specify a line break.

throws

Arguments

$message

string

Notification's text

The notification's title.

setTitle(string $title = '') : void

Use \n to specify a line break.

throws

Arguments

$title

string

(optional) Notification's title Default: GrowlNotify

The notification name/type

setNotification(string $notification = '') : void
throws

Arguments

$notification

string

Name/type Default: "General Notification"

The icon of the application being registered.

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

Arguments

$icon

string

Icon of the application

The host address to send the notification to.

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

Arguments

$host

string

Remote host name/ip Default: 127.0.0.1

The password required to send notifications.

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

Arguments

$password

string

Password to send request to a remote host

The notification priority.

setPriority(string $priority = '') : void

Valid values are : low, moderate, normal, high, emergency Default: normal

throws

Arguments

$priority

string

Notification priority Default: normal

The protocol (and port) to send the notification to.

setProtocol(string $protocol = '') : void

With TCP (GNTP) protocol, port is always 23053 With UDP protocol, port is always 9887 Default: 23053

throws

Arguments

$protocol

string

Protocol to use to send request to remote host Default: gntp

The icon to show for the notification.

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

Arguments

$icon

string

Icon of the message

Called by the project to let the task do it's work. 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 <em>phing target1 target2</em> will run all tasks in target3 twice.

main()
inherited abstract

Should throw a BuildException if someting goes wrong with the build

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

Sets the owning target this task belongs to.

setOwningTarget(\Target $target)
inherited

Arguments

$target

\Target

Returns the owning target of this task.

getOwningTarget() : \Target
inherited

Response

\Target

The target object that owns this task

Returns the name of task, used only for log messages

getTaskName() : string
inherited

Response

string

Name of this task

Sets the name of this task for log messages

setTaskName(string $name) : string
inherited

Arguments

$name

string

Response

string

A string representing the name of this task for log

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

getTaskType() : string
inherited

Response

string

The type of this task (XML Tag)

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

setTaskType($name)
inherited

Arguments

$name

Returns a name

getRegisterSlot(string $slotName)
inherited

Arguments

$slotName

string

Logs a message with the given priority.

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

Arguments

$msg

string

The message to be logged.

$level

integer

The message's priority at this message should have

Sets a textual description of the task

setDescription(string $desc)
inherited

Arguments

$desc

string

The text describing the task

Returns the textual description of the task

getDescription() : string
inherited

Response

string

The text description of the task

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

getLocation() : \Location
inherited

Response

\Location

The location object describing the position of this task within the buildfile.

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

setLocation(\Location $location)
inherited

Arguments

$location

\Location

The location object describing the position of this task within the buildfile.

Returns the wrapper object for runtime configuration

getRuntimeConfigurableWrapper() : \RuntimeConfigurable
inherited

Response

\RuntimeConfigurable

The wrapper object used by this task

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

setRuntimeConfigurableWrapper(\RuntimeConfigurable $wrapper)
inherited

Arguments

$wrapper

\RuntimeConfigurable

The wrapper object this task should use

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

maybeConfigure()
inherited

Perfrom this task

perform()
inherited

References the project to the current component.

setProject(\Project $project)
inherited

Arguments

$project

\Project

The reference to the current project

Returns a reference to current project

getProject() : \Project
inherited

Response

\Project

Reference to current porject object

Properties

growl

growl :

name

name :

sticky

sticky :

message

message :

title

title :

notification

notification :

appicon

appicon :

host

host :

password

password :

priority

priority :

protocol

protocol :

icon

icon :

Owning Target object

target : \Target
inherited
var

Type(s)

\Target

Description of the task

description : string
inherited
var

Type(s)

string

Internal taskname (req)

taskType : string
inherited
var

Type(s)

string

Taskname for logger

taskName : string
inherited
var

Type(s)

string

Stored buildfile location

location : \Location
inherited
var

Type(s)

\Location

Wrapper of the task

wrapper : \RuntimeConfigurable
inherited
var

Type(s)

\RuntimeConfigurable

Holds a reference to the project that a project component (a task, a target, etc.) belongs to

project : \Project
inherited
var

A reference to the current project instance

Type(s)

\Project