Inheritance diagram for ilBibTex:

Collaboration diagram for ilBibTex:

Public Member Functions
	parseContent ()
	should return More...

Public Member Functions inherited from ilBibliograficFileReaderBase
	getFileContent ()

	setFileContent ($file_content)

	getPathToFile ()

	setPathToFile ($path_to_file)

Public Member Functions inherited from ilBibliograficFileReader
	readContent ($path_to_file)

Static Public Member Functions
static	isStandardField ($field_name)

static	isEntryType ($entry_ype)

Protected Member Functions
	normalizeContent ()

	convertBibSpecialChars ()

	removeBomUtf8 ($s)

Protected Member Functions inherited from ilBibliograficFileReaderBase
	convertStringToUTF8 ($string)

Static Protected Attributes
static	$ignored_keywords = array( 'Preamble' )

static	$standard_fields

static	$entry_types

Additional Inherited Members
Data Fields inherited from ilBibliograficFileReaderBase
const	ENCODING_UTF_8 = 'UTF-8'

const	ENCODING_ASCII = 'ASCII'

const	ENCODING_ISO_8859_1 = 'ISO-8859-1'

Protected Attributes inherited from ilBibliograficFileReaderBase
	$file_content = ''

	$path_to_file = ''

Detailed Description

Class ilBibTex.

Author: Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Version: 1.0.0

Definition at line 9 of file class.ilBibTex.php.

Member Function Documentation

◆ convertBibSpecialChars()

ilBibTex::convertBibSpecialChars ( )

protected

Definition at line 118 of file class.ilBibTex.php.

References ilBibliograficFileReaderBase\getFileContent(), and ilBibliograficFileReaderBase\setFileContent().

