PHP Interface Jackalope\Transport\ObservationInterface

Inheritance: extends Jackalope\Transport\TransportInterface

Show file Open project: jackalope/jackalope Interface Usage Examples

Public Methods

Method	Description
getEvents ( integer $date, PHPCR\Observation\EventFilterInterface $filter, PHPCR\SessionInterface $session ) : Iterator	Request a fragment of the observation journal from the server.
setUserData ( mixed $userData )	Set user data to be included with subsequent requests.

Method Details

getEvents() public method

This method returns a buffer of events matching the filter that might lazy-load events from storage. But it may never load events that happen later than the time the buffer was created, to avoid endless looping on busy repositories.

public getEvents ( integer $date, PHPCR\Observation\EventFilterInterface $filter, PHPCR\SessionInterface $session ) : Iterator
$date	integer	milliseconds since the epoch - see EventJournalInterface::skipTo
$filter	PHPCR\Observation\EventFilterInterface	event filter the transport must apply
$session	PHPCR\SessionInterface	in case the transport needs this for filtering
return	Iterator

setUserData() public method

Setting userData to null (which it is by default) will result in no user data header being sent.

public setUserData ( mixed $userData )
$userData	mixed	null or string