\Everyman\Neo4jPager

Holds the parameters for running a paged traversal

Summary

Methods
Properties
Constants
__construct()
getId()
getLeaseTime()
getNextResults()
getPageSize()
getReturnType()
getStartNode()
getTraversal()
setId()
setLeaseTime()
setPageSize()
No public properties found
No constants found
No protected methods found
$traversal
$startNode
$returnType
$id
$leaseTime
$pageSize
N/A
No private methods found
No private properties found
N/A

Properties

$traversal

$traversal : 

Type

$startNode

$startNode : 

Type

$returnType

$returnType : 

Type

$id

$id : 

Type

$leaseTime

$leaseTime : 

Type

$pageSize

$pageSize : 

Type

Methods

__construct()

__construct(\Everyman\Neo4j\Traversal $traversal, \Everyman\Neo4j\Node $startNode, string $returnType)

Set the traversal to paginate

Parameters

\Everyman\Neo4j\Traversal $traversal
\Everyman\Neo4j\Node $startNode
string $returnType

getId()

getId() : string

Get the paged traversal id

Returns

string

getLeaseTime()

getLeaseTime() : integer

Get the lease time, in secods

Returns

integer

getNextResults()

getNextResults() : array

Get the next page of results If the traversal hasn't been run yet, this will run it

Returns

array

getPageSize()

getPageSize() : integer

Get the maximum result page set size

Returns

integer

getReturnType()

getReturnType() : string

Get the return type

Returns

string

getStartNode()

getStartNode() : \Everyman\Neo4j\Node

Return the start node of the traversal

Returns

\Everyman\Neo4j\Node

getTraversal()

getTraversal() : \Everyman\Neo4j\Traversal

Get the traversal being paginated

Returns

\Everyman\Neo4j\Traversal

setId()

setId(string $id) : \Everyman\Neo4j\Traversal

Set the paged traversal id

Parameters

string $id

Returns

\Everyman\Neo4j\Traversal

setLeaseTime()

setLeaseTime(integer $leaseTime) : \Everyman\Neo4j\Traversal

Set the lease time

Parameters

integer $leaseTime

Returns

\Everyman\Neo4j\Traversal

setPageSize()

setPageSize(integer $pageSize) : \Everyman\Neo4j\Traversal

Set the page size

Parameters

integer $pageSize

Returns

\Everyman\Neo4j\Traversal