Mediact\CodingStandard\FunctionTrait

Complexity

Total Complexity

4

Size/Duplication

Total Lines	42
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	findFunctionNameIndex()	0	3	1
A	getFunctionName()	0	6	2
A	findFunctionBodyStartIndex()	0	3	1

<?php

/**
 * Copyright MediaCT. All rights reserved.
 * https://www.mediact.nl
 */

namespace Mediact\CodingStandard;

use PHP_CodeSniffer\Files\File;

trait FunctionTrait
{
    /**
     * Get a function name.
     *
     * @param File $file
     * @param int  $functionIndex
     *
     * @return bool|string
     */
    protected function getFunctionName(File $file, $functionIndex)
    {
        $index = $this->findFunctionNameIndex($file, $functionIndex);
        return $index
            ? $file->getTokens()[$index]['content']
            : false;
    }

    /**
     * Find the function name index.
     *
     * @param File $file
     * @param int  $functionIndex
     *
     * @return bool|int
     */
    protected function findFunctionNameIndex(File $file, $functionIndex)
    {
        return $file->findNext([T_STRING], $functionIndex);
    }

    /**
     * Find the start of a function body.
     *
     * @param File $file
     * @param int  $functionIndex
     *
     * @return bool|int
     */
    protected function findFunctionBodyStartIndex(File $file, $functionIndex)
    {
        return $file->findNext([T_SEMICOLON, T_OPEN_CURLY_BRACKET], $functionIndex);
    }
}