Home / PHP / Miscellaneous

Annotations Docblock Parser

Doctrine Annotations Docblock Annotations Parser library (extracted from Doctrine Common). Documentation See the doctrine-project website. Contributin
Information
Category: PHP / Miscellaneous
Watchers: 39
Star: 6.3k
Fork: 220
Last update: Nov 2, 2021
Resource links
https://www.doctrine-project.org/projects/annotations.html
https://github.com/doctrine/annotations

Doctrine Annotations

Build Status Dependency Status Reference Status Total Downloads Latest Stable Version

Docblock Annotations Parser library (extracted from Doctrine Common).

Documentation

See the doctrine-project website.

Contributing

When making a pull request, make sure your changes follow the Coding Standard Guidelines.

38 Open More issues
Closed

Annotations 2.0

  • Move namespace to Doctrine\Annotations (Removing Common)
  • Uses hoa/compiler instead of doctrine/lexer ( see : grammar )
  • Drop AnnotationRegistry and all autoload magic
  • Drop Attribute/Attributes annotations
  • Drop SimpleAnnotationReader
  • Drop FileCacheReader
  • Drop IndexedReader
  • Requires php 7

TODO:

Local reviews (checkout + run locally):

  • [ ] @guilhermeblanco
  • [ ] @beberlei
  • [ ] @Hywan
  • [ ] @ocramius
  • [ ] @asm89
  • [ ] @deeky666
  • [ ] @alcaeus
  • [ ] run it against the doctrine/doctrine2 test-suite
  • [ ] run it against the doctrine/mongodb-odm test-suite
opened Mar 20, 2016 by FabioBatSilva 31
Closed

Introduced annotation NamedArgumentConstructor

Fixes #379

This PR enables annotations to provide a constructor to be called with named arguments without requiring to implement a marker interface.

New Feature 
opened Jan 1, 2021 by derrabus 22
Closed

PHP7 Grouped Use Statements ignored

When I use the new PHP7 grouped use statements feature, Doctrine doesn't use the namespace to import the annotation.

For example, this works:

use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Method;

class MyController
{

    /**
     * @Route("/example")
     * @Method("GET")
     */     
    public function exampleAction() {...}

}

But changing the namespaces to this fails:

use Sensio\Bundle\FrameworkExtraBundle\Configuration\{
    Route, Method
}

I'm using Doctrine Annotations 1.2.7

enhancement 
opened Apr 7, 2016 by blowski 20
Closed

allow for dangling comma

Drupal developers are much to used to the PHP array syntax which allows a dangling comma:

array(
  'foo' => 'bar',
);

Doctrine doesn't allow for this and this causes a lot of grief. This PR fixes this. It seems {} arrays already support this.

opened Sep 10, 2013 by chx 20
Closed

Trying to access array offset on value of type null

This stopped working on php 7.4, for example on DocParser class See https://twitter.com/nikita_ppv/status/1148931277216800769 for a reference

bug 
opened Jul 12, 2019 by garak 19
Closed

Annotation parameters

Don't know if I do not understand correctly how annotation parameters work, but given the following annotation definition:

/**
 * Class Parameter
 *
 * @Annotation
 * @Target("METHOD")
 */
class Parameter
{
    /**
     * @var string
     */
    public $name;

    /**
     * @var array<Symfony\Component\Validator\Constraint>
     */
    public $constraints = array();

    /**
     * @var string
     */
    public $validationGroup;

    /**
     * @param array $data
     */
    public function __construct(array $data)
    {
        // constructor logic
    }
}

Why doesn't the following work:

@Direct\Parameter("a", { @Assert\NotNull() }, "myGroup")

I'm getting a Expected Value, got 'myGroup' at position 70 in method... exception.

This however works:

@Direct\Parameter("a", { @Assert\NotNull() }, validationGroup="myGroup")

as does this:

@Direct\Parameter(name="a", constraints={ @Assert\NotNull() }, validationGroup="myGroup")

and this:

@Direct\Parameter("a", { @Assert\NotNull() })
bug 
opened Dec 17, 2015 by sgehrig 17
Open

Catch and process errors that occure during annotation instantiation

When an annotation class is instantiated and values are passed to the constructor, TypeErrors and ArgumentCountErrors can be thrown. This change catches those exceptions and shows an AnnotationException containing the annotation name and context.

Resolves: #437

opened May 13, 2022 by 7ochem 2
Open

Catch TypeError during annotation instantiation and throw a more meaningful AnnotationException

I ran into this error:

In OneToMany.php line 45:

  [TypeError]
  Argument 3 passed to Doctrine\ORM\Mapping\OneToMany::__construct() must be of the type array or null,
  string given, called in vendor/doctrine/annotations/lib/Doctrine/Common/Annotations/DocParser.php on line 971

