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

Class: Publisher

Source Location: /PhpDocumentor-1.5.0a1/phpDocumentor/Publisher.inc

Class Overview


a class for handling the publishing of data


Author(s):

Version:

  • Release: 1.5.0a1

Copyright:

  • 2000-2007 Kellin, Joshua Eichorn

Variables

Methods


Child classes:

Parser
PHP Parser for PHP 4.2.3-

Inherited Variables

Inherited Methods


Class Details

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


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



Method Detail

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

  • 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 Sun, 02 Sep 2012 00:03:02 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.