Docs For Class File_MARC

Description

The File_MARC_Field class is expected to be extended to reflect the requirements of control and data fields.

Every MARC field contains a tag name.

link: http://pear.php.net/package/File_MARC
license: LGPL License 2.1
author: Christoffer Landtman <landtman@realnode.com>
author: Dan Scott <dscott@laurentian.ca>

Structures_LinkedList_DoubleNode
   |
   --File_MARC_Field

Direct descendents

Class	Description
File_MARC_Control_Field	The File_MARC_Control_Field class represents a single control field in a MARC record.
File_MARC_Data_Field	The File_MARC_Data_Field class represents a single field in a MARC record.

Variable Summary

string $tag

Method Summary

File_MARC_Field __construct (string $tag, [string $subfields = null], [string $ind1 = null], [string $ind2 = null])

void __destruct ()

string getTag ()

bool isEmpty ()

string setTag (string $tag)

bool toRaw ()

string __toString ()

Variables

string $tag (line 59)

The tag name of the Field

access: protected

Methods

Constructor __construct (line 74)

File_MARC_Field constructor

Create a new File_MARC_Field object from passed arguments. We define placeholders for the arguments required by child classes.

File_MARC_Field __construct (string $tag, [string $subfields = null], [string $ind1 = null], [string $ind2 = null])

string $tag: tag
string $subfields: placeholder for subfields or control data
string $ind1: placeholder for first indicator
string $ind2: placeholder for second indicator

Redefined in descendants as:

File_MARC_Control_Field::__construct() : Field init function
File_MARC_Data_Field::__construct() : File_MARC_Data_Field constructor

Destructor __destruct (line 91)

Destroys the data field

void __destruct ()

Redefined in descendants as:

File_MARC_Control_Field::__destruct() : Destroys the control field
File_MARC_Data_Field::__destruct() : Destroys the data field

getTag (line 104)

Returns the tag for this File_MARC_Field object

return: returns the tag number of the field

string getTag ()

isEmpty (line 132)

Is empty

Checks if the field is empty.

return: Returns true if the field is empty, otherwise false

bool isEmpty ()

Redefined in descendants as:

File_MARC_Control_Field::isEmpty() : Is empty
File_MARC_Data_Field::isEmpty() : Checks if the field is empty.

setTag (line 117)

Sets the tag for this File_MARC_Field object

return: returns the tag number of the field

string setTag (string $tag)

string $tag: new value for the tag

toRaw (line 169)

Return field in raw MARC format (stub)

Return the field formatted in raw MARC for saving into MARC files. This stub method is extended by the child classes.

return: Raw MARC

bool toRaw ()

Redefined in descendants as:

File_MARC_Control_Field::toRaw() : Return as raw MARC
File_MARC_Data_Field::toRaw() : Return Field in Raw MARC

__toString (line 154)

Return Field formatted

Return Field as a formatted string.

return: Formatted output of Field

string __toString ()

Redefined in descendants as:

File_MARC_Control_Field::__toString() : Return as a formatted string
File_MARC_Data_Field::__toString() : Return Field formatted

Class File_MARC_Field