Class File_MARC_Control_Field

Description

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

A MARC control field consists of a tag name and control data.

Located in /MARC/Control_Field.php (line 52)

Structures_LinkedList_DoubleNode
   |
   --File_MARC_Field
      |
      --File_MARC_Control_Field
Variable Summary
string $data
Method Summary
File_MARC_Control_Field __construct (string $tag, string $data, [string $ind1 = null], [string $ind2 = null])
void __destruct ()
void delete ()
string getData ()
bool isEmpty ()
bool setData (string $data)
string toRaw ()
string __toString ()
Variables
string $data (line 59)

Value of field, if field is a Control field

  • access: protected

Inherited Variables

Inherited from File_MARC_Field

File_MARC_Field::$tag
Methods
Constructor __construct (line 73)

Field init function

Create a new File_MARC_Control_Field object from passed arguments

File_MARC_Control_Field __construct (string $tag, string $data, [string $ind1 = null], [string $ind2 = null])
  • string $tag: tag
  • string $data: control field data
  • string $ind1: placeholder for class strictness
  • string $ind2: placeholder for class strictness

Redefinition of:
File_MARC_Field::__construct()
File_MARC_Field constructor
Destructor __destruct (line 85)

Destroys the control field

void __destruct ()

Redefinition of:
File_MARC_Field::__destruct()
Destroys the data field
delete (line 96)

Destroys the control field

void delete ()
getData (line 108)

Get control field data

  • return: returns data in control field
string getData ()
isEmpty (line 121)

Is empty

Checks if the field contains data

  • return: Returns true if the field is empty, otherwise false
bool isEmpty ()

Redefinition of:
File_MARC_Field::isEmpty()
Is empty
setData (line 134)

Set control field data

  • return: returns the new data in the control field
bool setData (string $data)
  • string $data: data for the control field
toRaw (line 163)

Return as raw MARC

Return the control field formatted in Raw MARC for saving into MARC files

  • return: Raw MARC
string toRaw ()

Redefinition of:
File_MARC_Field::toRaw()
Return field in raw MARC format (stub)
__toString (line 149)

Return as a formatted string

Return the control field as a formatted string for pretty printing

  • return: Formatted output of control Field
string __toString ()

Redefinition of:
File_MARC_Field::__toString()
Return Field formatted

Inherited Methods

Inherited From File_MARC_Field

File_MARC_Field::__construct()
File_MARC_Field::getTag()
File_MARC_Field::isEmpty()
File_MARC_Field::setTag()
File_MARC_Field::toRaw()
File_MARC_Field::__destruct()
File_MARC_Field::__toString()

Documentation generated on Mon, 01 Jan 2007 23:44:40 -0500 by phpDocumentor 1.3.1