Daniel Siepmann
9e3f7ac1e5
* Remove construct from interface. * Fix wrong type hints. * Keep naming of variable in sync. * Also keep conditions format in sync. Relates: #71
97 lines
2.7 KiB
PHP
97 lines
2.7 KiB
PHP
<?php
|
|
namespace Typo3Update;
|
|
|
|
/*
|
|
* Copyright (C) 2017 Daniel Siepmann <coding@daniel-siepmann.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.
|
|
*/
|
|
|
|
use PHP_CodeSniffer_File as PhpCsFile;
|
|
use Typo3Update\RemovedByYamlConfiguration;
|
|
|
|
/**
|
|
* Base class for all classes working with removed configuration through yaml files.
|
|
*/
|
|
abstract class AbstractYamlRemovedUsage
|
|
{
|
|
/**
|
|
* @var RemovedByYamlConfiguration
|
|
*/
|
|
protected $configured;
|
|
|
|
public function __construct()
|
|
{
|
|
$this->configured = new RemovedByYamlConfiguration(
|
|
$this->getRemovedConfigFiles(),
|
|
$this->getPrepareStructureCallback()
|
|
);
|
|
}
|
|
|
|
/**
|
|
* @return \Callable
|
|
*/
|
|
protected function getPrepareStructureCallback()
|
|
{
|
|
return function (array $typo3Versions) {
|
|
return call_user_func_array([$this, 'prepareStructure'], [$typo3Versions]);
|
|
};
|
|
}
|
|
|
|
/**
|
|
* @param array $typo3Versions
|
|
* @return array
|
|
*/
|
|
abstract protected function prepareStructure(array $typo3Versions);
|
|
|
|
/**
|
|
* @return array
|
|
*/
|
|
abstract protected function getRemovedConfigFiles();
|
|
|
|
/**
|
|
* @param PhpCsFile $phpcsFile
|
|
* @param int $stackPtr
|
|
* @param array $config
|
|
*/
|
|
protected function addWarning(PhpCsFile $phpcsFile, $stackPtr, array $config)
|
|
{
|
|
$phpcsFile->addWarning(
|
|
'Calls to removed code are not allowed; found %s. Removed in %s. %s. See: %s',
|
|
$stackPtr,
|
|
$config['identifier'],
|
|
[
|
|
$config['oldUsage'],
|
|
$config['versionRemoved'],
|
|
$this->getReplacement($config),
|
|
$config['docsUrl'],
|
|
]
|
|
);
|
|
}
|
|
|
|
/**
|
|
* @param array $config
|
|
* @return string
|
|
*/
|
|
protected function getReplacement(array $config)
|
|
{
|
|
$newCall = $config['replacement'];
|
|
if ($newCall !== null) {
|
|
return $newCall;
|
|
}
|
|
return 'There is no replacement, just remove call';
|
|
}
|
|
}
|