PHP Interface Doctrine\OrientDB\Graph\VertexInterface

Show file Open project: doctrine/orientdb-odm Interface Usage Examples

Public Methods

Method Description
connect ( Doctrine\OrientDB\Graph\VertexInterface $vertex, integer $distance = 1 ) Connects the vertex to another $vertex.
getConnections ( ) : Array Returns the connections of the current vertex.
getId ( ) : mixed Returns the identifier of this vertex.
getPotential ( ) : integer Returns vertex's potential.
getPotentialFrom ( ) : Vertex Returns the vertex which gave to the current vertex its potential.
isPassed ( ) : boolean Returns whether the vertex has passed or not.
markPassed ( ) Marks this vertex as passed, meaning that, in the scope of a graph, he has already been processed in order to calculate its potential.
setPotential ( integer $potential, Doctrine\OrientDB\Graph\VertexInterface $from ) : boolean Sets the potential for the vertex, if the vertex has no potential or the one it has is higher than the new one.

Method Details

connect() public method

A $distance, to balance the connection, can be specified.
public connect ( Doctrine\OrientDB\Graph\VertexInterface $vertex, integer $distance = 1 )
$vertex Doctrine\OrientDB\Graph\VertexInterface
$distance integer

getConnections() public method

Returns the connections of the current vertex.
public getConnections ( ) : Array
return Array

getId() public method

Returns the identifier of this vertex.
public getId ( ) : mixed
return mixed

getPotential() public method

Returns vertex's potential.
public getPotential ( ) : integer
return integer

getPotentialFrom() public method

Returns the vertex which gave to the current vertex its potential.
public getPotentialFrom ( ) : Vertex
return Vertex

isPassed() public method

Returns whether the vertex has passed or not.
public isPassed ( ) : boolean
return boolean

markPassed() public method

Marks this vertex as passed, meaning that, in the scope of a graph, he has already been processed in order to calculate its potential.
public markPassed ( )

setPotential() public method

Sets the potential for the vertex, if the vertex has no potential or the one it has is higher than the new one.
public setPotential ( integer $potential, Doctrine\OrientDB\Graph\VertexInterface $from ) : boolean
$potential integer
$from Doctrine\OrientDB\Graph\VertexInterface
return boolean