\Pho\Lib\GraphSubGraph

init()

init() 

{@inheritDoc}

add()

add(\Pho\Lib\Graph\NodeInterface  $node) : \Pho\Lib\Graph\NodeInterface

Adds a new node to the Graph.

Under normal circumstances, you don't use this function because entities are created with the graph object that they belong to in their constructor function, hence the attachment is committed automatically, including subgraphs's.

To illustare this, take a look at the following example:

$world = new Graph();
$google = new SubGraph($world);
$mark_zuckerberg = new Node($world); // facebook
$larry_page = new Node($google); // google
$vincent_cerf = new Node($google); // google
print_r($world->toArray()["members]);
print_r($google->toArray()["members]);

The output of the first print_r call, which shows $world members, will include $google members as well, even though $google members were created with the $google as their context parameter, and not $world. This is because $google was set to be a subgraph of $world in its constructor function. The link was made automatically, and this works recursively.

Parameters

Returns

For chaining.

canEmitNodeAddSignals()

canEmitNodeAddSignals() 

{@inheritDoc}

loadNodesFromArray()

loadNodesFromArray(array  $nodes) 

{@inheritdoc}

Parameters

loadNodesFromIDArray()

loadNodesFromIDArray(array  $node_ids) 

{@inheritdoc}

Parameters

get()

get(\Pho\Lib\Graph\ID  $node_id) 

{@inheritdoc}

Parameters

contains()

contains(\Pho\Lib\Graph\ID  $node_id) 

{@inheritdoc}

Parameters

remove()

remove(\Pho\Lib\Graph\ID  $node_id) 

{@inheritdoc}

Parameters

members()

members() 

{@inheritdoc}

count()

count() 

{@inheritdoc}

__construct()

__construct(\Pho\Lib\Graph\GraphInterface  $context) 

{@inheritdoc}

Parameters

context()

context() : \Pho\Lib\Graph\ArrayObject

Returns the context that this node is a member of.

Contexts are GraphInterface objects that contain nodes.

Returns

An ArrayObject of contexts in no particular order.

changeContext()

changeContext(\Pho\Lib\Graph\GraphInterface  $context) : void

Changes the fundamental context of a node.

Rarely, a node may need its fundamental context to change after its construction. This method enables setting a new context for the node.

Parameters

edges()

edges() : \Pho\Lib\Graph\EdgeList

Gives access to this node's EdgeList property.

EdgeList contains all the edges in and out from this node. It is also used to add new edges.

Returns

toArray()

toArray() : array

Converts the object to array

Used for serialization/unserialization. Converts internal object properties into a simple format to help with reconstruction.

Returns

The object in array format.

edge()

edge(\Pho\Lib\Graph\string  $id) : \Pho\Lib\Graph\EdgeInterface

Retrieve Edge objects given its ID.

Used in serialization. This function must be implemented for a higher level package with persistence. Otherwise it has no use and no function within pho-lib-graph.

Parameters

Returns

hook()

hook(\Pho\Lib\Graph\string  $method, \Closure  $call) 

{@inheritDoc}

Parameters

unhook()

unhook(\Pho\Lib\Graph\string  $method) 

{@inheritDoc}

Parameters

hooks()

hooks() 

on()

on(\Pho\Lib\Graph\Event\string  $eventName,   $callBack, \Pho\Lib\Graph\Event\int  $priority = 100) : void

Subscribe to an event.

Parameters

emit()

emit(\Pho\Lib\Graph\Event\string  $eventName, array  $arguments = array()) 

Emits an event.

This method will return true if 0 or more listeners were succesfully handled. false is returned if one of the events broke the event chain.

Pho: Please note, continueCallback does not exist with Pho

If the continueCallBack is specified, this callback will be called every time before the next event handler is called.

If the continueCallback returns false, event propagation stops. This allows you to use the eventEmitter as a means for listeners to implement functionality in your application, and break the event loop as soon as some condition is fulfilled.

Note that returning false from an event subscriber breaks propagation and returns false, but if the continue-callback stops propagation, this is still considered a 'successful' operation and returns true.

Lastly, if there are 5 event handlers for an event. The continueCallback will be called at most 4 times.

Parameters

listeners()

listeners(\Pho\Lib\Graph\Event\string  $eventName, \Pho\Lib\Graph\Event\bool  $flat = false) : array<mixed,callable>

Returns the list of listeners for an event.

The list is returned as an array, and the list of events are sorted by their priority.

Parameters

Returns

removeAllListeners()

removeAllListeners(\Pho\Lib\Graph\Event\string  $eventName = null) : void

Removes all listeners.

If the eventName argument is specified, all listeners for that event are removed. If it is not specified, every listener for every event is removed.

Parameters

destroy()

destroy() 

{@inheritdoc}

graphToArray()

graphToArray() : array

Converts the object to array

Used for serialization/unserialization. Converts internal object properties into a simple format to help with reconstruction.

Returns

The object in array format.

hookable()

hookable()