Class: File_MARC_Control_Field

Source Location: /File_MARC-1.4.1/File/MARC/Control_Field.php

Class Overview

SplDoublyLinkedList
   |
   --File_MARC_List
      |
      --File_MARC_Field
         |
         --File_MARC_Control_Field

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

Author(s):

Dan Scott <dscott at laurentian.ca>
Christoffer Landtman <landtman at realnode.com>

Variables

$data

Methods

Inherited Variables

Class: File_MARC_Field

File_MARC_Field::$tag

Class: File_MARC_List

File_MARC_List::$position

Inherited Methods

Class: File_MARC_Field

File_MARC_Field::__construct(): File_MARC_Field constructor
File_MARC_Field::formatField(): Pretty print a MARC_Field object without tags, indicators, etc.
File_MARC_Field::getTag(): Returns the tag for this File_MARC_Field object
File_MARC_Field::isControlField(): Is control field
File_MARC_Field::isDataField(): Is data field
File_MARC_Field::isEmpty(): Is empty
File_MARC_Field::setTag(): Sets the tag for this File_MARC_Field object
File_MARC_Field::toRaw(): Return field in raw MARC format (stub)
File_MARC_Field::__destruct(): Destroys the data field
File_MARC_Field::__toString(): Return Field formatted

Class: File_MARC_List

File_MARC_List::appendNode(): Adds a node onto the linked list.
File_MARC_List::deleteNode(): Deletes a node from the linked list.
File_MARC_List::getPosition(): Return position of the subfield
File_MARC_List::insertNode(): Inserts a node into the linked list, based on a reference node that already exists in the list.
File_MARC_List::key(): Returns the tag for a File_MARC_Field object, or the code for a File_MARC_Subfield object.
File_MARC_List::prependNode(): Adds a node to the start of the linked list.
File_MARC_List::setPosition(): Sets position of the subfield

Class: SplDoublyLinkedList (Internal Class)

add ( $index, $newval )
bottom ( )
count ( )
current ( )
getIteratorMode ( )
isEmpty ( )
key ( )
next ( )
offsetExists ( $index )
offsetGet ( $index )
offsetSet ( $index, $newval )
offsetUnset ( $index )
pop ( )
prev ( )
push ( $value )
rewind ( )
serialize ( )
setIteratorMode ( $flags )
shift ( )
top ( )
unserialize ( $serialized )
unshift ( $value )
valid ( )

Class Details

[line 53]
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.

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

[ Top ]

Class Variables

$data =

[line 61]

Value of field, if field is a Control field

Access: protected

Type:

string

[ Top ]

Method Detail

__construct (Constructor) [line 75]

File_MARC_Control_Field __construct(
string
$tag, string
$data, [string
$ind1 = null], [string
$ind2 = null])

Field init function

Create a new File_MARC_Control_Field object from passed arguments

Overrides File_MARC_Field::__construct() (File_MARC_Field constructor)

Parameters:

string	`$tag`	—	tag
string	`$data`	—	control field data
string	`$ind1`	—	placeholder for class strictness
string	`$ind2`	—	placeholder for class strictness

[ Top ]

__destruct (Destructor) [line 87]

void __destruct(
)

Destroys the control field

Overrides File_MARC_Field::__destruct() (Destroys the data field)

[ Top ]

delete [line 100]

true delete(
)

Destroys the control field

[ Top ]

getData [line 112]

string getData(
)

Get control field data

Return: returns data in control field

[ Top ]

isEmpty [line 126]

bool isEmpty(
)

Is empty

Checks if the field contains data

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

Overrides File_MARC_Field::isEmpty() (Is empty)

[ Top ]

setData [line 140]

bool setData(
string
$data)

Set control field data

Return: returns the new data in the control field

Parameters:

string $data — data for the control field

[ Top ]

toRaw [line 169]

string toRaw(
)

Return as raw MARC

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

Return: Raw MARC

Overrides File_MARC_Field::toRaw() (Return field in raw MARC format (stub))

[ Top ]

__toString [line 155]

string __toString(
)

Return as a formatted string

Return the control field as a formatted string for pretty printing

Return: Formatted output of control Field

Overrides File_MARC_Field::__toString() (Return Field formatted)

[ Top ]