Docs For Class File

Description

The main File_MARC class enables you to return File_MARC_Record objects from a stream or string.

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>

Located in /MARC.php (line 64)

Class Constant Summary

DIRECTORY_ENTRY_LEN = 12

END_OF_FIELD = "\x1E"

END_OF_RECORD = "\x1D"

LEADER_LEN = 24

MAX_RECORD_LENGTH = 99999

SOURCE_FILE = 1

SOURCE_STRING = 2

SUBFIELD_INDICATOR = "\x1F"

Variable Summary

resource $source

int $type

Method Summary

File_MARC_Record next ()

string nextRaw ()

File_MARC __construct (int $source, [ $type = self::SOURCE_FILE], string $in)

Variables

resource $source (line 115)

Source containing raw records

access: protected

int $type (line 122)

Source type (SOURCE_FILE or SOURCE_STRING)

access: protected

Methods

next (line 240)

Return next File_MARC_Record object

Decodes the next raw MARC record and returns the File_MARC_Record object.

<?php
// Retrieve a set of MARC records from a file
$journals = new File_MARC('journals.mrc', SOURCE_FILE);
// Iterate through the retrieved records
while ($record = $journals->next()) {
print $record;
print "\n";
}
?>

return: next record, or false if there are no more records

File_MARC_Record next ()

nextRaw (line 179)

Return the next raw MARC record

Returns the next raw MARC record, unless all records already have been read.

return: Either a raw record or false

string nextRaw ()

Constructor __construct (line 146)

Read in MARC records

This function reads in MARC record files or strings that contain one or more MARC records.

<?php
// Retrieve MARC records from a file
$journals = new File_MARC('journals.mrc', SOURCE_FILE);
// Retrieve MARC records from a string (e.g. Z39 query results)
$monographs = new File_MARC($raw_marc, SOURCE_STRING);
?>

File_MARC __construct (int $source, [ $type = self::SOURCE_FILE], string $in)

string $in: Name of the file, or a raw MARC string
int $source: Source of the input, either SOURCE_FILE or SOURCE_STRING
$type

Class Constants

DIRECTORY_ENTRY_LEN = 12 (line 96)

Length of the Directory

END_OF_FIELD = "\x1E" (line 86)

Hexadecimal value for End of Field

END_OF_RECORD = "\x1D" (line 91)

Hexadecimal value for End of Record

LEADER_LEN = 24 (line 101)

Length of the Leader

MAX_RECORD_LENGTH = 99999 (line 106)

Maximum record length

SOURCE_FILE = 1 (line 71)

MARC records retrieved from a file

SOURCE_STRING = 2 (line 76)

MARC records retrieved from a binary string

SUBFIELD_INDICATOR = "\x1F" (line 81)

Hexadecimal value for Subfield indicator

Class File_MARC