Referenced by parseContent().

     {
         $bibtex_special_chars['ä'] = '{\"a}';
         $bibtex_special_chars['ë'] = '{\"e}';
         $bibtex_special_chars['ï'] = '{\"i}';
         $bibtex_special_chars['ö'] = '{\"o}';
         $bibtex_special_chars['ü'] = '{\"u}';
         $bibtex_special_chars['Ä'] = '{\"A}';
         $bibtex_special_chars['Ë'] = '{\"E}';
         $bibtex_special_chars['Ï'] = '{\"I}';
         $bibtex_special_chars['Ö'] = '{\"O}';
         $bibtex_special_chars['Ü'] = '{\"U}';
         $bibtex_special_chars['â'] = '{\^a}';
         $bibtex_special_chars['ê'] = '{\^e}';
         $bibtex_special_chars['î'] = '{\^i}';
         $bibtex_special_chars['ô'] = '{\^o}';
         $bibtex_special_chars['û'] = '{\^u}';
         $bibtex_special_chars['Â'] = '{\^A}';
         $bibtex_special_chars['Ê'] = '{\^E}';
         $bibtex_special_chars['Î'] = '{\^I}';
         $bibtex_special_chars['Ô'] = '{\^O}';
         $bibtex_special_chars['Û'] = '{\^U}';
         $bibtex_special_chars['à'] = '{\`a}';
         $bibtex_special_chars['è'] = '{\`e}';
         $bibtex_special_chars['ì'] = '{\`i}';
         $bibtex_special_chars['ò'] = '{\`o}';
         $bibtex_special_chars['ù'] = '{\`u}';
         $bibtex_special_chars['À'] = '{\`A}';
         $bibtex_special_chars['È'] = '{\`E}';
         $bibtex_special_chars['Ì'] = '{\`I}';
         $bibtex_special_chars['Ò'] = '{\`O}';
         $bibtex_special_chars['Ù'] = '{\`U}';
         $bibtex_special_chars['á'] = '{\\\'a}';
         $bibtex_special_chars['é'] = '{\\\'e}';
         $bibtex_special_chars['í'] = '{\\\'i}';
         $bibtex_special_chars['ó'] = '{\\\'o}';
         $bibtex_special_chars['ú'] = '{\\\'u}';
         $bibtex_special_chars['Á'] = '{\\\'A}';
         $bibtex_special_chars['É'] = '{\\\'E}';
         $bibtex_special_chars['Í'] = '{\\\'I}';
         $bibtex_special_chars['Ó'] = '{\\\'O}';
         $bibtex_special_chars['Ú'] = '{\\\'U}';
         $bibtex_special_chars['à'] = '{\`a}';
         $bibtex_special_chars['è'] = '{\`e}';
         $bibtex_special_chars['ì'] = '{\`i}';
         $bibtex_special_chars['ò'] = '{\`o}';
         $bibtex_special_chars['ù'] = '{\`u}';
         $bibtex_special_chars['À'] = '{\`A}';
         $bibtex_special_chars['È'] = '{\`E}';
         $bibtex_special_chars['Ì'] = '{\`I}';
         $bibtex_special_chars['Ò'] = '{\`O}';
         $bibtex_special_chars['Ù'] = '{\`U}';
         $bibtex_special_chars['ç'] = '{\c c}';
         $bibtex_special_chars['ß'] = '{\ss}';
         $bibtex_special_chars['ñ'] = '{\~n}';
         $bibtex_special_chars['Ñ'] = '{\~N}';
         $bibtex_special_chars['ń'] = "{\\'n}";
         $bibtex_special_chars['l'] = "{\\'n}";
         $bibtex_special_chars['&'] = "{\&}";
         $bibtex_special_chars['@'] = "{\@}";
 
         $this->setFileContent(str_replace(array_values($bibtex_special_chars), array_keys($bibtex_special_chars), $this->getFileContent()));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isEntryType()

static ilBibTex::isEntryType ( $entry_ype )

static

Parameters

$entry_ype

Returns: bool

Definition at line 251 of file class.ilBibTex.php.

     {
         return in_array($entry_ype, self::$entry_types);
     }

◆ isStandardField()

static ilBibTex::isStandardField ( $field_name )

static

Parameters

$field_name

Returns: bool

Definition at line 240 of file class.ilBibTex.php.

Referenced by ilBibliographicDetailsGUI\getInstance().

     {
         return in_array($field_name, self::$standard_fields);
     }

Here is the caller graph for this function:

◆ normalizeContent()

ilBibTex::normalizeContent ( )

protected

Definition at line 87 of file class.ilBibTex.php.

References $result, ilBibliograficFileReaderBase\getFileContent(), removeBomUtf8(), and ilBibliograficFileReaderBase\setFileContent().

Referenced by parseContent().

     {
         $result = $this->removeBomUtf8($this->getFileContent());
         // remove emty newlines
         $result = preg_replace("/^\n/um", "", $result);
         // Remove lines with only whitespaces
         $result = preg_replace("/^[\\s]*$/um", "\n", $result);
         $result = preg_replace("/\\n\\n\\n/um", "\n\n", $result);
 
         // remove comments
         $result = preg_replace("/^%.*\\n/um", "", $result);
 
         // Intend attributes with a tab
         $result = preg_replace("/^[ ]+/um", "\t", $result);
         $result = preg_replace("/^([\\w])/um", "\t$1", $result);
 
         // replace newline-braktes with brakets
         $result = preg_replace('/\\n}/uimx', '}', $result);
 
         // move last bracket on newline
         $result = preg_replace("/}[\\s]*$/um", "\n}", $result);
 
         // Support long lines (not working at the moment)
         //              $re = "/(\"[^\"\\n]*)\\r?\\n(?!(([^\"]*\"){2})*[^\"]*$)/";
         //              $subst = "$1";
         //              $result = preg_replace($re, $subst, $result);
 
         $this->setFileContent($result);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parseContent()

ilBibTex::parseContent ( )

should return

Array ( [0] => Array ( [isbn] => 978-0-12-411454-8 [year] => 2013 [title] => Mastering cloud computing [cite] => Masteringcloudcomputing:2013 [entryType] => book )

[...]

Returns: array

Implements ilBibliograficFileReader.

Definition at line 37 of file class.ilBibTex.php.

References $key, array, convertBibSpecialChars(), ilBibliograficFileReaderBase\getFileContent(), and normalizeContent().

     {
         $this->convertBibSpecialChars();
         $this->normalizeContent();
 
         // get entries
         $subject = $this->getFileContent();
         $objects = preg_split("/\\@([\\w]*)/uix", $subject, null, PREG_SPLIT_DELIM_CAPTURE
                                                                   | PREG_SPLIT_NO_EMPTY);
 
         if (in_array($objects[0], self::$ignored_keywords)) {
             $objects = array_splice($objects, 2);
         }
         // some files lead to a empty first entry in the array with the fist bib-entry, we have to trow them away...
         if (strlen($objects[0]) <= 3) {
             $objects = array_splice($objects, 1);
         }
 
         $entries = array();
         foreach ($objects as $key => $object) {
             if ((int) $key % 2 == 0 || (int) $key == 0) {
                 $entry = array();
                 $entry['entryType'] = strtolower($object);
             } else {
                 // Citation
                 preg_match("/^{(?<cite>.*),\\n/um", $object, $cite_matches);
                 if ($cite_matches['cite']) {
                     $entry['cite'] = $cite_matches['cite'];
                 }
 
                 // Edit at regex101.com: (?<attr>[\w]*)\s*=\s*[{"]*(?<content>(.*?))\s*[}"]*?\s*[,]*?\s*\n
                 $re = "/(?<attr>[\\w]*)\\s*=\\s*[{\"]*(?<content>(.*?))\\s*[}\"]*?\\s*[,]*?\\s*\\n/";
 
                 preg_match_all($re, $object, $matches, PREG_SET_ORDER);
 
                 foreach ($matches as $match) {
                     $clean = $match['content'];
                     $clean = preg_replace("/[\", \\t\\s]*\\n/u", "\n", $clean);
 
                     $entry[strtolower($match['attr'])] = $clean;
                 }
 
                 $entries[] = $entry;
             }
         }
 
         return $entries;
     }

Here is the call graph for this function:

◆ removeBomUtf8()

ilBibTex::removeBomUtf8 ( $s )

protected

Parameters

$s

Returns: bool|string

Definition at line 262 of file class.ilBibTex.php.

References $s.

Referenced by normalizeContent().

     {
         if (substr($s, 0, 3) == chr(hexdec('EF')) . chr(hexdec('BB')) . chr(hexdec('BF'))) {
             return substr($s, 3);
         } else {
             return $s;
         }
     }

Here is the caller graph for this function:

Field Documentation

◆ $entry_types

ilBibTex::$entry_types

staticprotected

Initial value:

= array(
        'article',
        'book',
        'booklet',
        'conference',
        'inbook',
        'incollection',
        'inproceedings',
        'manual',
        'mastersthesis',
        'misc',
        'phdthesis',
        'proceedings',
        'techreport',
        'unpublished',
    )

Definition at line 217 of file class.ilBibTex.php.

◆ $ignored_keywords

ilBibTex::$ignored_keywords = array( 'Preamble' )

staticprotected

Definition at line 15 of file class.ilBibTex.php.

◆ $standard_fields

ilBibTex::$standard_fields

staticprotected

Initial value:

= array(
        'address',
        'annote',
        'author',
        'booktitle',
        'chapter',
        'crossref',
        'edition',
        'editor',
        'eprint',
        'howpublished',
        'institution',
        'journal',
        'key',
        'month',
        'note',
        'number',
        'organization',
        'pages',
        'publisher',
        'school',
        'series',
        'title',
        'type',
        'url',
        'volume',
        'year',
    )

Definition at line 186 of file class.ilBibTex.php.

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

Modules/Bibliographic/classes/Types/BibTex/class.ilBibTex.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ convertBibSpecialChars()

◆ isEntryType()

◆ isStandardField()

◆ normalizeContent()

◆ parseContent()

◆ removeBomUtf8()

Field Documentation

◆ $entry_types

◆ $ignored_keywords

◆ $standard_fields