Docs For Class File_MARC

__construct (Constructor) [line 104]

true __construct(
[File_MARC
$marc = null])

Start function

Set all variables to defaults to create new File_MARC_Record object

Parameters:

File_MARC $marc — MARC record from File_MARC or File_MARCXML

[ Top ]

__destruct (Destructor) [line 120]

void __destruct(
)

Destroys the data field

[ Top ]

addWarning [line 416]

true addWarning(
string
$warning)

Add a warning to the MARC record that something non-fatal occurred during parsing.

Access: public

Parameters:

string $warning — warning message

[ Top ]

appendField [line 171]

File_MARC_Field appendField(
File_MARC_Field
$new_field)

Appends field to MARC record

Adds a File_MARC_Control_Field or File_MARC_Data_Field object to the end of the existing list of fields.

Return: The field that was added

Parameters:

File_MARC_Field $new_field — The field to add

[ Top ]

deleteFields [line 390]

int deleteFields(
string
$tag, [bool
$pcre = null])

Delete all occurrences of a field matching a tag name from the record.

Return: number of fields that were deleted

Parameters:

string	`$tag`	—	tag for the fields to be deleted
bool	`$pcre`	—	if true, then match as a regular expression

[ Top ]

getField [line 334]

{@link getField(
[string
$spec = null], [bool
$pcre = null])

Return the first File_MARC_Data_Field or File_MARC_Control_Field object that matches the specified tag name. Returns false if no match is found.

Return: File_MARC_Data_Field}|File_MARC_Control_Field first field that matches the requested tag name

Parameters:

string	`$spec`	—	tag name
bool	`$pcre`	—	if true, then match as a regular expression

[ Top ]

getFields [line 362]

File_MARC_List|array getFields(
[string
$spec = null], [bool
$pcre = null])

Return an array or File_MARC_List containing all File_MARC_Data_Field or File_MARC_Control_Field objects that match the specified tag name. If the tag name is omitted all fields are returned.

Return: File_MARC_Data_Field or File_MARC_Control_Field objects that match the requested tag name

Parameters:

string	`$spec`	—	tag name
bool	`$pcre`	—	if true, then match as a regular expression

[ Top ]

getLeader [line 136]

string getLeader(
)

Get MARC leader

Returns the leader for the MARC record. No validation on the specified leader is performed.

Return: returns the leader

[ Top ]

getWarnings [line 428]

array getWarnings(
)

Return the array of warnings from the MARC record.

Return: warning messages
Access: public

[ Top ]

insertField [line 229]

File_MARC_Field insertField(
File_MARC_Field
$new_field, File_MARC_Field
$existing_field, [bool
$before = false])

Inserts a field in the MARC record relative to an existing field

Inserts a File_MARC_Control_Field or File_MARC_Data_Field object before or after a specified existing field.

 // Example: Insert a new field before the first 650 field

 
 // Create the new field
 $subfields[] = new File_MARC_Subfield('a', 'Scott, Daniel.');
 $new_field = new File_MARC_Data_Field('100', $subfields, 0, null);
 
 // Retrieve the target field for our insertion point
 $subject = $record->getFields('650');
 
 // Insert the new field
 if (is_array($subject)) {
     $record->insertField($new_field, $subject[0], true);
 }
 elseif ($subject) {
     $record->insertField($new_field, $subject, true);
 }

Return: The field that was added

Parameters:

File_MARC_Field	`$new_field`	—	The field to add
File_MARC_Field	`$existing_field`	—	The target field
bool	`$before`	—	Insert the new field before the existing field if true, after the existing field if false

[ Top ]

prependField [line 190]

File_MARC_Field prependField(
File_MARC_Field
$new_field)

Prepends field to MARC record

Adds a File_MARC_Control_Field or File_MARC_Data_Field object to the start of to the existing list of fields.

Return: The field that was added

Parameters:

File_MARC_Field $new_field — The field to add

[ Top ]

setLeader [line 153]

string setLeader(
string
$leader)

Set MARC record leader

Sets the leader for the MARC record. No validation on the specified leader is performed.

Return: returns the leader

Parameters:

string $leader — Leader

[ Top ]

setLeaderLengths [line 299]

bool setLeaderLengths(
int
$record_length, int
$base_address)

Set MARC record leader lengths

Set the Leader lengths of the record according to defaults specified in http://www.loc.gov/marc/bibliographic/ecbdldrd.html

Return: Success or failure

Parameters:

int	`$record_length`	—	Record length
int	`$base_address`	—	Base address of data

[ Top ]

toJSON [line 508]

string toJSON(
)

Return the MARC record in JSON format

This method produces a JSON representation of a MARC record. The input encoding must be UTF8, otherwise the returned values will be corrupted.

Return: representation of MARC record in JSON format
Todo: Fix encoding input / output issues (PHP 6.0 required?)

[ Top ]

toJSONHash [line 559]

string toJSONHash(
)

Return the MARC record in Bill Dueber's MARC-HASH JSON format

This method produces a JSON representation of a MARC record as defined at http://robotlibrarian.billdueber.com/new-interest-in-marc-hash-json/ The input * encoding must be UTF8, otherwise the returned values will be corrupted.

Return: representation of MARC record in JSON format
Todo: Fix encoding input / output issues (PHP 6.0 required?)

[ Top ]

toRaw [line 460]

string toRaw(
)

Return the record in raw MARC format.

If you have modified an existing MARC record or created a new MARC record, use this method to save the record for use in other programs that accept the MARC format -- for example, your integrated library system.

 // Example: Modify a record and save the output to a file

 $record->deleteFields('650');
 
 // Now that the record has no subject fields, save it to disk
 fopen($file, '/home/dan/no_subject.mrc', 'w');
 fwrite($file, $record->toRaw());
 fclose($file);

Return: Raw MARC data

[ Top ]

toXML [line 616]

string toXML(
[string
$encoding = "UTF-8"], [bool
$indent = true], [bool
$single = true])

Return the MARC record in MARCXML format

This method produces an XML representation of a MARC record that attempts to adhere to the MARCXML standard documented at http://www.loc.gov/standards/marcxml/

Return: representation of MARC record in MARCXML format
Todo: Fix encoding input / output issues (PHP 6.0 required?)

Parameters:

string	`$encoding`	—	output encoding for the MARCXML record
bool	`$indent`	—	pretty-print the MARCXML record
bool	`$single`	—	wrap the <record> element in a <collection> element

[ Top ]

__toString [line 484]

string __toString(
)

Return the MARC record in a pretty printed string

This method produces an easy-to-read textual display of a MARC record.

The structure is roughly: <tag> <ind1> <ind2> _

Return: Formatted representation of MARC record

[ Top ]

Class: File_MARC_Record

Class Overview

Author(s):

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

Class Variables

$fields =

$leader =

$marc =

$marcxml =

$warnings =

Method Detail

__construct (Constructor) [line 104]

Parameters:

__destruct (Destructor) [line 120]

addWarning [line 416]

Parameters:

appendField [line 171]

Parameters:

deleteFields [line 390]

Parameters:

getField [line 334]

Parameters:

getFields [line 362]

Parameters:

getLeader [line 136]

getWarnings [line 428]

insertField [line 229]

Parameters:

prependField [line 190]

Parameters:

setLeader [line 153]

Parameters:

setLeaderLengths [line 299]

Parameters:

toJSON [line 508]

toJSONHash [line 559]

toRaw [line 460]

toXML [line 616]

Parameters:

__toString [line 484]