HippoPHP/Hippo

View on GitHub
src/Checks/File/ClosingTagCheck.php

Summary

Maintainability
A
25 mins
Test Coverage
<?php

/*
 * This file is part of Hippo.
 *
 * (c) James Brooks <james@alt-three.com>
 * (c) Marcin Kurczewski <rr-@sakuya.pl>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace HippoPHP\Hippo\Checks\File;

use HippoPHP\Hippo\CheckContext;
use HippoPHP\Hippo\Checks\AbstractCheck;
use HippoPHP\Hippo\Checks\CheckInterface;
use HippoPHP\Hippo\Config\Config;

/**
 * Checks the open tag.
 */
class ClosingTagCheck extends AbstractCheck implements CheckInterface
{
    /**
     * @return string
     */
    public function getConfigRoot()
    {
        return 'file.end_tag';
    }

    /**
     * checkFileInternal(): defined by AbstractCheck.
     *
     * @see AbstractCheck::checkFileInternal()
     *
     * @param CheckContext $checkContext
     * @param Config       $config
     */
    protected function checkFileInternal(CheckContext $checkContext, Config $config)
    {
        $file = $checkContext->getFile();
        $tokens = $checkContext->getTokenList();
        $endToken = $tokens->end()->current();

        if (count($file) > 0) {
            if ($config->get('endwith') && !$endToken->isType(T_CLOSE_TAG)) {
                $this->addViolation($file, $endToken->getLine(), 0, 'Files must end with a closing tag.');
            } elseif (!$config->get('endwith') && $endToken->isType(T_CLOSE_TAG)) {
                $this->addViolation($file, $endToken->getLine(), 0, 'Files must not end with a closing tag.');
            }
        }
    }
}