Skip to content
Snippets Groups Projects
StandardInterface.php 1.45 KiB
Newer Older
<?php

namespace Higidi\ComposerPhpCSStandardsPlugin\PHPCodeSniffer\Standard;

/*
 * Copyright (C) 2017  Daniel Hürtgen <daniel@higidi.de>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301, USA.
 */

/**
 * Interface for PHPCodeSniffer standards.
 */
interface StandardInterface
{
    /**
     * Get the name of the PHPCodeSniffer standard.
     *
     * @return string The name of the PHPCodeSniffer standard.
     */
    public function getName();

    /**
     * Get the path to PHPCodeSniffer standard.
     *
     * @return string The path to the PHPCodeSniffer standard.
     */
    public function getPath();

    /**
     * Get the path to the PHPCodeSniffer ruleset.xml file.
     *
     * @return string The path to the PHPCodeSniffer ruleset.xml file.
     */
    public function getRuleSetXmlPath();
}