Exception trace:
  at vendor/doctrine/orm/lib/Doctrine/ORM/Mapping/OneToMany.php:45
 Doctrine\ORM\Mapping\OneToMany->__construct() at vendor/doctrine/annotations/lib/Doctrine/Common/Annotations/DocParser.php:971
 Doctrine\Common\Annotations\DocParser->Annotation() at vendor/doctrine/annotations/lib/Doctrine/Common/Annotations/DocParser.php:719
 Doctrine\Common\Annotations\DocParser->Annotations() at vendor/doctrine/annotations/lib/Doctrine/Common/Annotations/DocParser.php:376
 Doctrine\Common\Annotations\DocParser->parse() at vendor/doctrine/annotations/lib/Doctrine/Common/Annotations/AnnotationReader.php:178
 Doctrine\Common\Annotations\AnnotationReader->getPropertyAnnotations() at vendor/doctrine/annotations/lib/Doctrine/Common/Annotations/PsrCachedReader.php:155

I traced calls and variables back to a @OneToMany annotation on a property of an entity containing a misconfiguration and fixed it:

     /**
      * @var Collection<int, Page>|null
-     * @ORM\OneToMany(targetEntity="App\Entity\Page", mappedBy="user", cascade="persist")
+     * @ORM\OneToMany(targetEntity="App\Entity\Page", mappedBy="user", cascade={"persist"})
      */
    private ?Collection $pages;

It's not clear from the error neither the trace (coming from a query being executed and objects being hydrated) on which entity and which property this occurred.

I looked into \Doctrine\Common\Annotations\DocParser and there are many checks being done and many places where there might be a \Doctrine\Common\Annotations\AnnotationException being thrown with clear messages.

Should we catch TypeErrors upon the annotation instantiation here and here and throw an AnnotationException with a proper message containing the annotation and property on which it occurred?

opened May 10, 2022 by 7ochem 6
Open

#186 check if file exists before asking for mtime

doctrine/annotations handles reading annotations from eval’ed code (as in mock objects) just fine, except that it attempts to determine the modification time via ReflectionClass::getFile() which will return the file and line where the eval() happened. This change adds fix and test for the PsrCachedReader and also fixes CachedReader but without a tests since it’s deprecated.

Fixes #186

opened Feb 17, 2022 by lstrojny 0
Open

Add @type to ignored list

Protobuf protoc compiler generates classes with @type annotation, and parser throw exception on this annotation.

Use case:

Framework: Symfony Component: symfony/messenger

Dispatch protobuf-generated message class through messenger and get exception on message validation step (when validator parse class through doctrine/annotation)

opened Jan 20, 2022 by max-petrovich 0
Open

Property annotation with several types (union) does not work

The lib is used within TYPO3 for annotation evaluation. We stumbled over a case that caused the lib to not parse the annotation at all:

class ThingModel
{
...
    /** @var ThingModel|null|bool */
    protected $related;
...
}

The response of the annotation reader is that there are zero annotations present for $related.

I played around with several variations and it turned out that have two of the three types above as annotation works flawlessly, but having all three (or any other three) types causes the reader to hick-up upon this annotation.

Maybe the parser can be improved to handle such a case?

missing tests 
opened Oct 8, 2021 by liayn 4
Open

Trying to get in touch regarding a security issue

Hey there!

I'd like to report a security issue but cannot find contact instructions on your repository.

If not a hassle, might you kindly add a SECURITY.md file with an email, or another contact method? GitHub recommends this best practice to ensure security issues are responsibly disclosed, and it would serve as a simple instruction for security researchers in the future.

Thank you for your consideration, and I look forward to hearing from you!

(cc @huntr-helper)

opened Aug 15, 2021 by zidingz 1

1.13.2(Aug 5, 2021)

Release Notes for 1.13.2

1.13.2

bug

1.13.1(May 16, 2021)

Release Notes for 1.13.1

1.13.1

  • Total issues resolved: 0
  • Total pull requests resolved: 2
  • Total contributors: 2

CI

bug

1.13.0(May 13, 2021)

Release Notes for 1.13.0

1.13.0

  • Total issues resolved: 0
  • Total pull requests resolved: 2
  • Total contributors: 1

enhancement

New Feature

1.12.1(Feb 21, 2021)

Release Notes for 1.12.1

1.12.1

  • Total issues resolved: 1
  • Total pull requests resolved: 1
  • Total contributors: 1

bug

1.12.0(Feb 20, 2021)

Release Notes for 1.12.0

Feature release (minor)

1.12.0

  • Total issues resolved: 0
  • Total pull requests resolved: 8
  • Total contributors: 6

enhancement

New Feature

CI

bug

Improvement

1.11.2(Feb 20, 2021)

Release Notes for 1.11.2

1.11.x bugfix release (patch)

1.11.2

  • Total issues resolved: 0
  • Total pull requests resolved: 5
  • Total contributors: 3

Improvement

CI

enhancement

bug

