Summary:

Class PubdbBibTexImporter Class to import BibTex files to the database. For the parsing process of the BibTex format a external library is used.

Description:

The parsed data will be checked with the data in the database and new entries will be imported.

• No constants found

• private $parser
• private $listener
• private $latexMapping
• private $fieldMapping
• private $json_file

• public __construct()
• public startImport()
• private importLiterature()
• private insertLiterature()
• private checkRelationAuthor()
• private checkRelationEditor()
• private getPersonIDFromDB()
• private checkRelationType()
• private checkRelationPublisher()
• private getPublisherIDFromDB()
• private checkRelationJournal()
• private checkRelationSeries()
• private checkRelationKeywords()
• private formatAuthor()
• private updateState()
• private formatMonth()
• private formatIsbn()
• private removeBracketsFromString()
• private cleanUpString()

• File: administrator/helpers/PubdbBibTexImporter.php
• Package: Default
• Class Hierarchy:
  • \PubdbBibTexImporter

Type: \RenanBr\BibTexParser\Parser() BibTex Parser instance Details:

Type: \RenanBr\BibTexParser\Listener() BibTex Listener instance Details:

Type: array mapping table for umlauts Details:

Type: array mapping table for database and BibTex format Details:

Type: String json file path for latex mapping Details:

public __construct(  $file_string) 

Summary

PubdbBibTexImporter constructor.

Details:

• Inherited From: \PubdbBibTexImporter

public startImport() : array

Summary

Start the import process by calling the BibTex parser After parsing go through the elements list and remove unnecessary fields and format fields.

Details:

• Inherited From: \PubdbBibTexImporter

Returns: array

private importLiterature(  $literature_list) : array

Summary

Go though the literature list and format each.

Description

After chechking all relations call database insert function to insert the literature to the database. return an array of IDs of the imported literatures

Details:

• Inherited From: \PubdbBibTexImporter

Returns: array

private insertLiterature(  $literature) : mixed

Summary

Insert the given literature to the database after reformatting all fields.

Description

return the id of the literature

Details:

• Inherited From: \PubdbBibTexImporter

Returns: mixed

private checkRelationAuthor(  $params) : mixed|string

Summary

Check if authors already exist and return the the id.

Description

If not create new one and return the id of the new inserted author. Return multiple Ids as comma separated list when there are more then one author

Details:

• Inherited From: \PubdbBibTexImporter

Returns: mixed|string

private checkRelationEditor(  $params) : mixed|string

Summary

Check if person or editor already exist and return the the id.

Description

If not create new one and return the id of the new inserted person. Return multiple Ids as comma separated list when there are more then one author

Details:

• Inherited From: \PubdbBibTexImporter

Returns: mixed|string

private getPersonIDFromDB(  $first_name,   $last_name) : mixed

Summary

Query database to get author ids by first and last name create new one if none is found

Details:

• Inherited From: \PubdbBibTexImporter

Returns: mixed

private checkRelationType(  $params) : mixed|string

Summary

Check if literature typ exists and return id or misc id as fallback

Details:

• Inherited From: \PubdbBibTexImporter

Returns: mixed|string

private checkRelationPublisher(  $params) : mixed|string

Summary

Check if publisher already exists and return id of the exists or create new one and return the new id

Details:

• Inherited From: \PubdbBibTexImporter

Returns: mixed|string

private getPublisherIDFromDB(  $name) : integer

Summary

Check database for existing publisher or insert new one by name.

Description

In both cases return the id of the publisher.

Details:

• Inherited From: \PubdbBibTexImporter

Returns: integer - publisher id

private checkRelationJournal(  $params) : mixed|string

Summary

Check if journal already exists and return id of the exists or create new one and return the new id

Details:

• Inherited From: \PubdbBibTexImporter

Returns: mixed|string

private checkRelationSeries(  $params) : mixed|string

Summary

Check if series title already exists and return id of the exists or create new one and return the new id

Details:

• Inherited From: \PubdbBibTexImporter

Returns: mixed|string

private checkRelationKeywords(  $item) : mixed|string

Summary

Check if the keywords of the literature already exist.

Description

If not insert a new keyword into the database and return a list of IDs.

Details:

• Inherited From: \PubdbBibTexImporter

Returns: mixed|string

private formatAuthor(  $authors) : string

Summary

Reformat BibTex Author String, explode Author String by "and".

Description

Reformat Author names end remove escaping from BibTex format.

Details:

• Inherited From: \PubdbBibTexImporter

Returns: string

private updateState(  $table,   $id) : mixed

Summary

Update the State of an Element to 1 so it's published.

Description

Joomla! won't delete elements instead, they are changing states with this the unpublished state will be updated and the element ist active again

Details:

• Inherited From: \PubdbBibTexImporter

Returns: mixed

private formatMonth(  $month) : String

Summary

Format BibTex month String to numeric value jan => 1

Details:

• Inherited From: \PubdbBibTexImporter

Returns: String - formatted month string

private formatIsbn(  $isbn) : string|array<mixed,string>

Summary

Remove "-" from isbn to fit database format

Details:

• Inherited From: \PubdbBibTexImporter

Returns: string|array<mixed,string> - formatted string

private removeBracketsFromString(  $string) : string

Summary

remove BibTex standard formatting Brackets from String

Details:

• Inherited From: \PubdbBibTexImporter

Returns: string - formatted String

private cleanUpString(  $string) : string

Summary

clean up whitespaces and replace umlauts

Details:

• Inherited From: \PubdbBibTexImporter

Returns: string - formatted String

• \Composer
• \RenanBr

• Errors - 504
• Markers - 0
• Deprecated - 0

This document was automatically generated from source code comments on 2020-07-13 using phpDocumentor and fr3nch13/phpdoc-markdown