localheinz/token

Provides a simple abstraction for a token and a sequence of tokens.

token

, _(*1)

Provides a simple read-only abstraction for a token and a sequence of tokens, inspired by friendsofphp/php-cs-fixer., _(*2)

Installation

Run, _(*3)

$ composer require localheinz/token

Usage

Sequence of tokens

Create a sequence of tokens from source code:, _(*4)

use Localheinz\Token\Sequence;

$source = <<<'PHP'
<?php

class Foo
{
    /**
     * @param Bar $bar
     */
    public function __construct(Bar $bar)
    {
        $this->bar = $bar;
    }
}
PHP;

$sequence = Sequence::fromSource($source);

Token in sequence

Retrieve the token at an index in the sequence of tokens:, _(*5)

use Localheinz\Token\Token;

/** @var Token $token */
$token = $sequence->at(10);

var_dump($token->index()); // 10
var_dump($token->isType(T_PUBLIC)); // true
var_dump($token->isContent('public')); // true

Retrieve the next significant token before an index in the sequence of tokens:, _(*6)

use Localheinz\Token\Token;

/** @var Token $before */
$before = $sequence->significantBefore(10);

var_dump($before->index()); // 6
var_dump($before->isType(T_STRING)); // true
var_dump($before->isContent('{')); // true

Retrieve the next significant token after an index in the sequence of tokens:, _(*7)

use Localheinz\Token\Token;

/** @var Token $after */
$after = $sequence->significantAfter(10);

var_dump($after->index()); // 12
var_dump($after->isType(T_FUNCTION)); // true
var_dump($after->isContent('function')); // true

Changelog

Please have a look at CHANGELOG.md., _(*8)

Contributing

Please have a look at CONTRIBUTING.md., _(*9)

Code of Conduct

Please have a look at CODE_OF_CONDUCT.md., _(*10)

License

This package is licensed using the MIT License., _(*11)