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

Class: Publisher

Source Location: /phpDocumentor/Publisher.inc

Class Publisher

Class Overview

a class for handling the publishing of data

Located in /phpDocumentor/Publisher.inc [line 46]



		
				Author(s):
		
		
		
Information Tags:
Version:  $Id: Publisher.inc,v 1.3 2006/04/30 22:18:14 cellog Exp $

Properties

Methods

[ Top ]
Direct descendents
Child Class Description
Parser PHP Parser for PHP 4.2.3-

[ Top ]
Property Summary
array   $popEvent  
array   $pushEvent  
mixed   $subscriber   Array of references objects that have Subscribed to this publisher
array   $tokens  

[ Top ]
Method Summary
void   publishEvent()  
void   subscribe()   Adds a subscriber to the $subscriber array().

[ Top ]
Properties
array   $popEvent = array() [line 59]

[ Top ]
array   $pushEvent = array() [line 58]

[ Top ]
mixed   $subscriber = array() [line 54]

Array of references objects that have Subscribed to this publisher


[ Top ]
array   $tokens = array() [line 56]

[ Top ]
Methods
publishEvent  [line 78]

  void publishEvent( integer $event, mixed $data  )

Parameters:
integer   $event:  see Parser.inc PARSER_EVENT_* constants
mixed   $data:  anything the subscribed event handler is expecting


[ Top ]
subscribe  [line 69]

  void subscribe( integer $event, &$object, class $object  )

Adds a subscriber to the $subscriber array().

if $event is '*', the publisher will use $object as the default event handler

Parameters:
integer   $event:  see Parser.inc PARSER_EVENT_* constants
class   $object:  any class that has a HandleEvent() method like phpDocumentor_IntermediateParser::HandleEvent() or Classes::HandleEvent()
   &$object: 


[ Top ]

Documentation generated on Tue, 24 Oct 2006 09:26:00 -0500 by phpDocumentor 1.3.1