PubdbBibTexExporter - JoomlaPubDB/PubDB GitHub Wiki
Summary:
Class PubdbBibTexExporter Class to export literature in BibTeX formatting for download.
Description:
Use the publication_list database View as base for all the data. Export every entry in the table or only the literature with the given id.
- No constants found
- private $ids
- private $latexMapping
- private $json_file
- private $defaultFields
- private $articleFields
- private $bookFields
- private $bookletFields
- private $inbookFields
- private $incollectionFields
- private $inproceedingsFields
- private $manualFields
- private $masterthesisFields
- private $miscFields
- private $phdFields
- private $proceedingsFields
- private $techreportFields
- public __construct()
- public startExport()
- private getItems()
- private formatItems()
- private buildBibTexOutput()
- private getCiteKey()
- private formatAuthors()
- private formatOthers_involved()
- private formatMonth()
- private formatKeywords()
- private formatBibTexString()
- File: administrator/helpers/PubdbBibTexExporter.php
- Package: Com_Pubdb
- Class Hierarchy:
- \PubdbBibTexExporter
Tag | Version | Description |
---|---|---|
since | v0.0.5 |
Type: array array with literature ids to export Details:
Tag | Version | Description |
---|---|---|
since | v0.0.7 |
Type: array mapping table for umlauts Details:
Tag | Version | Description |
---|---|---|
since | v0.0.7 |
Type: String json file path for latex mapping Details:
Tag | Version | Description |
---|---|---|
since | v0.0.7 |
Type: mixed Array to map database fields to BibTex fields Details:
Tag | Version | Description |
---|---|---|
since | v0.0.7 |
Type: array mapping for article ref types journal, publisher, address, subtitle Details:
Tag | Version | Description |
---|---|---|
since | v0.0.7 |
Type: array mapping for book ref types publisher, address, subtitle Details:
Tag | Version | Description |
---|---|---|
since | v0.0.7 |
Type: array mapping for booklet ref types howpublished, address, subtitle Details:
Tag | Version | Description |
---|---|---|
since | v0.0.7 |
Type: array mapping for inbook ref type publisher, address, subtitle Details:
Tag | Version | Description |
---|---|---|
since | v0.0.7 |
Type: array mapping for incollection ref type editor, publisher, address, title Details:
Tag | Version | Description |
---|---|---|
since | v0.0.7 |
Type: array mapping for inproceedings ref type, editor, publisher, address, title, series Details:
Tag | Version | Description |
---|---|---|
since | v0.0.7 |
Type: array mapping for manual ref type address organization Details:
Tag | Version | Description |
---|---|---|
since | v0.0.7 |
Type: array mapping for masterthesis ref type school, address Details:
Tag | Version | Description |
---|---|---|
since | v0.0.7 |
Type: array mapping for misc ref type howpublished, note Details:
Tag | Version | Description |
---|---|---|
since | v0.0.7 |
Type: array mapping for phd ref type school, address Details:
Tag | Version | Description |
---|---|---|
since | v0.0.7 |
Type: array mapping for proceedings ref type editor, publisher, address, series Details:
Tag | Version | Description |
---|---|---|
since | v0.0.7 |
Type: array mapping for techreport ref type editor, institution, address, series Details:
Tag | Version | Description |
---|---|---|
since | v0.0.7 |
public __construct( $ids)
Summary
PubdbBibTexExporter constructor.
Details:
- Inherited From: \PubdbBibTexExporter
Type | Name | Description |
---|---|---|
|
$ids | mixed Ids to export |
Tag | Version | Description |
---|---|---|
since | v0.0.7 |
public startExport() : string
Summary
Public entry point to trigger export, call database function to get all items and build export
Details:
- Inherited From: \PubdbBibTexExporter
Returns: string - formatted BibTeX String
Tag | Version | Description |
---|---|---|
since | v0.0.5 |
private getItems() : mixed
Summary
Query database to get all records of stored literature and if id filter exists use only these
Details:
- Inherited From: \PubdbBibTexExporter
Returns: mixed
Tag | Version | Description |
---|---|---|
since | v0.0.5 |
private formatItems( $items) : array
Summary
Loop through all Items and map all values to corresponding bibtex fields If an extra formatting function exists use it in addition
Details:
- Inherited From: \PubdbBibTexExporter
Type | Name | Description |
---|---|---|
|
$items | Array with all Items |
Returns: array - Array with formatted Items
Tag | Version | Description |
---|---|---|
since | v0.0.5 |
private buildBibTexOutput( $items) : string
Summary
Build BibTeX Literature Blocks from given items and generate random citekey for identification and remove empty fields
Details:
- Inherited From: \PubdbBibTexExporter
Type | Name | Description |
---|---|---|
|
$items | Array with all items |
Returns: string - formatted BibTex String
Tag | Version | Description |
---|---|---|
since | v0.0.5 |
private getCiteKey( $item) : string
Summary
generate unique citekey for corresponding literature with it's author, year and random number
Details:
- Inherited From: \PubdbBibTexExporter
Type | Name | Description |
---|---|---|
|
$item | literature item |
Returns: string - citekey
Tag | Version | Description |
---|---|---|
since | v0.0.5 |
private formatAuthors( $item) : string
Summary
Format Authors of an Literature with last and first name In addition connect them with an "and" to get BibTeX format
Details:
- Inherited From: \PubdbBibTexExporter
Type | Name | Description |
---|---|---|
|
$item |
Returns: string
Tag | Version | Description |
---|---|---|
since | v0.0.5 |
private formatOthers_involved( $item) : string
Summary
Format Authors of an Literature with last and first name In addition connect them with an "and" to get BibTeX format
Details:
- Inherited From: \PubdbBibTexExporter
Type | Name | Description |
---|---|---|
|
$item |
Returns: string
Tag | Version | Description |
---|---|---|
since | v0.0.5 |
private formatMonth( $item) : String
Summary
Replace numeric month value with BibTex String
Details:
- Inherited From: \PubdbBibTexExporter
Type | Name | Description |
---|---|---|
|
$item | stdClass Item Object to Fromat |
Returns: String - month String in BibTex format
Tag | Version | Description |
---|---|---|
since | v0.0.7 |
private formatKeywords( $item) : String
Summary
Format the in joomla! saved comma separated list of keywords to an semicolon separated list
Details:
- Inherited From: \PubdbBibTexExporter
Type | Name | Description |
---|---|---|
|
$item | mixed Item to format |
Returns: String - keyword string with semicolon
Tag | Version | Description |
---|---|---|
since | v0.0.7 |
private formatBibTexString( $value, boolean $dq = false) : string&#124;array<mixed,string>
Summary
Format strings to get ensure BibTex format.
Description
Add Brackets, replace special chars with escaping etc
Details:
- Inherited From: \PubdbBibTexExporter
Type | Name | Description |
---|---|---|
|
$value | |
boolean |
$dq | flag if double quotes should be ignored |
Returns: string|array<mixed,string>
Tag | Version | Description |
---|---|---|
since | v0.0.5 |
This document was automatically generated from source code comments on 2020-07-13 using phpDocumentor and fr3nch13/phpdoc-markdown