Class Structure_Linked_List

Description

Implements interfaces:

  • Iterator (internal interface)

The Structure_Linked_List class represents a linked list structure composed of Structure_Linked_List_Node objects.

Located in /Structure_Linked_List.php (line 143)


	
			
Variable Summary
Method Summary
Structure_Linked_List __construct ([Structure_Linked_List_Node $marc = null])
bool addLink (Structure_Linked_List_Node $newLink, [int $mode = STRUCTURE_LINKED_LIST_ADD_APPEND], [Structure_Linked_List_Node $existingLink = null])
void deleteLink ({@link &$link)
PEAR_ErrorStack getErrors ()
Variables
Structure_Linked_List_Node $current (line 149)

Current node in the linked list

  • access: protected
Structure_Linked_List_Node $root_node (line 155)

Root node of the linked list

  • access: protected
PEAR::ErrorStack $stack (line 162)

Error stack

  • access: protected
Methods
Constructor __construct (line 172)

Structure_Linked_List constructor

Structure_Linked_List __construct ([Structure_Linked_List_Node $marc = null])
addLink (line 296)

Adds a @see Structure_Linked_List_Node object to the linked list.

While the @see Structure_Linked_List_Node constructor accepts a reference link as the previous link in the chain, you might want to create an extension of the @see Structure_Linked_List_Node object that enables you to first create and manipulate the object before adding it to the linked list.

  • return: Success or failure
  • access: public
bool addLink (Structure_Linked_List_Node $newLink, [int $mode = STRUCTURE_LINKED_LIST_ADD_APPEND], [Structure_Linked_List_Node $existingLink = null])
current (line 191)

Returns the current node in the linked list

  • return: current node in the linked list
  • access: public

Implementation of:
Iterator::current
deleteLink (line 366)
void deleteLink ({@link &$link)
  • {@link &$link: Structure_Linked_List_Node} $link
getErrors (line 275)

Get errors (if any) for this object

Returns the error stack.

  • return: returns the error stack
PEAR_ErrorStack getErrors ()
key (line 219)

Stub for Iterator interface that simply returns the current node

  • return: current node in the linked list
  • access: public

Implementation of:
Iterator::key
next (line 242)

Sets the pointer for the linked list to the next link and returns that link

  • return: next node in the linked list
  • access: public

Implementation of:
Iterator::next
previous (line 258)

Sets the pointer for the linked list to the previous link and returns that link

  • return: previous node in the linked list
  • access: public
rewind (line 202)

Sets the pointer for the linked list to the root node

  • return: root node in the linked list
  • access: public

Implementation of:
Iterator::rewind
valid (line 230)

Stub for Iterator interface that simply returns the current node

  • return: current node in the linked list
  • access: public

Implementation of:
Iterator::valid

Documentation generated on Thu, 24 Aug 2006 10:43:31 -0400 by phpDocumentor 1.3.0