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 54]



		
				Author(s):
		
		
		
Information Tags:
Version:  Release: @VER@
Copyright:  2000-2007 Kellin, Joshua Eichorn
Link:  http://pear.php.net/PhpDocumentor
Link:  http://www.phpdoc.org
Todo:  CS cleanup - change package to PhpDocumentor
License:  LGPL

Properties

Methods

[ Top ]
Descendants
Child Class Description
Parser PHP Parser for PHP 4.2.3-

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

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

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

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

[ Top ]
array   $subscriber = array() [line 62]

Array of references objects that have Subscribed to this publisher


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

[ Top ]
Methods
publishEvent  [line 96]

  void publishEvent( integer $event, mixed $data  )

Publish an event

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


[ Top ]
subscribe  [line 83]

  void subscribe( integer $event, 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()

Information Tags:
Todo:  CS Cleanup - there's no way I can get the &$object desc under 85 chars

[ Top ]

Documentation generated on Tue, 06 Dec 2011 07:21:14 -0600 by phpDocumentor 1.4.4