v3 Roadmap

[renanbr]

Goals

• make the code source more modern
• improve code source readability
• improve documentation

Topics

• Entry: entries as object Entry instead of array
  • an immutable object
  • do not mix up tags with non-tag stuff, it means provide these methods in Entry class:
    • getCitationKey(): string
    • getType(): string
    • getOriginal(): string
    • getTag(string $name): Stringable (PHP 8.0)
      • processors may return a "stringable" ArrayIterator for lists (e.g. keywords, author)
• ProcessorInterface: create a ProcessorInterface
  • type-hint processor's argument and return as Entry (PHP 7.0)
• Default Listener: instantiate a default Listener in Parser
  • provide a way to clear listeners in Parser
• Abbreviation leak: don't leak abbreviation among files (bug in v2?)
  • trigger Listeners when Parser reaches the end of a file (or string input)
• Interfaces namespace: place interfaces under an unified namespace
• Static analysis: stricter static analysis check
• Documentation: more examples in documentation
  • how to integrate this library with the most popular frameworks

[renanbr]

Topic Entry and ProcessorInterface:

We could provide a Processor that transforms an array into a Entry.

As a consequence, the user that wants to type-hint its processors with Entry can do this as well. (no interface in this case)

[renanbr]

Topic Default Listener

We could provide a static method anywhere as a factory, or even a ParserBuilder.

[renanbr]

Topic Refactor

Extract lexer from this project.