PHP Class Jackalope\Observation\EventJournal

Author: D. Barsotti ([email protected])
Inheritance: extends ArrayIterator, implements PHPCR\Observation\EventJournalInterface
Show file Open project: jackalope/jackalope Class Usage Examples

Protected Properties

Property Type Description
$currentMillis integer SkipTo timestamp for next fetch. Either manually set or next page.
$events ArrayIterato\ArrayIterator Buffered events
$factory Jackalope\FactoryInterface
$filter EventFilter
$session PHPCR\SessionInterface
$transport Jackalope\Transport\ObservationInterface
$workspaceRootUri string The prefix to extract the path from the event href attribute

Public Methods

Method Description
__construct ( Jackalope\FactoryInterface $factory, EventFilter $filter, PHPCR\SessionInterface $session, Jackalope\Transport\ObservationInterface $transport ) Prepare a new EventJournal.
current ( )
key ( )
next ( )
rewind ( )
seek ( $position )
skipTo ( $date ) {@inheritDoc}
valid ( )

Protected Methods

Method Description
fetchJournal ( )

Method Details

__construct() public method

Actual data loading is deferred to when it is first requested.
public __construct ( Jackalope\FactoryInterface $factory, EventFilter $filter, PHPCR\SessionInterface $session, Jackalope\Transport\ObservationInterface $transport )
$factory Jackalope\FactoryInterface
$filter EventFilter filter to give the transport and apply locally.
$session PHPCR\SessionInterface
$transport Jackalope\Transport\ObservationInterface a transport implementing the observation methods.

current() public method

public current ( )

fetchJournal() protected method

protected fetchJournal ( )

key() public method

public key ( )

next() public method

public next ( )

rewind() public method

public rewind ( )

seek() public method

public seek ( $position )

skipTo() public method

{@inheritDoc}
public skipTo ( $date )

valid() public method

public valid ( )

Property Details

$currentMillis protected property

SkipTo timestamp for next fetch. Either manually set or next page.
protected int $currentMillis
return integer

$events protected property

Buffered events
protected ArrayIterator,ArrayIterato $events
return ArrayIterato\ArrayIterator

$factory protected property

protected FactoryInterface,Jackalope $factory
return Jackalope\FactoryInterface

$filter protected property

protected EventFilter,Jackalope\Observation $filter
return EventFilter

$session protected property

protected SessionInterface,PHPCR $session
return PHPCR\SessionInterface

$transport protected property

protected ObservationInterface,Jackalope\Transport $transport
return Jackalope\Transport\ObservationInterface

$workspaceRootUri protected property

The prefix to extract the path from the event href attribute
protected string $workspaceRootUri
return string