LibRIS\RISReader Class Reference

The main class for parsing RIS files. More...

Collaboration diagram for LibRIS\RISReader:

Public Member Functions
	__construct ($options=array())
	parseFile ($filename, $context=NULL)
	Parse an RIS file. More...
	parseString ($string)
	Parse a string of RIS data. More...
	getRecords ()
	printRecords ()

Data Fields
const	RIS_EOL = "\r\n"
const	LINE_REGEX = '/^(([A-Z1-9]{2})\s+-(.*))|(.*)$/'

Protected Member Functions
	parseArray ($lines)
	Take an array of lines and parse them into an RIS record. More...
	cleanData (&$lines)
	Clean up the data before processing. More...

Protected Attributes
	$data = NULL

Detailed Description

The main class for parsing RIS files.

Usage:

<?php
 
use \LibRIS\RISReader;
 
$reader = new RISReader();
 
// Parse a file of RIS data.
$reader->parseFile('path/to/file.ris');
 
// Parse a string containing RIS data.
$reader->parseString($someRisString);
 
// Parse an array of lines.
$reader->parseArray($arrayOfRISDirectives);
 
// Get an associative array of records.
$array = $reader->getRecords();
 
// Dump the records to STDOUT
$reader->printRecords();
 
?>

The data structure generated by this class is of the form

<?php
array(
  [0] => array(
    'T1' => array('title one', 'title 2'),
    'TY' => array('JOUR'),
    // Other tags and their values.
  ),
  [1] => array(
    'T1' => array('another entry'),
    'TY' => array('JOUR'),
  ),
);
?>

Definition at line 60 of file RISReader.php.

Constructor & Destructor Documentation

__construct()

LibRIS\RISReader::__construct

(

$options = array()

)

Definition at line 67 of file RISReader.php.

                                                        {
        }

Member Function Documentation

cleanData()

LibRIS\RISReader::cleanData ( &  $lines )

protected

Clean up the data before processing.

Parameters

array

$lines

Indexed array of lines of data.

Definition at line 179 of file RISReader.php.

                                              {
                if (empty($lines)) {
                        return;
                }
                // Currently, we only need to strip a BOM if it exists.
                // Thanks to Derik Badman (http://madinkbeard.com/) for finding the
                // bug and suggesting this fix:
                // http://blog.philipp-michels.de/?p=32
                $first = $lines[0];
                if (substr($first, 0, 3) == pack('CCC', 0xef, 0xbb, 0xbf)) {
                        $lines[0] = substr($first, 3);
                }
        }

getRecords()

LibRIS\RISReader::getRecords

(

)

Definition at line 155 of file RISReader.php.

                                     {
                return $this->data;
        }

References $data.

parseArray()

LibRIS\RISReader::parseArray (   $lines )

protected

Take an array of lines and parse them into an RIS record.

Definition at line 119 of file RISReader.php.

                                              {
                $recordset = array();
                // Do any cleaning and normalizing.
                $this->cleanData($lines);
                $record = array();
                $lastTag = NULL;
                foreach ($lines as $line) {
                        $line = trim($line);
                        $matches = array();
                        preg_match(self::LINE_REGEX, $line, $matches);
                        if (! empty($matches[3])) {
                                $lastTag = $matches[2];
                                $record[$matches[2]][] = trim($matches[3]);
                        } // End record and prep a new one.
                        elseif (! empty($matches[2]) && $matches[2] == 'ER') {
                                $lastTag = NULL;
                                $recordset[] = $record;
                                $record = array();
                        } elseif (! empty($matches[4])) {
                                // Append to the last one.
                                // We skip leading info (like BOMs).
                                if (! empty($lastTag)) {
                                        $lastEntry = count($record[$lastTag]) - 1;
                                        // We trim because some encoders add tabs or multiple spaces.
                                        // Standard is silent on how this should be handled.
                                        $record[$lastTag][$lastEntry] .= ' ' . trim($matches[4]);
                                }
                        }
                }
                if (! empty($record)) {
                        $recordset[] = $record;
                }
                $this->data = $recordset;
        }

parseFile()

LibRIS\RISReader::parseFile	(		$filename,
			$context = NULL
	)

Parse an RIS file.

This will parse the file and return a data structure representing the record.

Parameters

string	$filename	The full path to the file to parse.
StreamContext	$context	The stream context (in desired) for handling the file.

Return values

array

An indexed array of individual sources, each of which is an associative array of entry details. (See LibRIS)

Definition at line 86 of file RISReader.php.

                                                              {
                if (! is_file($filename)) {
                        throw new ParseException(sprintf('File %s not found.', htmlentities($filename)));
                }
                $flags = FILE_SKIP_EMPTY_LINES | FILE_TEXT;
                $contents = file($filename, $flags, $context);
                $this->parseArray($contents);
        }

References $filename.

parseString()

LibRIS\RISReader::parseString

(

$string

)

Parse a string of RIS data.

This will parse an RIS record into a representative data structure.

Parameters

string	$string	RIS-formatted data in a string.
StreamContext	$context	The stream context (in desired) for handling the file.

Return values

array

An indexed array of individual sources, each of which is an associative array of entry details. (See LibRIS)

Definition at line 110 of file RISReader.php.

                                             {
                $contents = explode(RISReader::RIS_EOL, $string);
                $this->parseArray($contents);
        }

printRecords()

LibRIS\RISReader::printRecords

(

)

Definition at line 160 of file RISReader.php.

                                       {
                $format = "%s:\n\t%s\n";
                foreach ($this->data as $record) {
                        foreach ($record as $key => $values) {
                                foreach ($values as $value) {
                                        printf($format, RISTags::describeTag($key), $value);
                                }
                        }
                        print PHP_EOL;
                }
        }

References print.

Field Documentation

$data

LibRIS\RISReader::$data = NULL

protected

Definition at line 64 of file RISReader.php.

LINE_REGEX

const LibRIS\RISReader::LINE_REGEX = '/^(([A-Z1-9]{2})\s+-(.*))|(.*)$/'

Definition at line 63 of file RISReader.php.

RIS_EOL

const LibRIS\RISReader::RIS_EOL = "\r\n"

Definition at line 62 of file RISReader.php.

---

The documentation for this class was generated from the following file:

• Modules/Bibliographic/lib/LibRIS/src/LibRIS/RISReader.php