ilRisReader Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilRisReader:

Public Member Functions
	__construct ($options=[])
	parseString (string $string)
	Parse a string of RIS data. More...
	getRecords ()

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

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

Protected Attributes
array	$data = []

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning This class has been adapted from the original RISReader class in the abandoned technosophos/LibRIS library. Many thanks to technosophos for the original work!

See also

https://github.com/technosophos/LibRIS/blob/master/src/LibRIS/RISReader.php

Definition at line 24 of file class.ilRisReader.php.

Constructor & Destructor Documentation

__construct()

ilRisReader::__construct

(

$options = []

)

Definition at line 31 of file class.ilRisReader.php.

    {
    }

Member Function Documentation

cleanData()

ilRisReader::cleanData ( array &  $lines )

protected

Clean up the data before processing.

Parameters

array

$lines

Indexed array of lines of data.

Definition at line 108 of file class.ilRisReader.php.

Referenced by parseArray().

                                               : void
    {
        if ($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((string) $first, 0, 3) === pack('CCC', 0xef, 0xbb, 0xbf)) {
            $lines[0] = substr((string) $first, 3);
        }
    }

Here is the caller graph for this function:

getRecords()

ilRisReader::getRecords

(

)

Definition at line 97 of file class.ilRisReader.php.

References $data.

                                : array
    {
        return $this->data;
    }

parseArray()

ilRisReader::parseArray ( array  $lines )

protected

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

Definition at line 57 of file class.ilRisReader.php.

References cleanData().

Referenced by parseString().

                                               : void
    {
        $recordset = [];

        // Do any cleaning and normalizing.
        $this->cleanData($lines);

        $record = [];
        $lastTag = null;
        foreach ($lines as $line) {
            $line = trim((string) $line);
            $matches = [];

            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 = [];
            } 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 ($record !== []) {
            $recordset[] = $record;
        }

        $this->data = $recordset;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

parseString()

ilRisReader::parseString

(

string

$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 48 of file class.ilRisReader.php.

References parseArray().

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

Here is the call graph for this function:

Field Documentation

$data

array ilRisReader::$data = []

protected

Definition at line 29 of file class.ilRisReader.php.

Referenced by getRecords().

LINE_REGEX

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

Definition at line 27 of file class.ilRisReader.php.

RIS_EOL

const ilRisReader::RIS_EOL = "\r\n"

Definition at line 26 of file class.ilRisReader.php.

Referenced by ilBiblRisFileReaderWrapper\parseContent().

---

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

• components/ILIAS/Bibliographic/classes/FileReader/Ris/class.ilRisReader.php