CodeStatistics.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
namespace ‪TYPO3\CMS\Install\ExtensionScanner\Php;
 
use PhpParser\Node;
use PhpParser\Node\Stmt\Class_;
use PhpParser\NodeVisitorAbstract;
 
class ‪CodeStatistics extends NodeVisitorAbstract
{
    protected ‪$isCurrentFileIgnored = 0;
 
    protected ‪$numberOfIgnoreLines = 0;
 
    protected ‪$numberOfEffectiveCodeLines = 0;
 
    protected ‪$currentLineNumber = 0;
 
    public function ‪enterNode(Node $node)
    {
        $startLineOfNode = $node->getAttribute('startLine');
        if ($startLineOfNode !== $this->currentLineNumber) {
            $this->currentLineNumber = $startLineOfNode;
            $this->numberOfEffectiveCodeLines++;
 
            // Class statements may contain the @extensionScannerIgnoreFile statements
            if ($node instanceof Class_) {
                $comments = $node->getAttribute('comments');
                if (!empty($comments)) {
                    foreach ($comments as $comment) {
                        if (strpos($comment->getText(), '@extensionScannerIgnoreFile') !== false) {
                            $this->isCurrentFileIgnored = true;
                            break;
                        }
                    }
                }
            }
 
            // First node of line may contain the @extensionScannerIgnoreLine comment
            $comments = $node->getAttribute('comments');
            if (!empty($comments)) {
                foreach ($comments as $comment) {
                    if (strpos($comment->getText(), '@extensionScannerIgnoreLine') !== false) {
                        $this->numberOfIgnoreLines++;
                        break;
                    }
                }
            }
        }
    }
 
    public function ‪isFileIgnored()
    {
        return ‪$this->isCurrentFileIgnored;
    }
 
    public function ‪getNumberOfEffectiveCodeLines()
    {
        return ‪$this->numberOfEffectiveCodeLines;
    }
 
    public function ‪getNumberOfIgnoredLines()
    {
        return ‪$this->numberOfIgnoreLines;
    }
}