\Phabstractic\Data\Types\ResourceLinkedListElementInterface

The basic LinkedListInterface

This allows for an array like structure that can be broken up into parts and rearranged as it uses links to its neighboring objects, which can be edited.

CHANGELOG

1.0: Created LinkedListInterface - May 26th, 2013 2.0: Integrated with Primus - August 26th, 2015 3.0: renamed methods to use element instead of item reformatted for inclusion in phabstractic - July 25th, 2016

Summary

Methods

Constants

getNextElement()
getPreviousElement()
setNextElement()
setPreviousElement()
nullNextElement()
nullPreviousElement()

No constants found

No protected methods found

N/A

No private methods found

N/A

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

Methods

getNextElement()

getNextElement() : \Phabstractic\Data\Types\Resource\reference

Retrieve the next item in the list

If null, at end of list

Returns

\Phabstractic\Data\Types\Resource\reference —

The next item in the list

getPreviousElement()

getPreviousElement() : \Phabstractic\Data\Types\Resource\reference

Retrieve the previous item in the list

If null, at beginning of list

Returns

\Phabstractic\Data\Types\Resource\reference —

The previous item in the list

setNextElement()

setNextElement(\Phabstractic\Data\Types\Resource\reference  $next)

Set the next item in the list for this object

Parameters

\Phabstractic\Data\Types\Resource\reference

$next

The next item

setPreviousElement()

setPreviousElement(\Phabstractic\Data\Types\Resource\reference  $prev)

Set the previous item in the list for this object

Parameters

\Phabstractic\Data\Types\Resource\reference

$prev

The given previous item

nullNextElement()

nullNextElement()

Null out the next item in the list for this object

NOTE: (can't pass null as reference)

nullPreviousElement()

nullPreviousElement()

Null out the previous item in the list for this object

NOTE: (can't pass null as reference)