Class: File_MARCXML

Source Location: /File_MARC-1.4.1/File/MARCXML.php

Class Overview

File_MARCBASE
   |
   --File_MARCXML

The main File_MARCXML class enables you to return File_MARC_Record objects from an XML stream or string.

Author(s):

Dan Scott <dscott at laurentian.ca>

Variables

Methods

Inherited Variables

Class: File_MARCBASE

File_MARCBASE::$record_class

Inherited Methods

Class: File_MARCBASE

File_MARCBASE::__construct(): Read in MARCXML records
File_MARCBASE::getXMLWriter(): Returns the XMLWriter object
File_MARCBASE::toXMLFooter(): Returns the MARCXML collection footer
File_MARCBASE::toXMLHeader(): Initializes the MARCXML output of a record or collection of records

Class Details

[line 63]
The main File_MARCXML class enables you to return File_MARC_Record objects from an XML stream or string.

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

[ Top ]

Class Variables

$counter =

[line 105]

Counter for MARCXML records in a collection

Access: protected

Type:

int

[ Top ]

$source =

[line 91]

Source containing raw records

Access: protected

Type:

resource

[ Top ]

$type =

[line 98]

Source type (SOURCE_FILE or SOURCE_STRING)

Access: protected

Type:

int

[ Top ]

$xmlwriter =

[line 112]

XMLWriter for writing collections

Access: protected

Type:	XMLWriter
Overrides:	Array

[ Top ]

Method Detail

__construct (Constructor) [line 144]

File_MARCXML __construct(
string|SimpleXMLElement
$source, [int
$type = self::SOURCE_FILE], [string
$ns = ""], [bool
$is_prefix = false], [string
$record_class = null])

Read in MARCXML records

This function reads in files, strings or SimpleXMLElement objects that contain one or more MARCXML 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);
 
 // Retrieve MARCXML records from a string with a namespace URL
 $records = new File_MARCXML($xml_data, File_MARC::SOURCE_STRING,"http://www.loc.gov/MARC21/slim");
 
 // Retrieve MARCXML records from a file with a namespace prefix
 $records = new File_MARCXML($xml_data, File_MARC::SOURCE_FILE,"marc",true);
 ?>

Overrides File_MARCBASE::__construct() (Read in MARCXML records)

Parameters:

string\|SimpleXMLElement	`$source`	—	Filename, raw MARC string or SimpleXMLElement object
int	`$type`	—	Source of the input, either SOURCE_FILE, SOURCE_STRING or SOURCE_SIMPLEXMLELEMENT
string	`$ns`	—	URI or prefix of the namespace
bool	`$is_prefix`	—	TRUE if $ns is a prefix, FALSE if it's a URI; defaults to FALSE
string	`$record_class`	—	Record class, defaults to File_MARC_Record

[ Top ]

next [line 205]

File_MARC_Record next(
)

Return next File_MARC_Record object

Decodes the next MARCXML record and returns the File_MARC_Record object.

 <?php

 // Retrieve a set of MARCXML records from a file
 $journals = new File_MARCXML('journals.xml', 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

[ Top ]