PHPackages                             xianzhe18/bibtex-handler - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Parsing & Serialization](/categories/parsing)
4. /
5. xianzhe18/bibtex-handler

ActiveLibrary[Parsing & Serialization](/categories/parsing)

xianzhe18/bibtex-handler
========================

BibTex Parser provides an API to read .bib files programmatically (forked from renanbr/bibtex-parser)

2.0.8(6y ago)038MITPHPPHP >=5.6.0

Since Nov 29Pushed 6y agoCompare

[ Source](https://github.com/xianzhe18/bibtex-handler)[ Packagist](https://packagist.org/packages/xianzhe18/bibtex-handler)[ RSS](/packages/xianzhe18-bibtex-handler/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (5)Dependencies (2)Versions (23)Used By (0)

PHP BibTeX Handler 2.x
======================

[](#php-bibtex-handler-2x)

 This is forked from [renanbr/bibtex-parser](https://github.com/renanbr/bibtex-parser).

 This is a [BibTeX](https://www.ctan.org/pkg/bibtex) handler written in [PHP](https://php.net).

 [ ![BibTeX logo](https://camo.githubusercontent.com/345b12da4791809f6391e5343dd394b74c7f65a4c76d9cac816563b6859a6441/68747470733a2f2f75706c6f61642e77696b696d656469612e6f72672f77696b6970656469612f636f6d6d6f6e732f332f33302f4269625465585f6c6f676f2e737667) ](https://www.ctan.org/pkg/bibtex) [ ![PHP logo](https://camo.githubusercontent.com/4483bf574aa290f3a83765b3f21279c4478760d0074d01e3a2a79ac14ff4ac7e/68747470733a2f2f75706c6f61642e77696b696d656469612e6f72672f77696b6970656469612f636f6d6d6f6e732f322f32372f5048502d6c6f676f2e737667) ](https://php.net)

Table of contents
-----------------

[](#table-of-contents)

- [Installing](#installing)
- [Usage](#usage)
- [Vocabulary](#vocabulary)
- [Processors](#processors)
    - [Tag name case](#tag-name-case)
    - [Authors and editors](#authors-and-editors)
    - [Keywords](#keywords)
    - [LaTeX to unicode](#latex-to-unicode)
    - [Custom](#custom)
- [Convert entries back to bibTex](#convert-entries-back-to-bibtex)
- [Handling errors](#handling-errors)
- [Advanced usage](#advanced-usage)

Installing
----------

[](#installing)

```
composer require xianzhe18/bibtex-handler
```

Usage
-----

[](#usage)

```
use Xianzhe18\BibTexParser\Listener;
use Xianzhe18\BibTexParser\Parser;

require 'vendor/autoload.php';

$bibtex = export();  // Get processed data from the Listener

print_r($entries);
```

This will output:

```
Array
(
    [0] => Array
        (
            [type] => article
            [citation-key] => einstein1916relativity
            [title] => Relativity: The Special and General Theory
            [author] => Einstein, Albert
            [year] => 1916
        )
)

```

Vocabulary
----------

[](#vocabulary)

BibTeX is all about "entry", "tag's name" and "tag's content".

> A BibTeX **entry** consists of the type (the word after @), a citation-key and a number of tags which define various characteristics of the specific BibTeX entry. (...) A BibTeX **tag** is specified by its **name** followed by an equals-sign and the **content**.

Source:

Note: This library considers "type" and "citation-key" as tags. This behavior can be changed implementing your own Listener (more info at the end of this document).

Processors
----------

[](#processors)

`Processor` is a [callable](https://php.net/manual/en/language.types.callable.php) that receives an entry as argument and returns a modified entry.

This library contains three main parts:

- `Parser` class, responsible for detecting units inside a BibTeX input;
- `Listener` class, responsible for gathering units and transforming them into a list of entries;
- `Processor` classes, responsible for manipulating entries.

Despite you can't configure the `Parser`, you can append as many `Processor` as you want to the `Listener` through `Listener::addProcessor()` before exporting the contents. Be aware that `Listener` provides, by default, these features:

- Found entries are reachable through `Listener::export()` method;
- [Tag content concatenation](http://www.bibtex.org/Format/);
    - e.g. `hello # " world"` tag's content will generate `hello world` [string](https://php.net/manual/language.types.string.php)
- [Tag content abbreviation handling](http://www.bibtex.org/Format/);
    - e.g. `@string{foo="bar"} @misc{bar=foo}` will make `$entries[1]['bar']` assume `bar` as value
- Publication's type is exposed as `type` tag;
- Citation key is exposed as `citation-key` tag;
- Original entry text is exposed as `_original` tag.

This project is shipped with some useful processors.

### Tag name case

[](#tag-name-case)

In BibTeX the tag's names aren't case-sensitive. This library exposes entries as [array](https://php.net/manual/language.types.array.php), in which keys are case-sensitive. To avoid this misunderstanding, you can force the tags' name character case using `TagNameCaseProcessor`.

```
use Xianzhe18\BibTexParser\Processor\TagNameCaseProcessor;

$listener->addProcessor(new TagNameCaseProcessor(CASE_UPPER)); // or CASE_LOWER
```

```
@article{
  title={BibTeX rocks}
}
```

```
Array
(
    [0] => Array
        (
            [TYPE] => article
            [TITLE] => BibTeX rocks
        )
)

```

### Authors and editors

[](#authors-and-editors)

BibTeX recognizes four parts of an author's name: First Von Last Jr. If you would like to parse the `author` and `editor` tags included in your entries, you can use the `NamesProcessor` class.

```
use Xianzhe18\BibTexParser\Processor\NamesProcessor;

$listener->addProcessor(new NamesProcessor());
```

```
@article{
  title={Relativity: The Special and General Theory},
  author={Einstein, Albert}
}
```

```
Array
(
    [0] => Array
        (
            [type] => article
            [title] => Relativity: The Special and General Theory
            [author] => Array
                (
                    [0] => Array
                        (
                            [first] => Albert
                            [von] =>
                            [last] => Einstein
                            [jr] =>
                        )
                )
        )
)

```

### Keywords

[](#keywords)

The `keywords` tag contains a list of expressions represented as [string](https://php.net/manual/language.types.string.php), you might want to read them as an [array](https://php.net/manual/language.types.array.php) instead.

```
use Xianzhe18\BibTexParser\Processor\KeywordsProcessor;

$listener->addProcessor(new KeywordsProcessor());
```

```
@misc{
  title={The End of Theory: The Data Deluge Makes the Scientific Method Obsolete},
  keywords={big data, data deluge, scientific method}
}
```

```
Array
(
    [0] => Array
        (
            [type] => misc
            [title] => The End of Theory: The Data Deluge Makes the Scientific Method Obsolete
            [keywords] => Array
                (
                    [0] => big data
                    [1] => data deluge
                    [2] => scientific method
                )
        )
)

```

### LaTeX to unicode

[](#latex-to-unicode)

BibTeX files store LaTeX contents. You might want to read them as unicode instead. The `LatexToUnicodeProcessor` class solves this problem, but before adding the processor to the listener you must:

- [install Pandoc](http://pandoc.org/installing.html) in your system; and
- add [ryakad/pandoc-php](https://github.com/ryakad/pandoc-php) as a dependency of your project.

```
use Xianzhe18\BibTexParser\Processor\LatexToUnicodeProcessor;

$listener->addProcessor(new LatexToUnicodeProcessor());
```

```
@article{
  title={Caf\\'{e}s and bars}
}
```

```
Array
(
    [0] => Array
        (
            [type] => article
            [title] => Cafés and bars
        )
)

```

Note: Order matters, add this processor as the last.

### Custom

[](#custom)

The `Listener::addProcessor()` method expects a [callable](https://php.net/manual/en/language.types.callable.php) as argument. In the example shown below, we append the text `with laser` to the `title` tags for all entries.

```
$listener->addProcessor(function (array $entry) {
    $entry['title'] .= ' with laser';
    return $entry;
});
```

```
@article{
  title={BibTeX rocks}
}

```

```
Array
(
    [0] => Array
        (
            [type] => article
            [title] => BibTeX rocks with laser
        )
)

```

Convert entries back to bibTex
------------------------------

[](#convert-entries-back-to-bibtex)

This library can convert entries back to bibTex format.

```
$parser = new Parser();          // Create a Parser
$listener = new Listener();      // Create and configure a Listener

$listener->addProcessor(function (array $entry) { // Custom processor
    $entry['some-key'] = 'some-value';
    return $entry;
});

$parser->addListener($listener); // Attach the Listener to the Parser
$parser->parseString($bibtex);   // or parseFile('/path/to/file.bib')
$entries = $listener->export();  // Get processed data from the Listener

$newBibtex = $parser->convertIntoBibTex($entries);

echo $newBibtex;
```

```
Array
(
    [0] => Array
        (
            [type] => article
            [citation-key] => STEEL081011
            [author] => Steel
        )
)

```

```
$parser = new Parser();          // Create a Parser

$bibtex = $parser->convertIntoBibTex($entries);

echo $newBibtex;
```

```
@article{STEEL081011,
  author={Steel}
}

```

Handling errors
---------------

[](#handling-errors)

This library throws two types of exception: `ParserException` and `ProcessorException`. The first one may happen during the data extraction. When it occurs it probably means the parsed BibTeX isn't valid. The second exception may be throwed during the data processing. When it occurs it means the listener's processors can't handle properly the data found. Both implement `ExceptionInterface`.

```
use Xianzhe18\BibTexParser\Exception\ExceptionInterface;
use Xianzhe18\BibTexParser\Exception\ParserException;
use Xianzhe18\BibTexParser\Exception\ProcessorException;

try {
    // ... parser and listener configuration

    $parser->parseFile('/path/to/file.bib');
    $entries = $listener->export();
} catch (ParserException $exception) {
    // The BibTeX isn't valid
} catch (ProcessorException $exception) {
    // Listener's processors aren't able to handle data found
} catch (ExceptionInterface $exception) {
    // Alternatively, you can use this exception to catch all of them at once
}
```

Advanced usage
--------------

[](#advanced-usage)

The core of this library is constituted of these classes:

- `Xianzhe18\BibTexParser\Parser`: responsible for detecting units inside a BibTeX input;
- `Xianzhe18\BibTexParser\ListenerInterface`: responsible for treating units found.

You can attach listeners to the parser through `Parser::addListener()`. The parser is able to detect BibTeX units, such as "type", "tag's name", "tag's content". As the parser finds an unit, listeners are triggered.

You can code your own listener! All you have to do is handle units.

```
interface Xianzhe18\BibTexParser\ListenerInterface
{
    /**
     * Called when an unit is found.
     *
     * @param string $text    The original content of the unit found.
     *                        Escape character will not be sent.
     * @param string $type    The type of unit found.
     *                        It can assume one of Parser's constant value.
     * @param array  $context Contains details of the unit found.
     */
    public function bibTexUnitFound($text, $type, array $context);
}
```

`$type` may assume one of these values:

- `Parser::TYPE`
- `Parser::CITATION_KEY`
- `Parser::TAG_NAME`
- `Parser::RAW_TAG_CONTENT`
- `Parser::BRACED_TAG_CONTENT`
- `Parser::QUOTED_TAG_CONTENT`
- `Parser::ENTRY`

`$context` is an array with these keys:

- `offset` contains the `$text`'s beginning position. It may be useful, for example, to [seek on a file pointer](https://php.net/fseek);
- `length` contains the original `$text`'s length. It may differ from string length sent to the listener because may there are escaped characters.

###  Health Score

29

—

LowBetter than 60% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity7

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity68

Established project with proven stability

 Bus Factor1

Top contributor holds 87.6% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~51 days

Total

22

Last Release

2370d ago

Major Versions

0.6.0 → 1.0.02017-10-11

1.0.3 → 2.0.02017-11-25

1.0.4 → 2.0.12018-02-04

1.x-dev → 2.0.32019-04-03

### Community

Maintainers

![](https://www.gravatar.com/avatar/fdce04d4ff47a1ae84297e268b7764c1a727cfb0524f0a4c9e2395b8eb24e666?d=identicon)[xianzhe18](/maintainers/xianzhe18)

---

Top Contributors

[![renanbr](https://avatars.githubusercontent.com/u/350222?v=4)](https://github.com/renanbr "renanbr (191 commits)")[![xianzhe18](https://avatars.githubusercontent.com/u/40155069?v=4)](https://github.com/xianzhe18 "xianzhe18 (16 commits)")[![andrechalom](https://avatars.githubusercontent.com/u/1994997?v=4)](https://github.com/andrechalom "andrechalom (10 commits)")[![raphael-st](https://avatars.githubusercontent.com/u/21144687?v=4)](https://github.com/raphael-st "raphael-st (1 commits)")

---

Tags

parserBibliographylatexcitationbibtexcitebib

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/xianzhe18-bibtex-handler/health.svg)

```
[![Health](https://phpackages.com/badges/xianzhe18-bibtex-handler/health.svg)](https://phpackages.com/packages/xianzhe18-bibtex-handler)
```

###  Alternatives

[renanbr/bibtex-parser

BibTex Parser provides an API to read .bib files programmatically

39381.9k11](/packages/renanbr-bibtex-parser)[nikic/php-parser

A PHP parser written in PHP

17.4k902.6M1.8k](/packages/nikic-php-parser)[doctrine/lexer

PHP Doctrine Lexer parser library that can be used in Top-Down, Recursive Descent Parsers.

11.2k910.8M118](/packages/doctrine-lexer)[erusev/parsedown

Parser for Markdown.

15.0k151.8M725](/packages/erusev-parsedown)[league/commonmark

Highly-extensible PHP Markdown parser which fully supports the CommonMark spec and GitHub-Flavored Markdown (GFM)

2.9k404.0M698](/packages/league-commonmark)[masterminds/html5

An HTML5 parser and serializer.

1.8k242.8M226](/packages/masterminds-html5)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)