markuszeller/php-annotations

Simple tool for parsing annotations

v1.0.0 2019-08-04 18:14 UTC

Requires

• php: >=7.1

MIT

• Markus Zeller

README

This class helps reading annotations.

Features

• reads from a string
• reads from a file
• supports multiline annotation values
• auto trims values

Note

Reads only annotations from DocComments included in /** [...] */.

Look into that double asterisk.

Usage

Initialise an Annotation object

require_once '../vendor/autoload.php';
use markuszeller\Annotations\Reader;

$reader = new Reader();

Put some data into the annotation reader instance

• by a string

    $cssString = file_get_contents('./template.css');
    $reader->loadFromString($cssString);
  

• by file

    if($reader->loadFromFile("./example.css") === false) {
        exit("Error loading file");
    }
  

Get all the annotations as an associative array

$annotationArray = $reader->getAnnotations();

Get a single annotation by name

$title = $reader->getAnnotation('title');