\Phabstractic\Data\Types\ResourceLeafInterface

Leaf Interface - Defines A Branch/Leaf Structure Interface

CHANGELOG

1.0: Created DirectoryInterface - February 8th, 2014 1.1: Repurposed to LeafInterface - February 9th, 2014 Documented LeafInterface fully - February 21st, 2014 2.0: Integrated Leaf Interface into Primus - August 26th, 2015 3.0: eliminated data methods reformatted for inclusion in phabstractic - August 1st, 2016

Summary

Methods

Constants

getLeaves()
addLeaf()
removeLeaf()
isLeaf()

No constants found

No protected methods found

N/A

No private methods found

N/A

File: Data/Types/Resource/LeafInterface.php
Package: \Data

Methods

getLeaves()

getLeaves() : array

Get a simple array of the connected leaf objects

Returns

array —

The leaf objects

addLeaf()

addLeaf(\Phabstractic\Data\Types\Resource\Phabstractic\Data\Types\Resource\LeafInterface  $leaf) : mixed

Add a leaf to this leaf, with optional LOCAL identifier

Parameters

\Phabstractic\Data\Types\Resource\Phabstractic\Data\Types\Resource\LeafInterface

$leaf

The leaf to add

Returns

mixed —

The new leaf identity

removeLeaf()

removeLeaf(\Phabstractic\Data\Types\Resource\Phabstractic\Data\Types\Resource\LeafInterface  $leaf)

Remove a leaf by its LOCAL identifier

Parameters

\Phabstractic\Data\Types\Resource\Phabstractic\Data\Types\Resource\LeafInterface

$leaf

isLeaf()

isLeaf(\Phabstractic\Data\Types\Resource\Phabstractic\Data\Types\Resource\LeafInterface  $leaf) : mixed

Does this leaf identifier exist in the local list?

Parameters

\Phabstractic\Data\Types\Resource\Phabstractic\Data\Types\Resource\LeafInterface

$leaf

Returns

mixed —

The leave's identity