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

Class: Publisher

Source Location: /phpDocumentor/Publisher.inc

Class Overview


a class for handling the publishing of data


Author(s):

Version:

  • Release: @VER@

Copyright:

  • 2000-2007 Kellin, Joshua Eichorn

Variables

Methods


Child classes:

Parser
PHP Parser for PHP 4.2.3-

Class Details

[line 54]
a class for handling the publishing of data



Tags:

author:  Kellin <passionplay@hotmail.com>
author:  Joshua Eichorn <jeichorn@phpdoc.org>
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


[ Top ]


Class Variables

$popEvent = array()

[line 67]


Type:   array


[ Top ]

$pushEvent = array()

[line 66]


Type:   array


[ Top ]

$subscriber = array()

[line 62]

Array of references objects that have Subscribed to this publisher


Type:   array


[ Top ]

$tokens = array()

[line 64]


Type:   array


[ Top ]



Class Methods


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

method 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




Tags:

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


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()

[ Top ]


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