\Pho\FrameworkGraph

registerIncomingEdges()

registerIncomingEdges(  $classes) : void

Registers the incoming edges.

The default ones for all nodes are:

• ActorOut\Read::class
• ActorOut\Subscribe::class
• ObjOut\Publish::class

Parameters

registerOutgoingEdges()

registerOutgoingEdges(  $classes) : void

Registers the outgoing edges.

Parameters

getRegisteredIncomingEdges()

getRegisteredIncomingEdges() 

getRegisteredOutgoingEdges()

getRegisteredOutgoingEdges() 

registerHandler()

registerHandler(string  $key, string  $class) : void

Registers a new handler adapter.

Default handlers may be overriden.

Parameters

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.

existentials()

existentials() 

{@inheritdoc}

creator()

creator() : \Pho\Framework\Actor

Retrieves the creator of this node.

Returns

notifySubscribers()

notifySubscribers(\Pho\Framework\AbstractNotification  $notification) : void

Sends notification to subscriber particles

Parameters

exportCargo()

exportCargo() : array

Returns all incoming edge, outgoing edge and field keywords.

Returns

An array of incoming edge / outgoing edge / field cargo

__construct()

__construct(\Pho\Framework\Actor  $creator, \Pho\Framework\ContextInterface  $context) 

{@inheritdoc}

Parameters

add()

add(\Pho\Lib\Graph\NodeInterface  $node, \Pho\Lib\Graph\bool  $skip_signals = false,   $active_exceptions = false) 

{@inheritdoc}

should be able to change context of $node if $node's context is

Parameters

destroy()

destroy() 

{@inheritdoc}

init()

init() 

{@inheritDoc}

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}

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

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

in()

in(\Pho\Framework\ContextInterface  $context) : boolean

Checks if the given context is contained by or equal to this graph.

Parameters

Returns

initializeParticle()

initializeParticle() : void

Initializes the particle.

Its functions include:

• adding default incoming edges.
• discovering outgoing edges based on directory structure
• passing the ball to Handler initializer.

initializeHandler()

initializeHandler() : void

A helper method to set up edges and fields.

Its inner functions can be summarized as:

1) Uses the Loaders to

• examine the class structures (the constants, registered edges etc) and find out incoming and outgoing edges as well as fields. 2) Load the results into Cargo objects 3) Deploy the cargo objects back into this object so that the handler can serve method calls.

autoRegisterOutgoingEdges()

autoRegisterOutgoingEdges() : void

Auto-registers outgoing edge classes

Auto-registration is done by directory structure. Directories that sit in this folder, and are named after this class with "Out" suffix (such as "MyNodeOut" for a node class named "MyNode") would be candidate for auto-registration.

Please note, this does not check if it's actually an Edge class. The check is done by the OutgoingEdgeLoader class.

addEdges()

addEdges(string  $direction,   $classes) : self

A helper method to register edges

Parameters

Returns

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()