TASK: Rename TypoScript sniff

* As we not only check ObjectIdentifier's anymore, but also further
  parts, renamce sniff to be more generic.
* Also rename configuration and tests accordingly.

Relates: #54
This commit is contained in:
Daniel Siepmann 2017-04-13 15:27:25 +02:00
parent ca4d687155
commit 3e9d8c01c8
Signed by: Daniel Siepmann
GPG key ID: 33D6629915560EF4
7 changed files with 12 additions and 12 deletions

View file

@ -157,13 +157,13 @@ Example:
--runtime-set removedConstantConfigFiles "/Some/Absolute/Path/*.yaml" --runtime-set removedConstantConfigFiles "/Some/Absolute/Path/*.yaml"
.. _configuration-removedTypoScriptObjectIdentifierConfigFiles: .. _configuration-removedTypoScriptConfigFiles:
removedTypoScriptObjectIdentifierConfigFiles removedTypoScriptConfigFiles
-------------------------------------------- ----------------------------
Configure where to look for configuration files defining the removed TypoScript object identifiers. Configure where to look for configuration files defining the removed TypoScript object identifiers.
Default is ``Configuration/Removed/TypoScript/ObjectIdentifier/*.yaml`` inside the standard itself. Default is ``Configuration/Removed/TypoScript/*.yaml`` inside the standard itself.
We already try to deliver as much as possible. Globing is used, so placeholders like ``*`` are We already try to deliver as much as possible. Globing is used, so placeholders like ``*`` are
possible, see https://secure.php.net/manual/en/function.glob.php possible, see https://secure.php.net/manual/en/function.glob.php
@ -171,10 +171,10 @@ Using :file:`ruleset.xml`:
.. code:: xml .. code:: xml
<config name="removedTypoScriptObjectIdentifierConfigFiles" value="/Some/Absolute/Path/*.yaml"/> <config name="removedTypoScriptConfigFiles" value="/Some/Absolute/Path/*.yaml"/>
Example: Example:
.. code:: bash .. code:: bash
--runtime-set removedTypoScriptObjectIdentifierConfigFiles "/Some/Absolute/Path/*.yaml" --runtime-set removedTypoScriptConfigFiles "/Some/Absolute/Path/*.yaml"

View file

@ -82,15 +82,15 @@ class Options
} }
/** /**
* Returns an array of absolute file names containing removed typoscript object identifier configurations. * Returns an array of absolute file names containing removed typoscript.
* *
* @return array<string> * @return array<string>
*/ */
public static function getRemovedTypoScriptObjectIdentifierConfigFiles() public static function getRemovedTypoScriptConfigFiles()
{ {
return static::getOptionFileNames( return static::getOptionFileNames(
'removedTypoScriptObjectIdentifier', 'removedTypoScript',
__DIR__ . '/../Configuration/Removed/TypoScript/ObjectIdentifier/*.yaml' __DIR__ . '/../Configuration/Removed/TypoScript/*.yaml'
); );
} }

View file

@ -5,7 +5,7 @@ use PHP_CodeSniffer_File as PhpCsFile;
use Typo3Update\Sniffs\Options; use Typo3Update\Sniffs\Options;
use Typo3Update\Sniffs\Removed\AbstractGenericUsage; use Typo3Update\Sniffs\Removed\AbstractGenericUsage;
class Typo3Update_Sniffs_Removed_TypoScriptObjectIdentifierSniff extends AbstractGenericUsage class Typo3Update_Sniffs_Removed_TypoScriptSniff extends AbstractGenericUsage
{ {
public $supportedTokenizers = [ public $supportedTokenizers = [
'TYPOSCRIPT', 'TYPOSCRIPT',
@ -112,6 +112,6 @@ class Typo3Update_Sniffs_Removed_TypoScriptObjectIdentifierSniff extends Abstrac
*/ */
protected function getRemovedConfigFiles() protected function getRemovedConfigFiles()
{ {
return Options::getRemovedTypoScriptObjectIdentifierConfigFiles(); return Options::getRemovedTypoScriptConfigFiles();
} }
} }