Event_Dispatcher
[ class tree: Event_Dispatcher ] [ index: Event_Dispatcher ] [ all elements ]

Class: Event_Notification

Source Location: /Event_Dispatcher-1.1.0/Event/Notification.php

Class Overview


A Notification object


Author(s):

Version:

  • Release: @package_version@

Copyright:

  • 1997-2005 The PHP Group

Methods


Child classes:

MyNotification
custom notification class

Inherited Variables

Inherited Methods


Class Details

[line 66]
A Notification object

The Notification object can be easily subclassed and serves as a container for the information about the notification. It holds an object which is usually a reference to the object that posted the notification, a notification name used to identify the notification and some user information which can be anything you need.



[ Top ]


Method Detail

Event_Notification (Constructor)   [line 117]

Event_Notification Event_Notification( object The &$object, string $name, [array $info = array()])

Constructor
  • Access: public

Parameters:

object The   &$object     object of interest for the notification, usually is the posting object
string   $name     Notification name
array   $info     Free information array

[ Top ]

cancelNotification   [line 178]

void cancelNotification( )

Cancel the notification
  • Access: public

[ Top ]

getNotificationCount   [line 167]

int getNotificationCount( )

Get the number of posted notifications
  • Access: public

[ Top ]

getNotificationInfo   [line 146]

array getNotificationInfo( )

Returns the user info array
  • Return: user info

[ Top ]

getNotificationName   [line 128]

string getNotificationName( )

Returns the notification name
  • Return: Notification name

[ Top ]

getNotificationObject   [line 137]

object Contained &getNotificationObject( )

Returns the contained object
  • Return: object

[ Top ]

increaseNotificationCount   [line 156]

void increaseNotificationCount( )

Increase the internal count
  • Access: public

[ Top ]

isNotificationCancelled   [line 189]

boolean isNotificationCancelled( )

Checks whether the notification has been cancelled
  • Access: public

[ Top ]


Documentation generated on Fri, 24 Jul 2009 06:30:02 +0000 by phpDocumentor 1.4.2. PEAR Logo Copyright © PHP Group 2004.