Class MARC_Linked_List

Description

Implements interfaces:

  • Iterator (internal interface)

The MARC_Linked_List class represents a linked list structure composed of MARC_Link objects.

Located in /MARC.php (line 1668)


	
			
Variable Summary
Method Summary
MARC_Linked_List __construct ([MARC_Link $marc = null])
bool addLink (MARC_Link $newLink, [int $mode = MARC_LINK_ADD_APPEND], [ &$existingLink = null], MARC_Link $existingLink)
void deleteLink (mixed $subfield)
PEAR_ErrorStack getErrors ()
Variables
MARC_Link $_current (line 1674)

Current node in the linked list

  • access: protected
MARC_Link $_root_node (line 1680)

Root node of the linked list

  • access: protected
PEAR::ErrorStack $_stack (line 1687)

Error stack

  • access: protected
Methods
Constructor __construct (line 1697)

MARC_Linked_List constructor

MARC_Linked_List __construct ([MARC_Link $marc = null])
  • MARC_Link $marc: root node for the linked list
addLink (line 1810)

Adds a @see MARC_Link object to the linked list.

While the @see MARC_Link constructor accepts a reference link as the previous link in the chain, you might want to create an extension of the @see MARC_Link 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 (MARC_Link $newLink, [int $mode = MARC_LINK_ADD_APPEND], [ &$existingLink = null], MARC_Link $existingLink)
  • MARC_Link $newLink: New link to add to the list
  • int $mode: Specifies how the link will be inserted
  • MARC_Link $existingLink: Reference link: if null, then use the final link in the list
  • &$existingLink
current (line 1710)

Returns the current node in the linked list

  • return: current node in the linked list
  • access: public
MARC_Link current ()

Implementation of:
Iterator::current
deleteLink (line 1880)
void deleteLink (mixed $subfield)
getErrors (line 1789)

Get errors (if any) for this object

Returns the error stack.

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

Stub for Iterator interface that simply returns the current node

  • return: current node in the linked list
  • access: public
MARC_Link key ()

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

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

  • return: next node in the linked list
  • access: public
MARC_Link next ()

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

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

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

Sets the pointer for the linked list to the root node

  • return: root node in the linked list
  • access: public
MARC_Link rewind ()

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

Stub for Iterator interface that simply returns the current node

  • return: current node in the linked list
  • access: public
MARC_Link valid ()

Implementation of:
Iterator::valid

Documentation generated on Mon, 14 Aug 2006 18:59:29 -0400 by phpDocumentor 1.3.0RC6