PHPCSStandards / PHPCSUtils / 77

90%

develop: 99%

Pull #17

travis-ci-com

:sparkles: New Utils\GetTokensAsString class

This adds five new utility/convenience methods which are closely related to the PHPCS native `File::getTokensAsString()` method.

In contrast to the PHPCS native `File::getTokensAsString()` method, which has `$length` as the third parameter, all methods in this class expect a stack pointer to an `$end` token (inclusive) as the third parameter.

Methods:
* `normal()` - to retrieve the tab-replaced content of the tokens from the specified start position in the token stack to the specified end position (inclusive). Returns string.
    If the tab width is set, either via a (custom) ruleset, the config file or by passing it on the command-line, PHPCS will automatically replace tabs with spaces.
    The `'content'` index key in the `$tokens` array will contain the tab-replaced content.
    The `'orig_content'` index key in the `$tokens` array will contain the original content.
    This method returns the tokens as string based on the tab-replaced `content` value.
* `tabReplaced()` - alias for the `normal()` method.
* `origContent()` - to retrieve the original content of the tokens from the specified start position in the token stack to the specified end position (inclusive). Returns string.
    This method returns the tokens as string based on the `orig_content` value.
* `noComments()` - to retrieve the code-tokens only content of the tokens from the specified start position in the token stack to the specified end position (inclusive) without comments. Returns string.
* `noEmpties()` - to retrieve the code-tokens only content of the tokens from the specified start position in the token stack to the specified end position (inclusive) without whitespace or comments. Returns string.
    This is, for instance, useful to retrieve a namespace name without stray whitespace or comments.
    Use this function selectively and with care!.
* `compact` - to retrieve the content of the tokens from the specified start position... (continued)

30 of 30 new or added lines in 1 file covered. (100.0%)

2197 of 2438 relevant lines covered (90.11%)

52.04 hits per line