Contents

    BLLIP BLLIP reranking parser (also known as Charniak-Johnson parser, Charniak parser, Brown reranking parser)
    kensho-technologies Generate PyAnnotate annotations from your pytest tests.
    google SLING - A natural language frame semantics parser
    fcannizzaro Jsoup Annotations POJO
    dropbox Auto-generate PEP-484 annotations
    influxdata Blazing fast syslog parser
    airbus-cert Event Trace Log file parser in pure Python
    phpDocumentor Documentation Generator for PHP
    danieldk Neural network transition-based dependency parser (in Rust)
    aymerick A simple CSS parser and inliner in Go
    nodejs http request/response parser for c
    yahoojapan Simple XML Parser implemented in Swift
    RubyLouvre a lightweight jsx parser
    vuejs The ESLint custom parser for `.vue` files.
    tuananh camaro is an utility to transform XML to JSON, using Node.js binding to native XML parser pugixml, one of the fastest XML parser around.
    nbaksalyar http-muncher - Rust Streaming HTTP parser based on nodejs/http-parser
    alacritty vte - Parser for implementing terminal emulators
    Unipisa DiaParser is a state-of-the-art dependency parser, that extends the architecture of the Biaffine Parser
    peter-winter Compile Time Parser Generator is a C++ single header library which takes a language description as a C++ code and turns it into a LR1 table parser with a deterministic finite automaton lexical analyzer, all in compile time.
    mafintosh Streaming csv parser inspired by binary-csv that aims to be faster than everyone else
    olucurious AppFramer helps to put your app screenshots in beautiful device frames with annotations by running a simple command
    Share this repo

    Related Repos


    Miscellaneous
    14
    A place to keep track of the deferredPagination changes
    hammerstonedev Deferred Pagination Macro This repo holds the Laravel macro that is referenced from https://aaronfrancis.com/2022/efficient-pagination-using-deferred-
     
    Miscellaneous
    4
    KirbyCMS plugin to geneate dynamic tracking-scripts for Ackee
    Sociant Ackee Analytics for KirbyCMS Plugin for KirbyCMS to generate dynamic tracking-scripts for Ackee. Plugin requirements PHP 7+ KirbyCMS 3 Setup Clone the
     
    Miscellaneous
    4
    ReactPHP and Viewi demo application
    ivanvoitovych ReactPHP ft. Viewi This application demonstrates Viewi integration with ReactPHP. Requirements php >= 7.4 react/http viewi/viewi Steps to integrate yo
     
    Miscellaneous
    3
    A php package to get the server information.
    ameetroy A php package to get you the server information Install Via Composer $ composer require ameetroy/server Usage use BubbleGum\Sweety; $getTotalSpace =
     
    Miscellaneous
    3
    The main website source code based on php , html/css/js and an independent db system using...
    JSM33T jsm33t.com Well umm, a neat website LIVE SITE » View Demo · Report Bug · Request a feature About The Project Desc.. Built Using Php UI Frameworks Boot
     
    Miscellaneous
    69
    A concise collection of classes for PHP, Python, JavaScript and Ruby to calculate great ci...
    mwgg GreatCircle A set of three functions, useful in geographical calculations of different sorts. Available for PHP, Python, Javascript and Ruby. Live dem
     
    Miscellaneous
    32
    A package to create Twitter Snowflake identifiers
    mattkingshott Snowflake This package enables a Laravel application to create Twitter Snowflake identifiers. It is a very thin wrapper around the excellent Snowflake
     
    Miscellaneous
    107
    A library for machine learning that builds predictions using a linear regression.
    denissimon PredictionBuilder PredictionBuilder is a library for machine learning that builds predictions using a linear regression. Requirements This project req
     
    Miscellaneous
    15
    A machine learning / bayesian inference engine assigning attributes to objects
    fulldecent 19 Questions Welcome to the 19 Questions game! 19 Questions is a machine learning game which asks you questions and guesses an object you are thinking
     
    Miscellaneous
    15
    A simple way to know if you are on the list of major security breaches like "HIBP", but it...
    Leakfarsi Leakfa.com A simple way to know if you are on the list of major security breaches like "HIBP", but it is specific for Iran. Service content This produ
     
    Miscellaneous
    8
    Um simples pacote para facilitar a integração com a proxypay
    edgarsingui PROXYPAY SDK UM SIMPLES PACOTE EM PHP PARA GERAR PAGAMENTOS UTILIZANDO A PROXYPAY INSTALAÇÃO Se deseja instalar este pacote execute o comando abaixo:
     
    Miscellaneous
    4
    Iran decoration platform is an open source Php web application where you can find your job...
    BlackIQ Iran-Decoration Platform Iran decoration platform is an open source Php web application where you can find your job as a freelancer working in people
     
    Miscellaneous
    8
    A simple writeup /installer script to use android Devices and a UI for KlipperScreen for R...
    naruhaxor AndroidKlipperScreen a simple writeup /installer script to use android Devices and a UI for KlipperScreen for RaspberryPI Thanks to JHS on the Klipper
     
    Miscellaneous
    3
    A doodle.com-like php script to create and view meeting polls to mutually arrange a conven...
    souramoo PhpMeeting A simple doodle.com clone polling script! Demo available at https://sm2030.user.srcf.net/poll/ Features Simple Flat-file data storage Polls
     
    Miscellaneous
    913
    Powerful Multi-User File Manager
    filegator FileGator - Powerful Multi-User File Manager FileGator is a free, open-source, self-hosted web application for managing files and folders. You can man