Class MARC_Control_Field

Description

The 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.php (line 1345)

MARC_Link
   |
   --MARC_Field
      |
      --MARC_Control_Field
Variable Summary
string $_data
Method Summary
string __construct (string $tag, string $data, [string $ind1 = null], [string $ind2 = null])
void __destruct ()
void delete ()
Field duplicate ()
string getData ()
bool isEmpty ()
bool setData (string $data)
string toRaw ()
string __toString ()
Variables
string $_data (line 1352)

Value of field, if field is a Control field

  • access: protected

Inherited Variables

Inherited from MARC_Field

MARC_Field::$_tag

Inherited from MARC_Link

MARC_Link::$_next
MARC_Link::$_previous
MARC_Link::$_stack
Methods
Constructor __construct (line 1367)

Field init function

Create a new MARC_Control_Field object from passed arguments

  • return: Returns warnings, if any, issued during parse
string __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:
MARC_Field::__construct()
MARC_Field constructor
Destructor __destruct (line 1379)

Destroys the control field

void __destruct ()

Redefinition of:
MARC_Field::__destruct()
Destroys the data field
delete (line 1389)

Destroys the control field

void delete ()
duplicate (line 1401)

Duplicate field

  • return: Duplicated field object
Field duplicate ()
getData (line 1413)

Get control field data

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

Is empty

Checks if the field contains data

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

Redefinition of:
MARC_Field::isEmpty()
Is empty
setData (line 1439)

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 1468)

Return as raw MARC

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

  • return: Raw MARC
string toRaw ()

Redefinition of:
MARC_Field::toRaw()
Return field in raw MARC format (stub)
__toString (line 1454)

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:
MARC_Field::__toString()
Return Field formatted

Inherited Methods

Inherited From MARC_Field

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

Inherited From MARC_Link

MARC_Link::__construct()
MARC_Link::getErrors()
MARC_Link::next()
MARC_Link::previous()
MARC_Link::setNext()
MARC_Link::setPrevious()
MARC_Link::__destruct()

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