diff --git a/Readme.rst b/Readme.rst
index e87a3a89a2f3c08197da602119991de23acffbad..dcc9770b392705abb6294fa51effb7802a31e744 100644
--- a/Readme.rst
+++ b/Readme.rst
@@ -108,6 +108,10 @@ available to generate a report of possible issues and during coding through ``ph
inside the standard itself, and we try to deliver all information.
For configuration options see ``removedFunctionConfigFiles``.
+- Check for usage of removed constants.
+ The constants are configured in same way as removed functions.
+ For configuration options see ``removedConstantConfigFiles``.
+
What does it look like?
=======================
@@ -220,3 +224,21 @@ Example:
.. code:: bash
--runtime-set removedFunctionConfigFiles "/Some/Absolute/Path/*.yaml"
+
+``removedConstantConfigFiles``
+ Configure your vendor through ``ruleset.xml`` or using ``--runtime-set``. Default is
+ ``Configuration/Removed/Constants/*.yaml`` inside the standard itself.
+ Globing is used, so placeholders like ``*`` are possible, see
+ https://secure.php.net/manual/en/function.glob.php
+
+ Example:
+
+.. code:: xml
+
+ <config name="removedConstantConfigFiles" value="/Some/Absolute/Path/*.yaml"/>
+
+Example:
+
+.. code:: bash
+
+ --runtime-set removedConstantConfigFiles "/Some/Absolute/Path/*.yaml"
diff --git a/src/Standards/Typo3Update/Configuration/Removed/Constants/7.0.yaml b/src/Standards/Typo3Update/Configuration/Removed/Constants/7.0.yaml
new file mode 100644
index 0000000000000000000000000000000000000000..49c13d4838b20cdba7a5bb3aede2ab81539d5212
--- /dev/null
+++ b/src/Standards/Typo3Update/Configuration/Removed/Constants/7.0.yaml
@@ -0,0 +1,11 @@
+# Breaking changes in 7.0: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Index.html#breaking-changes
+'7.0':
+ PATH_tslib:
+ replacement: 'The folder and constant no longer exist'
+ docsUrl: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-61459-RemovalTslib.html
+ \TYPO3\CMS\Core\Resource\AbstractFile::FILETYPE_SOFTWARE:
+ replacement: 'Use \TYPO3\CMS\Core\Resource\AbstractFile::FILETYPE_APPLICATION instead'
+ docsUrl: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-61859-FileTypeSoftwareRemoved.html
+ REQUIRED_EXTENSIONS:
+ replacement: null
+ docsUrl: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62416-DeprecatedCodeRemovalInCoreSysext.html#packagemanager
diff --git a/src/Standards/Typo3Update/Configuration/Removed/Constants/7.4.yaml b/src/Standards/Typo3Update/Configuration/Removed/Constants/7.4.yaml
new file mode 100644
index 0000000000000000000000000000000000000000..71130bbc5d5608bac11251a20ab85f5cd93dee37
--- /dev/null
+++ b/src/Standards/Typo3Update/Configuration/Removed/Constants/7.4.yaml
@@ -0,0 +1,8 @@
+# Breaking changes in 7.4: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.4/Index.html#breaking-changes
+'7.4':
+ TYPO3_MOD_PATH:
+ replacement: 'It is required to route modules through typo3/mod.php from now on in case the module relies on the definition of those constants'
+ docsUrl: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.4/Breaking-67987-RemovedEntryScriptHandling.html
+ PATH_typo3_mod:
+ replacement: 'It is required to route modules through typo3/mod.php from now on in case the module relies on the definition of those constants'
+ docsUrl: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.4/Breaking-67987-RemovedEntryScriptHandling.html
diff --git a/src/Standards/Typo3Update/Configuration/Removed/Constants/7.5.yaml b/src/Standards/Typo3Update/Configuration/Removed/Constants/7.5.yaml
new file mode 100644
index 0000000000000000000000000000000000000000..7c02d6d17c74d90720169677bfb25b4e437f91dc
--- /dev/null
+++ b/src/Standards/Typo3Update/Configuration/Removed/Constants/7.5.yaml
@@ -0,0 +1,5 @@
+# Breaking changes in 7.5: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.5/Index.html#breaking-changes
+'7.5':
+ TYPO3_URL_ORG:
+ replacement: 'Use TYPO3_URL_GENERAL instead'
+ docsUrl: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.5/Breaking-68814-RemoveOfBaseConstantTYPO3_URL_ORG.html
diff --git a/src/Standards/Typo3Update/Configuration/Removed/Constants/7.6.yaml b/src/Standards/Typo3Update/Configuration/Removed/Constants/7.6.yaml
new file mode 100644
index 0000000000000000000000000000000000000000..0691b70fd909bbe178a7cc6251835fc0bd2716a8
--- /dev/null
+++ b/src/Standards/Typo3Update/Configuration/Removed/Constants/7.6.yaml
@@ -0,0 +1,14 @@
+# Breaking changes in 7.6: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.6/Index.html#breaking-changes
+'7.6':
+ \TYPO3\CMS\IndexedSearch\Controller\SearchFormController::WILDCARD_LEFT:
+ replacement: 'Use \TYPO3\CMS\IndexedSearch\Utility\LikeWildcard::LEFT instead'
+ docsUrl: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.6/Breaking-69227-StringsForLikeAreNotProperlyEscaped.html
+ \TYPO3\CMS\IndexedSearch\Controller\SearchFormController::WILDCARD_RIGHT:
+ replacement: 'Use \TYPO3\CMS\IndexedSearch\Utility\LikeWildcard::RIGHT instead'
+ docsUrl: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.6/Breaking-69227-StringsForLikeAreNotProperlyEscaped.html
+ \TYPO3\CMS\IndexedSearch\Domain\Repository\IndexSearchRepository::WILDCARD_LEFT:
+ replacement: 'Use \TYPO3\CMS\IndexedSearch\Utility\LikeWildcard::LEFT instead'
+ docsUrl: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.6/Breaking-69227-StringsForLikeAreNotProperlyEscaped.html
+ \TYPO3\CMS\IndexedSearch\Domain\Repository\IndexSearchRepository::WILDCARD_RIGHT:
+ replacement: 'Use \TYPO3\CMS\IndexedSearch\Utility\LikeWildcard::RIGHT instead'
+ docsUrl: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.6/Breaking-69227-StringsForLikeAreNotProperlyEscaped.html
diff --git a/src/Standards/Typo3Update/Configuration/Removed/Functions/7.0.yaml b/src/Standards/Typo3Update/Configuration/Removed/Functions/7.0.yaml
index 3913b8c54115f849cad0357c6f1a869c23207287..999b99faf95b1b5c5b8cde8a1b8032e8a469db8c 100644
--- a/src/Standards/Typo3Update/Configuration/Removed/Functions/7.0.yaml
+++ b/src/Standards/Typo3Update/Configuration/Removed/Functions/7.0.yaml
@@ -1,218 +1,218 @@
# Breaking changes in 7.0: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Index.html#breaking-changes
'7.0':
\TYPO3\CMS\Core\Utility\GeneralUtility::loadTCA:
- newFunctionCall: null
+ replacement: null
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-61785-LoadTcaFunctionRemoved.html'
\TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController->getCompressedTCarray:
- newFunctionCall: 'Full TCA is always loaded during bootstrap in FE, the method is obsolete. If an eid script calls this method to load TCA, use \TYPO3\CMS\Frontend\Utility\EidUtility::initTCA() instead'
+ replacement: 'Full TCA is always loaded during bootstrap in FE, the method is obsolete. If an eid script calls this method to load TCA, use \TYPO3\CMS\Frontend\Utility\EidUtility::initTCA() instead'
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-61785-FrontendTcaFunctionsRemoved.html'
\TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController->includeTCA:
- newFunctionCall: 'Full TCA is always loaded during bootstrap in FE, the method is obsolete. If an eid script calls this method to load TCA, use \TYPO3\CMS\Frontend\Utility\EidUtility::initTCA() instead'
+ replacement: 'Full TCA is always loaded during bootstrap in FE, the method is obsolete. If an eid script calls this method to load TCA, use \TYPO3\CMS\Frontend\Utility\EidUtility::initTCA() instead'
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-61785-FrontendTcaFunctionsRemoved.html'
\TYPO3\CMS\Core\Utility\MailUtility::mail:
- newFunctionCall: 'Use the \TYPO3\CMS\Core\Mail\Mailer API for sending email'
+ replacement: 'Use the \TYPO3\CMS\Core\Mail\Mailer API for sending email'
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-61783-RemoveDeprecatedMailFunctionality.html'
\TYPO3\CMS\Core\Utility\GeneralUtility::plainMailEncoded:
- newFunctionCall: 'Use the \TYPO3\CMS\Core\Mail\Mailer API for sending email'
+ replacement: 'Use the \TYPO3\CMS\Core\Mail\Mailer API for sending email'
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-61783-RemoveDeprecatedMailFunctionality.html'
\TYPO3\CMS\Frontend\Utility\EidUtility::connectDB:
- newFunctionCall: null
+ replacement: null
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-61863-ConnectDbFunctionRemoved.html'
\TYPO3\CMS\Core\Utility\GeneralUtility::int_from_ver:
- newFunctionCall: 'Replace the usage of the removed function with \TYPO3\CMS\Core\Utility\VersionNumberUtility::convertVersionNumberToInteger()'
+ replacement: 'Replace the usage of the removed function with \TYPO3\CMS\Core\Utility\VersionNumberUtility::convertVersionNumberToInteger()'
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-61860-RemoveIntFromVerFunction.html'
\TYPO3\CMS\Core\DataHandlin\DataHandler->getUniqueFields:
- newFunctionCall: 'Replace all calls to \TYPO3\CMS\Core\DataHandling\DataHandler::getUniqueFields() with calls to \TYPO3\CMS\Version\Hook\DataHandlerHook::getUniqueFields()'
+ replacement: 'Replace all calls to \TYPO3\CMS\Core\DataHandling\DataHandler::getUniqueFields() with calls to \TYPO3\CMS\Version\Hook\DataHandlerHook::getUniqueFields()'
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-61822-GetUniqueFieldsFunctionRemoved.html'
\TYPO3\CMS\Core\Utility\PhpOptionsUtility::isSafeModeEnabled:
- newFunctionCall: null
+ replacement: null
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-61820-PhpOptionsUtilityDeprecatedFunctionsRemoved.html'
\TYPO3\CMS\Core\Utility\PhpOptionsUtility::isMagicQuotesGpcEnabled:
- newFunctionCall: null
+ replacement: null
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-61820-PhpOptionsUtilityDeprecatedFunctionsRemoved.html'
\TYPO3\CMS\Core\Utility\ExtensionManagementUtility::isLocalconfWritable:
- newFunctionCall: null
+ replacement: null
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-61802-IsLocalconfWritableFunctionRemoved.html'
\TYPO3\CMS\Extbase\Object\ObjectManager->create:
- newFunctionCall: 'Use ObjectManager::get() instead'
+ replacement: 'Use ObjectManager::get() instead'
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62673-ExtbaseDeprecatedCodeRemoved.html'
\TYPO3\CMS\Extbase\Persistence\Generic\Backend->replaceObject:
- newFunctionCall: 'Removed without replacement'
+ replacement: 'Removed without replacement'
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62673-ExtbaseDeprecatedCodeRemoved.html'
\TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface->setReturnRawQueryResult:
- newFunctionCall: 'Removed without replacement'
+ replacement: 'Removed without replacement'
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62673-ExtbaseDeprecatedCodeRemoved.html'
\TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface->getReturnRawQueryResult:
- newFunctionCall: 'Use the parameter on $query->execute() directly'
+ replacement: 'Use the parameter on $query->execute() directly'
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62673-ExtbaseDeprecatedCodeRemoved.html'
\TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings->setSysLanguageUid:
- newFunctionCall: 'Use setLanguageUid() instead'
+ replacement: 'Use setLanguageUid() instead'
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62673-ExtbaseDeprecatedCodeRemoved.html'
\TYPO3\CMS\Extbase\Persistence\Generic\Typo3QuerySettings->getSysLanguageUid:
- newFunctionCall: 'Use getLanguageUid() instead'
+ replacement: 'Use getLanguageUid() instead'
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62673-ExtbaseDeprecatedCodeRemoved.html'
\TYPO3\CMS\Lang\LanguageService->JScharCode:
- newFunctionCall: 'Use GeneralUtility::quoteJSvalue instead'
+ replacement: 'Use GeneralUtility::quoteJSvalue instead'
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62670-DeprecatedCodeRemovalInMultipleSysexts.html'
\TYPO3\CMS\Frontend\ContentObjec\ContentObjectRenderer->joinTSarrays:
- newFunctionCall: null
+ replacement: null
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62670-DeprecatedCodeRemovalInMultipleSysexts.html'
\TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController->tidyHTML:
- newFunctionCall: 'You may use the tidy extension from TER'
+ replacement: 'You may use the tidy extension from TER'
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62670-DeprecatedCodeRemovalInMultipleSysexts.html'
\TYPO3\CMS\Recordlist\Browser\ElementBrowser->isWebFolder:
- newFunctionCall: null
+ replacement: null
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62670-DeprecatedCodeRemovalInMultipleSysexts.html'
\TYPO3\CMS\Recordlist\Browser\ElementBrowser->checkFolder:
- newFunctionCall: null
+ replacement: null
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62670-DeprecatedCodeRemovalInMultipleSysexts.html'
\TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList->getTreeObject:
- newFunctionCall: null
+ replacement: null
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62670-DeprecatedCodeRemovalInMultipleSysexts.html'
\TYPO3\CMS\Filelist\FileList->dirData:
- newFunctionCall: null
+ replacement: null
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62670-DeprecatedCodeRemovalInMultipleSysexts.html'
\TYPO3\CMS\Frontend\ContentObject\FilesContentObject->stdWrapValue:
- newFunctionCall: 'Use ContentObjectRenderer::stdWrapValue instead'
+ replacement: 'Use ContentObjectRenderer::stdWrapValue instead'
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62670-DeprecatedCodeRemovalInMultipleSysexts.html'
\TYPO3\CMS\Impexp\Controller\ImportExportController->userTempFolder:
- newFunctionCall: 'Use getDefaultImportExportFolder instead'
+ replacement: 'Use getDefaultImportExportFolder instead'
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62670-DeprecatedCodeRemovalInMultipleSysexts.html'
\TYPO3\CMS\Impexp\Controller\ImportExportController->userSaveFolder:
- newFunctionCall: 'Use getDefaultImportExportFolder instead'
+ replacement: 'Use getDefaultImportExportFolder instead'
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62670-DeprecatedCodeRemovalInMultipleSysexts.html'
\TYPO3\CMS\Lowlevel\View\DatabaseIntegrityView->func_filesearch:
- newFunctionCall: null
+ replacement: null
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62670-DeprecatedCodeRemovalInMultipleSysexts.html'
\TYPO3\CMS\Lowlevel\View\DatabaseIntegrityView->findFile:
- newFunctionCall: null
+ replacement: null
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62670-DeprecatedCodeRemovalInMultipleSysexts.html'
\TYPO3\CMS\Rtehtmlarea\RteHtmlAreaBase->buildStyleSheet:
- newFunctionCall: null
+ replacement: null
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62670-DeprecatedCodeRemovalInMultipleSysexts.html'
\TYPO3\CMS\Rtehtmlarea\RteHtmlAreaBase->loremIpsumInsert:
- newFunctionCall: null
+ replacement: null
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62670-DeprecatedCodeRemovalInMultipleSysexts.html'
\TYPO3\CMS\Workspaces\Service\StagesService->checkCustomStagingForWS:
- newFunctionCall: null
+ replacement: null
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62670-DeprecatedCodeRemovalInMultipleSysexts.html'
\TYPO3\CMS\Core\DataHandling\DataHandler->clear_cache:
- newFunctionCall: 'Use ->clear_cacheCmd() instead. Alternatively you can call ->registerPageCacheClearing() from a hook to not immediately clear the cache but register clearing after DataHandler operation finishes'
+ replacement: 'Use ->clear_cacheCmd() instead. Alternatively you can call ->registerPageCacheClearing() from a hook to not immediately clear the cache but register clearing after DataHandler operation finishes'
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62416-DeprecatedCodeRemovalInCoreSysext.html'
\TYPO3\CMS\Core\DataHandling\DataHandler->internal_clearPageCache:
- newFunctionCall: 'Use the cache manager directly'
+ replacement: 'Use the cache manager directly'
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62416-DeprecatedCodeRemovalInCoreSysext.html'
\TYPO3\CMS\Core\Utility\GeneralUtility::array_merge_recursive_overrule:
- newFunctionCall: 'Use ArrayUtility::mergeRecursiveWithOverrule() instead. WARNING: The new method changed its signature and does not return the first parameter anymore'
+ replacement: 'Use ArrayUtility::mergeRecursiveWithOverrule() instead. WARNING: The new method changed its signature and does not return the first parameter anymore'
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62416-DeprecatedCodeRemovalInCoreSysext.html'
\TYPO3\CMS\Core\Utility\GeneralUtility::htmlspecialchars_decode:
- newFunctionCall: 'Use native PHP htmlspecialchars_decode() function'
+ replacement: 'Use native PHP htmlspecialchars_decode() function'
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62416-DeprecatedCodeRemovalInCoreSysext.html'
# NOTE: This is useless, adding a warning to all "get" methods is crazy.
# Also this is already handeled by: Typo3Update_Sniffs_LegacyClassnames_InstantiationWithObjectManagerSniff
# \TYPO3\CMS\Core\Category\CategoryRegistry->get:
- # newFunctionCall: 'Use isRegistered() instead'
+ # replacement: 'Use isRegistered() instead'
# docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62416-DeprecatedCodeRemovalInCoreSysext.html'
\TYPO3\CMS\Core\Category\CategoryRegistry->applyTca:
- newFunctionCall: null
+ replacement: null
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62416-DeprecatedCodeRemovalInCoreSysext.html'
# NOTE: This is useless, adding a warning to all "findByUid" methods is crazy.
# Many calls to repositories will be marked as warning
# \TYPO3\CMS\Core\Resource\FileRepository->findByUid:
- # newFunctionCall: null
+ # replacement: null
# docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62416-DeprecatedCodeRemovalInCoreSysext.html'
\TYPO3\CMS\Core\Resource\FileRepository->addToIndex:
- newFunctionCall: null
+ replacement: null
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62416-DeprecatedCodeRemovalInCoreSysext.html'
\TYPO3\CMS\Core\Resource\FileRepository->getFileIndexRecordsForFolder:
- newFunctionCall: 'Use FileIndexRepository::findByFolder() instead'
+ replacement: 'Use FileIndexRepository::findByFolder() instead'
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62416-DeprecatedCodeRemovalInCoreSysext.html'
\TYPO3\CMS\Core\Resource\FileRepository->getFileIndexRecord:
- newFunctionCall: 'Use FileIndexRepository::findOneByFileObject() instead'
+ replacement: 'Use FileIndexRepository::findOneByFileObject() instead'
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62416-DeprecatedCodeRemovalInCoreSysext.html'
\TYPO3\CMS\Core\Resource\FileRepository->findBySha1Hash:
- newFunctionCall: 'Use FileIndexRepository::findByContentHash() instead'
+ replacement: 'Use FileIndexRepository::findByContentHash() instead'
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62416-DeprecatedCodeRemovalInCoreSysext.html'
# NOTE: This is useless, adding a warning to all "update" methods is crazy.
# All repository updates will be marked as warning
# \TYPO3\CMS\Core\Resource\FileRepository->update:
- # newFunctionCall: 'Use FileIndexRepository::update() instead'
+ # replacement: 'Use FileIndexRepository::update() instead'
# docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62416-DeprecatedCodeRemovalInCoreSysext.html'
\TYPO3\CMS\Core\Resource\ResourceStorage->getFolderByIdentifier:
- newFunctionCall: 'Use getFolder() instead'
+ replacement: 'Use getFolder() instead'
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62416-DeprecatedCodeRemovalInCoreSysext.html'
\TYPO3\CMS\Core\Resource\ResourceStorage->getFileByIdentifier:
- newFunctionCall: 'Use getFileInfoByIdentifier() instead'
+ replacement: 'Use getFileInfoByIdentifier() instead'
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62416-DeprecatedCodeRemovalInCoreSysext.html'
\TYPO3\CMS\Core\Resource\ResourceStorage->getFileList:
- newFunctionCall: 'Use getFilesInFolder() instead'
+ replacement: 'Use getFilesInFolder() instead'
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62416-DeprecatedCodeRemovalInCoreSysext.html'
\TYPO3\CMS\Core\Resource\ResourceStorage->getFolderList:
- newFunctionCall: 'Use getFoldersInFolder() instead'
+ replacement: 'Use getFoldersInFolder() instead'
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62416-DeprecatedCodeRemovalInCoreSysext.html'
\TYPO3\CMS\Core\Resource\ResourceStorage->fetchFolderListFromDriver:
- newFunctionCall: 'Use getFoldersInFolder() instead'
+ replacement: 'Use getFoldersInFolder() instead'
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62416-DeprecatedCodeRemovalInCoreSysext.html'
\TYPO3\CMS\Core\Utility\File\BasicFileUtility->getTotalFileInfo:
- newFunctionCall: "Use ResourceStorage instead via $GLOBALS['BE_USER']->getFileStorages()"
+ replacement: "Use ResourceStorage instead via $GLOBALS['BE_USER']->getFileStorages()"
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62416-DeprecatedCodeRemovalInCoreSysext.html'
\TYPO3\CMS\Core\Utility\File\BasicFileUtility->checkFileNameLen:
- newFunctionCall: "Use ResourceStorage instead via $GLOBALS['BE_USER']->getFileStorages()"
+ replacement: "Use ResourceStorage instead via $GLOBALS['BE_USER']->getFileStorages()"
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62416-DeprecatedCodeRemovalInCoreSysext.html'
\TYPO3\CMS\Core\Utility\File\BasicFileUtility->isPathValid:
- newFunctionCall: 'Use GeneralUtility::validPathStr() instead'
+ replacement: 'Use GeneralUtility::validPathStr() instead'
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62416-DeprecatedCodeRemovalInCoreSysext.html'
\TYPO3\CMS\Core\Utility\File\BasicFileUtility->blindPath:
- newFunctionCall: null
+ replacement: null
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62416-DeprecatedCodeRemovalInCoreSysext.html'
\TYPO3\CMS\Core\Utility\File\BasicFileUtility->findTempFolder:
- newFunctionCall: null
+ replacement: null
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62416-DeprecatedCodeRemovalInCoreSysext.html'
\TYPO3\CMS\Core\Utility\File\BasicFileUtility->rmDoubleSlash:
- newFunctionCall: null
+ replacement: null
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62416-DeprecatedCodeRemovalInCoreSysext.html'
\TYPO3\CMS\Core\Utility\File\BasicFileUtility->cleanDirectoryName:
- newFunctionCall: 'Use PathUtility::getCanonicalPath() instead'
+ replacement: 'Use PathUtility::getCanonicalPath() instead'
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62416-DeprecatedCodeRemovalInCoreSysext.html'
\TYPO3\CMS\Core\Utility\File\ExtendedFileUtility->init_actionPerms:
- newFunctionCall: 'Use setActionPermissions() instead'
+ replacement: 'Use setActionPermissions() instead'
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62416-DeprecatedCodeRemovalInCoreSysext.html'
\TYPO3\CMS\Core\Utility\File\ExtendedFileUtility->printLogErrorMessages:
- newFunctionCall: 'Use pushErrorMessagesToFlashMessageQueue() instead'
+ replacement: 'Use pushErrorMessagesToFlashMessageQueue() instead'
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62416-DeprecatedCodeRemovalInCoreSysext.html'
\TYPO3\CMS\Core\Utility\File\ExtendedFileUtility->findRecycler:
- newFunctionCall: 'Use \TYPO3\CMS\Core\Resource\ResourceStorage instead'
+ replacement: 'Use \TYPO3\CMS\Core\Resource\ResourceStorage instead'
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62416-DeprecatedCodeRemovalInCoreSysext.html'
\TYPO3\CMS\Core\Html\RteHtmlParser->findRecycler:
- newFunctionCall: "Use $fileFactory->getFolderObjectFromCombinedIdentifier($GLOBALS['TYPO3_CONF_VARS']['BE']['RTE_imageStorageDir']); instead"
+ replacement: "Use $fileFactory->getFolderObjectFromCombinedIdentifier($GLOBALS['TYPO3_CONF_VARS']['BE']['RTE_imageStorageDir']); instead"
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62416-DeprecatedCodeRemovalInCoreSysext.html'
\TYPO3\CMS\Rtehtmlarea\SelectImage->getRTEImageStorageDir:
- newFunctionCall: "Use $fileFactory->getFolderObjectFromCombinedIdentifier($GLOBALS['TYPO3_CONF_VARS']['BE']['RTE_imageStorageDir']); instead"
+ replacement: "Use $fileFactory->getFolderObjectFromCombinedIdentifier($GLOBALS['TYPO3_CONF_VARS']['BE']['RTE_imageStorageDir']); instead"
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62416-DeprecatedCodeRemovalInCoreSysext.html'
\TYPO3\CMS\Core\Localization\Locales->getTerLocales:
- newFunctionCall: null
+ replacement: null
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62416-DeprecatedCodeRemovalInCoreSysext.html'
\TYPO3\CMS\Core\Localization\Locales->getTerLocaleDependencies:
- newFunctionCall: null
+ replacement: null
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62416-DeprecatedCodeRemovalInCoreSysext.html'
\TYPO3\CMS\Core\Localization\Locales->convertToTerLocales:
- newFunctionCall: null
+ replacement: null
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62416-DeprecatedCodeRemovalInCoreSysext.html'
\TYPO3\CMS\Core\Utility\ExtensionManagementUtility::getInsertionNeedles:
- newFunctionCall: null
+ replacement: null
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62416-DeprecatedCodeRemovalInCoreSysext.html'
\TYPO3\CMS\Core\Utility\ExtensionManagementUtility::insertModuleFunction:
- newFunctionCall: null
+ replacement: null
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62416-DeprecatedCodeRemovalInCoreSysext.html'
\TYPO3\CMS\Core\Utility\ExtensionManagementUtility::getRequiredExtensionListArray:
- newFunctionCall: null
+ replacement: null
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62416-DeprecatedCodeRemovalInCoreSysext.html'
\TYPO3\CMS\Core\Utility\ExtensionManagementUtility::writeNewExtensionList:
- newFunctionCall: null
+ replacement: null
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62416-DeprecatedCodeRemovalInCoreSysext.html'
\TYPO3\CMS\Core\Utility\PhpOptionsUtility::isSqlSafeModeEnabled:
- newFunctionCall: null
+ replacement: null
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62416-DeprecatedCodeRemovalInCoreSysext.html'
\TYPO3\CMS\Core\Core\ClassLoader::getAliasForClassName:
- newFunctionCall: 'Use getAliasesForClassName() instead'
+ replacement: 'Use getAliasesForClassName() instead'
docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62416-DeprecatedCodeRemovalInCoreSysext.html'
diff --git a/src/Standards/Typo3Update/Configuration/Removed/Functions/7.2.yaml b/src/Standards/Typo3Update/Configuration/Removed/Functions/7.2.yaml
index d1cb239a302af9849d31832dea6823894f96c688..d59661004aa637f92c59e976e2fcc0f28817676e 100644
--- a/src/Standards/Typo3Update/Configuration/Removed/Functions/7.2.yaml
+++ b/src/Standards/Typo3Update/Configuration/Removed/Functions/7.2.yaml
@@ -1,36 +1,36 @@
# Breaking changes in 7.2: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.2/Index.html
'7.2':
\TYPO3\CMS\Core\Page\PageRenderer->setSvgPath:
- newFunctionCall: 'Use 3rd party library instead, which is already loaded by TYPO3'
+ replacement: 'Use 3rd party library instead, which is already loaded by TYPO3'
docsUrl: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.2/Breaking-65962-WebSVGLibraryAndAPIRemoved.html
\TYPO3\CMS\Core\Page\PageRenderer->loadSvg:
- newFunctionCall: 'Use 3rd party library instead, which is already loaded by TYPO3'
+ replacement: 'Use 3rd party library instead, which is already loaded by TYPO3'
docsUrl: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.2/Breaking-65962-WebSVGLibraryAndAPIRemoved.html
\TYPO3\CMS\Core\Page\PageRenderer->enableSvgDebug:
- newFunctionCall: 'Use 3rd party library instead, which is already loaded by TYPO3'
+ replacement: 'Use 3rd party library instead, which is already loaded by TYPO3'
docsUrl: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.2/Breaking-65962-WebSVGLibraryAndAPIRemoved.html
\TYPO3\CMS\Core\Page\PageRenderer->svgForceFlash:
- newFunctionCall: 'Use 3rd party library instead, which is already loaded by TYPO3'
+ replacement: 'Use 3rd party library instead, which is already loaded by TYPO3'
docsUrl: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.2/Breaking-65962-WebSVGLibraryAndAPIRemoved.html
\TYPO3\CMS\Backend\Controller\LoginController->makeLoginForm:
- newFunctionCall: 'Use the new Fluid View to adjust the login screen instead'
+ replacement: 'Use the new Fluid View to adjust the login screen instead'
docsUrl: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.2/Breaking-65939-BackendLoginRefactoring.html
\TYPO3\CMS\Backend\Controller\LoginController->makeLogoutForm:
- newFunctionCall: 'Use the new Fluid View to adjust the login screen instead'
+ replacement: 'Use the new Fluid View to adjust the login screen instead'
docsUrl: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.2/Breaking-65939-BackendLoginRefactoring.html
\TYPO3\CMS\Backend\Controller\LoginController->wrapLoginForm:
- newFunctionCall: 'Use the new Fluid View to adjust the login screen instead'
+ replacement: 'Use the new Fluid View to adjust the login screen instead'
docsUrl: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.2/Breaking-65939-BackendLoginRefactoring.html
\TYPO3\CMS\Backend\Controller\LoginController->makeLoginBoxImage:
- newFunctionCall: 'Use the new Fluid View to adjust the login screen instead'
+ replacement: 'Use the new Fluid View to adjust the login screen instead'
docsUrl: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.2/Breaking-65939-BackendLoginRefactoring.html
\TYPO3\CMS\Backend\Controller\LoginController->makeLoginNews:
- newFunctionCall: 'Use the new Fluid View to adjust the login screen instead'
+ replacement: 'Use the new Fluid View to adjust the login screen instead'
docsUrl: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.2/Breaking-65939-BackendLoginRefactoring.html
\TYPO3\CMS\Backend\Controller\LoginController->emitRenderLoginFormSignal:
- newFunctionCall: 'Use the new Fluid View to adjust the login screen instead'
+ replacement: 'Use the new Fluid View to adjust the login screen instead'
docsUrl: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.2/Breaking-65939-BackendLoginRefactoring.html
# NOTE: This is useless, adding a warning to all "getSignalSlotDispatcher" methods is crazy, many developers implement such a method.
# \TYPO3\CMS\Backend\Controller\LoginController->getSignalSlotDispatcher:
-# newFunctionCall: 'Use the new Fluid View to adjust the login screen instead'
+# replacement: 'Use the new Fluid View to adjust the login screen instead'
# docsUrl: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.2/Breaking-65939-BackendLoginRefactoring.html
diff --git a/src/Standards/Typo3Update/Configuration/Removed/Functions/7.3.yaml b/src/Standards/Typo3Update/Configuration/Removed/Functions/7.3.yaml
index 15ff9b8221c7644d72a5e7498fa73d7440d068da..4194ed633b7dd17709d9e67b86f6322837996f5c 100644
--- a/src/Standards/Typo3Update/Configuration/Removed/Functions/7.3.yaml
+++ b/src/Standards/Typo3Update/Configuration/Removed/Functions/7.3.yaml
@@ -2,12 +2,12 @@
'7.3':
# NOTE: If this is making you crazy, just disable via ruleset.xml or phpcs.xml
parent::initializeObject:
- newFunctionCall: 'Remove call, if this is inside a child of \TYPO3\CMS\Extbase\DomainObject\AbstractDomainObject, there is no initializeObject in the parent anymore.'
+ replacement: 'Remove call, if this is inside a child of \TYPO3\CMS\Extbase\DomainObject\AbstractDomainObject, there is no initializeObject in the parent anymore.'
docsUrl: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.3/Breaking-67402-ExtbaseAbstractDomainObjectInitializeObject.html
\TYPO3\CMS\Extbase\Persistence\Repository::replace:
- newFunctionCall: null
+ replacement: null
docsUrl: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.3/Breaking-63835-RemoveDeprecatedExtbasePersistenceParts.html
\TYPO3\CMS\Extbase\Persistence\Generic\Backend::setDeletedObjects:
- newFunctionCall: null
+ replacement: null
docsUrl: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.3/Breaking-63835-RemoveDeprecatedExtbasePersistenceParts.html
diff --git a/src/Standards/Typo3Update/Configuration/Removed/Functions/7.4.yaml b/src/Standards/Typo3Update/Configuration/Removed/Functions/7.4.yaml
index ee9bbd50b1cfdf5e6bbfee6cf9cd2a7c07b954f5..aefe6e70ef9c9ed89dd608ddb35565b30a3edbe6 100644
--- a/src/Standards/Typo3Update/Configuration/Removed/Functions/7.4.yaml
+++ b/src/Standards/Typo3Update/Configuration/Removed/Functions/7.4.yaml
@@ -1,81 +1,81 @@
# Breaking changes in 7.4: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.4/Index.html#breaking-changes
'7.4':
\TYPO3\CMS\Core\Page\PageRenderer::setExtCorePath:
- newFunctionCall: null
+ replacement: null
docsUrl: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.4/Breaking-68001-RemovedExtJSCoreAndExtJSAdapters.html
\TYPO3\CMS\Core\Page\PageRenderer::getExtCorePath:
- newFunctionCall: null
+ replacement: null
docsUrl: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.4/Breaking-68001-RemovedExtJSCoreAndExtJSAdapters.html
\TYPO3\CMS\Core\Page\PageRenderer::loadExtCore:
- newFunctionCall: null
+ replacement: null
docsUrl: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.4/Breaking-68001-RemovedExtJSCoreAndExtJSAdapters.html
\TYPO3\CMS\Core\Page\PageRenderer::enableExtCoreDebug:
- newFunctionCall: null
+ replacement: null
docsUrl: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.4/Breaking-68001-RemovedExtJSCoreAndExtJSAdapters.html
\TYPO3\CMS\Core\Page\PageRenderer::setExtCorePath:
- newFunctionCall: null
+ replacement: null
docsUrl: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.4/Breaking-68001-RemovedExtJSCoreAndExtJSAdapters.html
\TYPO3\CMS\Backend\Controller\EditDocumentController->functionMenus:
- newFunctionCall: null
+ replacement: null
docsUrl: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.4/Breaking-67753-DropSecondaryOptions.html
\TYPO3\CMS\Backend\Utility\BackendUtility::getFileIcon:
- newFunctionCall: 'Use \TYPO3\CMS\Backend\Utility\IconUtility::getSpriteIconForFile() insteadenableExtCoreDebug'
+ replacement: 'Use \TYPO3\CMS\Backend\Utility\IconUtility::getSpriteIconForFile() insteadenableExtCoreDebug'
docsUrl: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.4/Breaking-67654-RemoveGLOBALSFILEICONSFunctionality.html
\TYPO3\CMS\Frontend\Page\PageGenerator::getIncFiles:
- newFunctionCall: 'Use hooks during the Frontend set up to execute custom PHP code'
+ replacement: 'Use hooks during the Frontend set up to execute custom PHP code'
docsUrl: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.4/Breaking-67646-LibraryInclusionInFrontend.html
\TYPO3\CMS\Backend\Template\DocumentTemplate\DocumentTemplate->formWidthText:
- newFunctionCall: null
+ replacement: null
docsUrl: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.4/Breaking-67565-DeprecatedBackendRelatedMethodsRemoved.html
\TYPO3\CMS\Backend\View\PageLayoutView->getBackendLayoutConfiguration:
- newFunctionCall: null
+ replacement: null
docsUrl: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.4/Breaking-67565-DeprecatedBackendRelatedMethodsRemoved.html
\TYPO3\CMS\Backend\View\PageLayoutView->wordWrapper:
- newFunctionCall: null
+ replacement: null
docsUrl: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.4/Breaking-67565-DeprecatedBackendRelatedMethodsRemoved.html
\TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController->checkJumpUrlReferer:
- newFunctionCall: null
+ replacement: null
docsUrl: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.4/Breaking-66602-RemoveRefererCheckWhileHandlingJumpUrl.html
\TYPO3\CMS\Core\Utility\OpcodeCacheUtility::initialize:
- newFunctionCall: 'Use new service class instead \TYPO3\CMS\Core\Service\OpcodeCacheService'
+ replacement: 'Use new service class instead \TYPO3\CMS\Core\Service\OpcodeCacheService'
docsUrl: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.4/Breaking-63838-ChangedOpcodeCacheUtilityBeingAServiceClass.html
\TYPO3\CMS\Core\Utility\OpcodeCacheUtility::clearAllActive:
- newFunctionCall: 'Use new service class instead \TYPO3\CMS\Core\Service\OpcodeCacheService'
+ replacement: 'Use new service class instead \TYPO3\CMS\Core\Service\OpcodeCacheService'
docsUrl: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.4/Breaking-63838-ChangedOpcodeCacheUtilityBeingAServiceClass.html
\TYPO3\CMS\Core\Utility\OpcodeCacheUtility::getAllActive:
- newFunctionCall: 'Use new service class instead \TYPO3\CMS\Core\Service\OpcodeCacheService'
+ replacement: 'Use new service class instead \TYPO3\CMS\Core\Service\OpcodeCacheService'
docsUrl: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.4/Breaking-63838-ChangedOpcodeCacheUtilityBeingAServiceClass.html
\TYPO3\CMS\Backend\Tree\View\PagePositionMap->JSimgFunc:
- newFunctionCall: 'Use proper styling for a tree list'
+ replacement: 'Use proper styling for a tree list'
docsUrl: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.4/Breaking-56951-RemoveUnusedMethodsInPagePositionMap.html
\TYPO3\CMS\Backend\Tree\View\PagePositionMap->insertQuadLines:
- newFunctionCall: 'Use proper styling for a tree list'
+ replacement: 'Use proper styling for a tree list'
docsUrl: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.4/Breaking-56951-RemoveUnusedMethodsInPagePositionMap.html
\TYPO3\CMS\Core\Page\PageRenderer->enableExtJSQuickTips:
- newFunctionCall: 'Use bootstrap tooltips, which work out of the box as alternative. Simple add data-toggle="tooltip" and data-title="your tooltip" to any element you want'
+ replacement: 'Use bootstrap tooltips, which work out of the box as alternative. Simple add data-toggle="tooltip" and data-title="your tooltip" to any element you want'
docsUrl: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.4/Breaking-68276-RemoveExtJSQuicktipsIfPossible.html
\TYPO3\CMS\IndexedSearch\Indexer->removeLoginpagesWithContentHash:
- newFunctionCall: null
+ replacement: null
docsUrl: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.4/Breaking-68193-DropRemoveLoginpagesWithContentHashFromIndexerphp.html
\TYPO3\CMS\Frontend\Controller\ExtDirectEidController->actionIsAllowed:
- newFunctionCall: 'Migrate your eID scripts to the new PSR-7 compliant model'
+ replacement: 'Migrate your eID scripts to the new PSR-7 compliant model'
docsUrl: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.4/Breaking-68186-AdjustedAndRemovedMethodsInEIDArea.html
# NOTE: It does not make sense to warn about all render methods
# \TYPO3\CMS\Frontend\Controller\ExtDirectEidController->render:
- # newFunctionCall: 'Migrate your eID scripts to the new PSR-7 compliant model'
+ # replacement: 'Migrate your eID scripts to the new PSR-7 compliant model'
# docsUrl: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.4/Breaking-68186-AdjustedAndRemovedMethodsInEIDArea.html
\TYPO3\CMS\Frontend\Utility\EidUtility::isEidRequest:
- newFunctionCall: 'Migrate your eID scripts to the new PSR-7 compliant model'
+ replacement: 'Migrate your eID scripts to the new PSR-7 compliant model'
docsUrl: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.4/Breaking-68186-AdjustedAndRemovedMethodsInEIDArea.html
\TYPO3\CMS\Frontend\Utility\EidUtility::getEidScriptPath:
- newFunctionCall: 'Migrate your eID scripts to the new PSR-7 compliant model'
+ replacement: 'Migrate your eID scripts to the new PSR-7 compliant model'
docsUrl: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.4/Breaking-68186-AdjustedAndRemovedMethodsInEIDArea.html
\TYPO3\CMS\Backend\View\PageLayoutView->linkRTEbutton:
- newFunctionCall: null
+ replacement: null
docsUrl: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.4/Breaking-68020-DroppedDisableBigButtons.html
\TYPO3\CMS\Backend\View\PageLayoutView->isRTEforField:
- newFunctionCall: null
+ replacement: null
docsUrl: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.4/Breaking-68020-DroppedDisableBigButtons.html
\TYPO3\CMS\Backend\View\PageLayoutView->getSpecConfForField:
- newFunctionCall: null
+ replacement: null
docsUrl: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.4/Breaking-68020-DroppedDisableBigButtons.html
diff --git a/src/Standards/Typo3Update/Sniffs/LegacyClassnames/AbstractClassnameChecker.php b/src/Standards/Typo3Update/Sniffs/LegacyClassnames/AbstractClassnameChecker.php
index a13fe1528b54eb38e2e53fedb97ec641723ee0f5..bd472ccf326c688a415b3abae9a6582ce07f197d 100644
--- a/src/Standards/Typo3Update/Sniffs/LegacyClassnames/AbstractClassnameChecker.php
+++ b/src/Standards/Typo3Update/Sniffs/LegacyClassnames/AbstractClassnameChecker.php
@@ -24,15 +24,12 @@ use PHP_CodeSniffer as PhpCs;
use PHP_CodeSniffer_File as PhpCsFile;
use PHP_CodeSniffer_Sniff as PhpCsSniff;
use Typo3Update\Sniffs\LegacyClassnames\Mapping;
-use Typo3Update\Sniffs\OptionsAccessTrait;
/**
* Provide common uses for all sniffs, regarding class name checks.
*/
abstract class AbstractClassnameChecker implements PhpCsSniff
{
- use OptionsAccessTrait;
-
/**
* A list of extension names that might contain legacy class names.
* Used to check clas names for warnings.
diff --git a/src/Standards/Typo3Update/Sniffs/LegacyClassnames/Mapping.php b/src/Standards/Typo3Update/Sniffs/LegacyClassnames/Mapping.php
index 16a8acf0cfa9d736b7e914af82e580b752d30209..201263a5787fc4a87782459ea4623350a0e07bcb 100644
--- a/src/Standards/Typo3Update/Sniffs/LegacyClassnames/Mapping.php
+++ b/src/Standards/Typo3Update/Sniffs/LegacyClassnames/Mapping.php
@@ -20,7 +20,7 @@ namespace Typo3Update\Sniffs\LegacyClassnames;
* 02110-1301, USA.
*/
-use Typo3Update\Sniffs\OptionsAccessTrait;
+use Typo3Update\Sniffs\Options;
/**
* Singleton wrapper for mappings.
@@ -30,8 +30,6 @@ use Typo3Update\Sniffs\OptionsAccessTrait;
*/
final class Mapping
{
- use OptionsAccessTrait;
-
// Singleton implementation - Start
static protected $instance = null;
/**
@@ -55,7 +53,7 @@ final class Mapping
}
private function __construct()
{
- $this->mappings = require $this->getMappingFile();
+ $this->mappings = require Options::getMappingFile();
}
// Singleton implementation - End
@@ -116,7 +114,7 @@ final class Mapping
}
file_put_contents(
- $this->getMappingFile(),
+ Options::getMappingFile(),
'<?php' . PHP_EOL . 'return ' . var_export($this->mappings, true) . ';'
);
}
diff --git a/src/Standards/Typo3Update/Sniffs/LegacyClassnames/MissingNamespaceSniff.php b/src/Standards/Typo3Update/Sniffs/LegacyClassnames/MissingNamespaceSniff.php
index 3f8a19778a66d1fa53689b7ef938dcc9d474522e..e8d0feb08d04aff0a6f2f5e16e36ac5eb58c3c75 100644
--- a/src/Standards/Typo3Update/Sniffs/LegacyClassnames/MissingNamespaceSniff.php
+++ b/src/Standards/Typo3Update/Sniffs/LegacyClassnames/MissingNamespaceSniff.php
@@ -21,6 +21,7 @@
use PHP_CodeSniffer_File as PhpCsFile;
use Typo3Update\Sniffs\LegacyClassnames\AbstractClassnameChecker;
+use Typo3Update\Sniffs\Options;
/**
* Detect missing namespaces for class definitions.
@@ -153,7 +154,7 @@ class Typo3Update_Sniffs_LegacyClassnames_MissingNamespaceSniff extends Abstract
*/
protected function getNamespace($classname)
{
- $vendor = trim($this->getVendor(), '\\/');
+ $vendor = trim(Options::getVendor(), '\\/');
$classnameParts = explode('_', $classname);
unset($classnameParts[0]); // Remove Tx_
diff --git a/src/Standards/Typo3Update/Sniffs/LegacyClassnames/MissingVendorForPluginsAndModulesSniff.php b/src/Standards/Typo3Update/Sniffs/LegacyClassnames/MissingVendorForPluginsAndModulesSniff.php
index 3f2825f356b8449c9ed080287e56410445eee923..18869958bb45980b437dd1b260ff0a9b4bf9381a 100644
--- a/src/Standards/Typo3Update/Sniffs/LegacyClassnames/MissingVendorForPluginsAndModulesSniff.php
+++ b/src/Standards/Typo3Update/Sniffs/LegacyClassnames/MissingVendorForPluginsAndModulesSniff.php
@@ -22,6 +22,7 @@
use PHP_CodeSniffer_File as PhpCsFile;
use PHP_CodeSniffer_Sniff as PhpCsSniff;
use PHP_CodeSniffer_Tokens as Tokens;
+use Typo3Update\Sniffs\Options;
/**
* Detect whether vendor is missing for plugins and modules registrations and configurations.
@@ -29,7 +30,6 @@ use PHP_CodeSniffer_Tokens as Tokens;
class Typo3Update_Sniffs_LegacyClassnames_MissingVendorForPluginsAndModulesSniff implements PhpCsSniff
{
use \Typo3Update\Sniffs\ExtendedPhpCsSupportTrait;
- use \Typo3Update\Sniffs\OptionsAccessTrait;
/**
* Returns the token types that this sniff is interested in.
@@ -72,13 +72,13 @@ class Typo3Update_Sniffs_LegacyClassnames_MissingVendorForPluginsAndModulesSniff
. ' Add vendor before Extensionkey like: "%s." . $_EXTKEY',
$firstArgument,
'missingVendor',
- [$this->getVendor()]
+ [Options::getVendor()]
);
if ($fix === true) {
$phpcsFile->fixer->replaceToken(
$firstArgument,
- "'{$this->getVendor()}.' . {$tokens[$firstArgument]['content']}"
+ "'{Options::getVendor()}.' . {$tokens[$firstArgument]['content']}"
);
}
}
diff --git a/src/Standards/Typo3Update/Sniffs/Options.php b/src/Standards/Typo3Update/Sniffs/Options.php
new file mode 100644
index 0000000000000000000000000000000000000000..c6b5ba7c9fb72ebadd96c97173bc7064d795f80a
--- /dev/null
+++ b/src/Standards/Typo3Update/Sniffs/Options.php
@@ -0,0 +1,124 @@
+<?php
+namespace Typo3Update\Sniffs;
+
+/*
+ * 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 as PhpCs;
+
+/**
+ * Wrapper to retrieve options from PhpCs with defaults.
+ */
+class Options
+{
+ /**
+ * Returns the configured vendor, e.g. to generate new namespaces.
+ *
+ * @return string
+ */
+ public static function getVendor()
+ {
+ $vendor = static::getOptionWithDefault(
+ 'vendor',
+ 'YourCompany'
+ );
+
+ return trim($vendor, '\\/');
+ }
+
+ /**
+ * Returns the configured file path containing the mappings for classes, interfaced and traits.
+ *
+ * @return string
+ */
+ public static function getMappingFile()
+ {
+ return (string) static::getOptionWithDefault(
+ 'mappingFile',
+ __DIR__ . '/../../../../LegacyClassnames.php'
+ );
+ }
+
+ /**
+ * Returns an array of absolute file names containing removed function configurations.
+ *
+ * @return array<string>
+ */
+ public static function getRemovedFunctionConfigFiles()
+ {
+ return static::getOptionFileNames(
+ 'removedFunctionConfigFiles',
+ __DIR__ . '/../Configuration/Removed/Functions/*.yaml'
+ );
+ }
+
+ /**
+ * Returns an array of absolute file names containing removed constant configurations.
+ *
+ * @return array<string>
+ */
+ public static function getRemovedConstantConfigFiles()
+ {
+ return static::getOptionFileNames(
+ 'removedConstantConfigFiles',
+ __DIR__ . '/../Configuration/Removed/Constants/*.yaml'
+ );
+ }
+
+ /**
+ * Get the option by optionName, if not defined, use default.
+ *
+ * @param string $optionName
+ * @param mixed $default
+ *
+ * @return mixed
+ */
+ private static function getOptionWithDefault($optionName, $default)
+ {
+ $option = PhpCs::getConfigData($optionName);
+ if (!$option) {
+ $option = $default;
+ }
+
+ return $option;
+ }
+
+ /**
+ * Get file names defined by option using optionName, if not defined, use default.
+ *
+ * TODO: Multiple files allowed, using glob ...
+ * to allow splitting per ext (extbase, fluid, ...) and TYPO3 Version 7.1, 7.0, ...
+ *
+ * @param string $optionName
+ * @param mixed $default
+ *
+ * @return array<string>
+ */
+ protected static function getOptionFileNames($optionName, $default)
+ {
+ $files = static::getOptionWithDefault($optionName, $default);
+ $fileNames = [];
+
+ foreach ((new \GlobIterator($files)) as $file) {
+ $fileNames[] = (string) $file;
+ }
+
+ return $fileNames;
+ }
+}
diff --git a/src/Standards/Typo3Update/Sniffs/OptionsAccessTrait.php b/src/Standards/Typo3Update/Sniffs/OptionsAccessTrait.php
deleted file mode 100644
index 99204672c2be33f2ec888013f61caf714358e766..0000000000000000000000000000000000000000
--- a/src/Standards/Typo3Update/Sniffs/OptionsAccessTrait.php
+++ /dev/null
@@ -1,74 +0,0 @@
-<?php
-namespace Typo3Update\Sniffs;
-
-/*
- * 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 as PhpCs;
-
-/**
- * Wrapper to retrieve options from PhpCs with defaults.
- */
-trait OptionsAccessTrait
-{
- /**
- * Returns the configured vendor, e.g. to generate new namespaces.
- *
- * @return string
- */
- public function getVendor()
- {
- $vendor = PhpCs::getConfigData('vendor');
- if (!$vendor) {
- $vendor = 'YourCompany';
- }
- return trim($vendor, '\\/');
- }
-
- /**
- * Returns the configured file path containing the mappings for classes, interfaced and traits.
- *
- * @return string
- */
- public function getMappingFile()
- {
- $mappingFile = PhpCs::getConfigData('mappingFile');
- if (!$mappingFile) {
- $mappingFile = __DIR__ . '/../../../../LegacyClassnames.php';
- }
- return $mappingFile;
- }
-
- /**
- * Returns an array of absolute file names containing removed function configurations.
- *
- * @return \Generator
- */
- public function getRemovedFunctionConfigFiles()
- {
- $configFiles = PhpCs::getConfigData('removedFunctionConfigFiles');
- if (!$configFiles) {
- $configFiles = __DIR__ . '/../Configuration/Removed/Functions/*.yaml';
- }
-
- foreach ((new \GlobIterator($configFiles)) as $file) {
- yield (string) $file;
- }
- }
-}
diff --git a/src/Standards/Typo3Update/Sniffs/Removed/AbstractGenericUsage.php b/src/Standards/Typo3Update/Sniffs/Removed/AbstractGenericUsage.php
new file mode 100644
index 0000000000000000000000000000000000000000..766db3405b79388ae114b7c02baf31c6c366a04b
--- /dev/null
+++ b/src/Standards/Typo3Update/Sniffs/Removed/AbstractGenericUsage.php
@@ -0,0 +1,293 @@
+<?php
+namespace Typo3Update\Sniffs\Removed;
+
+/*
+ * 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 PHP_CodeSniffer_Sniff as PhpCsSniff;
+use PHP_CodeSniffer_Tokens as Tokens;
+use Symfony\Component\Yaml\Yaml;
+use Typo3Update\Sniffs\Options;
+
+/**
+ * Contains common functionality for removed code like constants or functions.
+ *
+ * Removed parts are configured using YAML-Files, for examples see src/Standards/Typo3Update/Configuration/Removed/Constants/7.0.yaml
+ * Also check out the configuration options in Readme.rst.
+ */
+abstract class AbstractGenericUsage implements PhpCsSniff
+{
+ use \Typo3Update\Sniffs\ExtendedPhpCsSupportTrait;
+
+ /**
+ * Configuration to define removed code.
+ *
+ * @var array
+ */
+ protected $configured = [];
+
+ /**
+ * Constant for the current sniff instance.
+ * @var array
+ */
+ protected $removed = [];
+
+ public function __construct()
+ {
+ if ($this->configured === []) {
+ foreach ($this->getRemovedConfigFiles() as $file) {
+ $this->configured = array_merge(
+ $this->configured,
+ $this->prepareStructure(Yaml::parse(file_get_contents((string) $file)))
+ );
+ }
+ }
+ }
+
+ /**
+ * Return file names containing removed configurations.
+ *
+ * @return array<string>
+ */
+ abstract protected function getRemovedConfigFiles();
+
+ /**
+ * Prepares structure from config for later usage.
+ *
+ * @param array $typo3Versions
+ * @return array
+ */
+ protected function prepareStructure(array $typo3Versions)
+ {
+ $newStructure = [];
+
+ foreach ($typo3Versions as $typo3Version => $removals) {
+ foreach ($removals as $removed => $config) {
+ // Split static methods and methods.
+ $split = preg_split('/::|->/', $removed);
+
+ $newStructure[$removed] = $config;
+
+ $newStructure[$removed]['static'] = strpos($removed, '::') !== false;
+ $newStructure[$removed]['fqcn'] = null;
+ $newStructure[$removed]['class'] = null;
+ $newStructure[$removed]['name'] = $split[0];
+ $newStructure[$removed]['version_removed'] = $typo3Version;
+
+ // If split contains two parts, it's a class
+ if (isset($split[1])) {
+ $newStructure[$removed]['fqcn'] = $split[0];
+ $newStructure[$removed]['class'] = array_slice(
+ explode('\\', $newStructure[$removed]['fqcn']),
+ -1
+ )[0];
+ $newStructure[$removed]['name'] = $split[1];
+ }
+ };
+ }
+
+ return $newStructure;
+ }
+
+ /**
+ * Processes the tokens that this sniff is interested in.
+ *
+ * This is the default implementation, as most of the time next T_STRING is
+ * the class name. This way only the register method has to be registered
+ * in default cases.
+ *
+ * @param PhpCsFile $phpcsFile The file where the token was found.
+ * @param int $stackPtr The position in the stack where
+ * the token was found.
+ *
+ * @return void
+ */
+ public function process(PhpCsFile $phpcsFile, $stackPtr)
+ {
+ if (!$this->isRemoved($phpcsFile, $stackPtr)) {
+ return;
+ }
+
+ $this->addMessage($phpcsFile, $stackPtr);
+ }
+
+ /**
+ * Check whether the current token is removed.
+ *
+ * @param PhpCsFile $phpcsFile
+ * @param int $stackPtr
+ * @return bool
+ */
+ protected function isRemoved(PhpCsFile $phpcsFile, $stackPtr)
+ {
+ $tokens = $phpcsFile->getTokens();
+ $staticPosition = $phpcsFile->findPrevious(T_WHITESPACE, $stackPtr - 1, null, true, null, true);
+
+ $name = $tokens[$stackPtr]['content'];
+ $isStatic = false;
+ $class = false;
+
+ if ($staticPosition !== false) {
+ $isStatic = $tokens[$staticPosition]['code'] === T_DOUBLE_COLON;
+ }
+
+ if ($isStatic) {
+ $class = $phpcsFile->findPrevious(T_STRING, $staticPosition, null, false, null, true);
+ if ($class !== false) {
+ $class = $tokens[$class]['content'];
+ }
+ }
+
+ $this->removed = $this->getMatchingRemoved($name, $class, $isStatic);
+ return $this->removed !== [];
+ }
+
+ /**
+ * Returns all matching removed functions for given arguments.
+ *
+ * @param string $name
+ * @param string $className The last part of the class name, splitted by namespaces.
+ * @param bool $isStatic
+ *
+ * @return array
+ */
+ protected function getMatchingRemoved($name, $className, $isStatic)
+ {
+ // We will not match any static calls, without the class name, at least for now.
+ if ($isStatic === true && $className === false) {
+ return [];
+ }
+
+ return array_filter(
+ $this->configured,
+ function ($config) use ($name, $isStatic, $className) {
+ return $name === $config['name']
+ && $isStatic === $config['static']
+ && (
+ $className === $config['class']
+ || $className === false
+ )
+ ;
+ }
+ );
+ }
+
+ /**
+ * Add message for the given token position.
+ *
+ * Default is a warning, non fixable. Just overwrite in concrete sniff, if
+ * something different suites better.
+ *
+ * @param PhpCsFile $phpcsFile
+ * @param int $tokenPosition
+ *
+ * @return void
+ */
+ protected function addMessage(PhpCsFile $phpcsFile, $tokenPosition)
+ {
+ foreach ($this->removed as $constant) {
+ $phpcsFile->addWarning(
+ 'Legacy calls are not allowed; found %s. Removed in %s. %s. See: %s',
+ $tokenPosition,
+ $this->getIdentifier($constant),
+ [
+ $this->getOldUsage($constant),
+ $this->getRemovedVersion($constant),
+ $this->getReplacement($constant),
+ $this->getDocsUrl($constant),
+ ]
+ );
+ }
+ }
+
+ /**
+ * Identifier for configuring this specific error / warning through PHPCS.
+ *
+ * @param array $config
+ *
+ * @return string
+ */
+ protected function getIdentifier(array $config)
+ {
+ $name = $config['name'];
+ if ($config['class']) {
+ $name = $config['class'] . '.' . $name;
+ }
+
+ return $name;
+ }
+
+ /**
+ * The original call, to allow user to check matches.
+ *
+ * As we match the name, that can be provided by multiple classes, you
+ * should provide an example, so users can check that this is the legacy
+ * one.
+ *
+ * @param array $config
+ *
+ * @return string
+ */
+ abstract protected function getOldUsage(array $config);
+
+ /**
+ * Returns TYPO3 version when the breaking change happened.
+ *
+ * To let user decide whether this is important for him.
+ *
+ * @param array $config
+ *
+ * @return string
+ */
+ protected function getRemovedVersion(array $config)
+ {
+ return $config['version_removed'];
+ }
+
+ /**
+ * The new call, or information how to migrate.
+ *
+ * To provide feedback for user to ease migration.
+ *
+ * @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';
+ }
+
+ /**
+ * Allow user to lookup the official docs related to this deprecation / breaking change.
+ *
+ * @param array $config The converted structure for a single constant.
+ *
+ * @return string
+ */
+ protected function getDocsUrl(array $config)
+ {
+ return $config['docsUrl'];
+ }
+}
diff --git a/src/Standards/Typo3Update/Sniffs/Removed/GenericConstantUsageSniff.php b/src/Standards/Typo3Update/Sniffs/Removed/GenericConstantUsageSniff.php
new file mode 100644
index 0000000000000000000000000000000000000000..e99a226e49727bb2d686c5d664b12a9bdbc10f34
--- /dev/null
+++ b/src/Standards/Typo3Update/Sniffs/Removed/GenericConstantUsageSniff.php
@@ -0,0 +1,67 @@
+<?php
+
+/*
+ * 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\Sniffs\Removed\AbstractGenericUsage;
+use Typo3Update\Sniffs\Options;
+
+/**
+ * Sniff that handles all calls to removed constants.
+ */
+class Typo3Update_Sniffs_Removed_GenericConstantUsageSniff extends AbstractGenericUsage
+{
+ /**
+ * Return file names containing removed configurations.
+ *
+ * @return array<string>
+ */
+ protected function getRemovedConfigFiles()
+ {
+ return Options::getRemovedConstantConfigFiles();
+ }
+
+ /**
+ * Returns the token types that this sniff is interested in.
+ *
+ * @return array<int>
+ */
+ public function register()
+ {
+ return [T_STRING];
+ }
+
+ /**
+ * The original constant call, to allow user to check matches.
+ *
+ * @param array $config
+ *
+ * @return string
+ */
+ protected function getOldUsage(array $config)
+ {
+ $old = $config['name'];
+ if ($config['static']) {
+ $old = $config['fqcn'] . '::' . $config['name'];
+ }
+
+ return 'constant ' . $old;
+ }
+}
diff --git a/src/Standards/Typo3Update/Sniffs/Removed/GenericFunctionCallSniff.php b/src/Standards/Typo3Update/Sniffs/Removed/GenericFunctionCallSniff.php
index b81ff7d22f112b875964afc99e5d9cc828ecd55a..7f8b730bb0d68c3e7242ecd12e79a7eeb1150a4c 100644
--- a/src/Standards/Typo3Update/Sniffs/Removed/GenericFunctionCallSniff.php
+++ b/src/Standards/Typo3Update/Sniffs/Removed/GenericFunctionCallSniff.php
@@ -20,86 +20,23 @@
*/
use PHP_CodeSniffer_File as PhpCsFile;
-use PHP_CodeSniffer_Sniff as PhpCsSniff;
use PHP_CodeSniffer_Tokens as Tokens;
-use Symfony\Component\Yaml\Yaml;
+use Typo3Update\Sniffs\Removed\AbstractGenericUsage;
+use Typo3Update\Sniffs\Options;
/**
* Sniff that handles all calls to removed functions.
- *
- * Removed functions are configured using YAML-Files, for examples see src/Standards/Typo3Update/Configuration/Removed/Functions/7.0.yaml
- * Also check out the configuration options in Readme.rst.
*/
-class Typo3Update_Sniffs_Removed_GenericFunctionCallSniff implements PhpCsSniff
+class Typo3Update_Sniffs_Removed_GenericFunctionCallSniff extends AbstractGenericUsage
{
- use \Typo3Update\Sniffs\ExtendedPhpCsSupportTrait;
- use \Typo3Update\Sniffs\OptionsAccessTrait;
-
- /**
- * Configuration to define removed functions.
- *
- * @var array
- */
- protected static $configuredFunctions = [];
-
- /**
- * Function for the current sniff instance.
- * @var array
- */
- private $removedFunctions = [];
-
- /**
- * TODO: Multiple files allowed, using glob ...
- * to allow splitting per ext (extbase, fluid, ...) and TYPO3 Version 7.1, 7.0, ...
- */
- public function __construct()
- {
- if (static::$configuredFunctions === []) {
- foreach ($this->getRemovedFunctionConfigFiles() as $file) {
- static::$configuredFunctions = array_merge(
- static::$configuredFunctions,
- $this->prepareStructure(Yaml::parse(file_get_contents((string) $file)))
- );
- }
- }
- }
-
/**
- * Prepares structure from config for later usage.
+ * Return file names containing removed configurations.
*
- * @param array $typo3Versions
- * @return array
+ * @return array<string>
*/
- protected function prepareStructure(array $typo3Versions)
+ protected function getRemovedConfigFiles()
{
- $newStructure = [];
-
- foreach ($typo3Versions as $typo3Version => $functions) {
- foreach ($functions as $function => $config) {
- // Split static methods and methods.
- $split = preg_split('/::|->/', $function);
-
- $newStructure[$function] = $config;
-
- $newStructure[$function]['static'] = strpos($function, '::') !== false;
- $newStructure[$function]['fqcn'] = null;
- $newStructure[$function]['class'] = null;
- $newStructure[$function]['function'] = $split[0];
- $newStructure[$function]['version_removed'] = $typo3Version;
-
- // If split contains two parts, it's a class with method
- if (isset($split[1])) {
- $newStructure[$function]['fqcn'] = $split[0];
- $newStructure[$function]['class'] = array_slice(
- explode('\\', $newStructure[$function]['fqcn']),
- -1
- )[0];
- $newStructure[$function]['function'] = $split[1];
- }
- };
- }
-
- return $newStructure;
+ return Options::getRemovedFunctionConfigFiles();
}
/**
@@ -112,127 +49,18 @@ class Typo3Update_Sniffs_Removed_GenericFunctionCallSniff implements PhpCsSniff
return Tokens::$functionNameTokens;
}
- /**
- * Processes the tokens that this sniff is interested in.
- *
- * This is the default implementation, as most of the time next T_STRING is
- * the class name. This way only the register method has to be registered
- * in default cases.
- *
- * @param PhpCsFile $phpcsFile The file where the token was found.
- * @param int $stackPtr The position in the stack where
- * the token was found.
- *
- * @return void
- */
- public function process(PhpCsFile $phpcsFile, $stackPtr)
- {
- if (!$this->isFunctionCallRemoved($phpcsFile, $stackPtr)) {
- return;
- }
-
- $this->addWarning($phpcsFile, $stackPtr);
- }
-
/**
* Check whether function at given point is removed.
*
* @return bool
*/
- protected function isFunctionCallRemoved(PhpCsFile $phpcsFile, $stackPtr)
+ protected function isRemoved(PhpCsFile $phpcsFile, $stackPtr)
{
if (!$this->isFunctionCall($phpcsFile, $stackPtr)) {
return false;
}
- $tokens = $phpcsFile->getTokens();
- $staticPosition = $phpcsFile->findPrevious(T_WHITESPACE, $stackPtr - 1, null, true, null, true);
-
- $functionName = $tokens[$stackPtr]['content'];
- $isStatic = false;
- $class = false;
-
- if ($staticPosition !== false) {
- $isStatic = $tokens[$staticPosition]['code'] === T_DOUBLE_COLON;
- }
-
- if ($isStatic) {
- $class = $phpcsFile->findPrevious(T_STRING, $staticPosition, null, false, null, true);
- if ($class !== false) {
- $class = $tokens[$class]['content'];
- }
- }
-
- $this->removedFunctions = $this->getMatchingRemovedFunctions($functionName, $class, $isStatic);
- return $this->removedFunctions !== [];
- }
-
- /**
- * Returns all matching removed functions for given arguments.
- *
- * @param string $functionName
- * @param string $className The last part of the class name, splitted by namespaces.
- * @param bool $isStatic
- *
- * @return void
- */
- protected function getMatchingRemovedFunctions($functionName, $className, $isStatic)
- {
- // We will not match any static method, without the class name, at least for now.
- // Otherwise we could handle them the same way as instance methods.
- if ($isStatic === true && $className === false) {
- return;
- }
-
- return array_filter(
- static::$configuredFunctions,
- function ($config) use ($functionName, $isStatic, $className) {
- return $functionName === $config['function']
- && $isStatic === $config['static']
- && (
- $className === $config['class']
- || $className === false
- )
- ;
- }
- );
- }
-
- /**
- * Add warning for the given token position.
- *
- * @param PhpCsFile $phpcsFile
- * @param int $tokenPosition
- *
- * @return void
- */
- protected function addWarning(PhpCsFile $phpcsFile, $tokenPosition)
- {
- foreach ($this->removedFunctions as $function) {
- $phpcsFile->addWarning(
- 'Legacy function calls are not allowed; found %s. Removed in %s. %s. See: %s',
- $tokenPosition,
- $this->getFunctionIdentifier($function),
- [
- $this->getOldfunctionCall($function),
- $this->getRemovedVersion($function),
- $this->getNewFunctionCall($function),
- $this->getDocsUrl($function),
- ]
- );
- }
- }
-
- /**
- * Identifier for configuring this specific error / warning through PHPCS.
- *
- * @param array $config The converted structure for a single function.
- *
- * @return string
- */
- protected function getFunctionIdentifier(array $config)
- {
- return $config['class'] . '.' . $config['function'];
+ return parent::isRemoved($phpcsFile, $stackPtr);
}
/**
@@ -246,56 +74,12 @@ class Typo3Update_Sniffs_Removed_GenericFunctionCallSniff implements PhpCsSniff
*
* @return string
*/
- protected function getOldFunctionCall(array $config)
+ protected function getOldUsage(array $config)
{
$concat = '->';
if ($config['static']) {
$concat = '::';
}
- return $config['fqcn'] . $concat . $config['function'];
- }
-
- /**
- * Returns TYPO3 version when the current function was removed.
- *
- * To let user decide whether this is important for him.
- *
- * @param array $config The converted structure for a single function.
- *
- * @return string
- */
- protected function getRemovedVersion(array $config)
- {
- return $config['version_removed'];
- }
-
- /**
- * The new function call, or information how to migrate.
- *
- * To provide feedback for user to ease migration.
- *
- * @param array $config The converted structure for a single function.
- *
- * @return string
- */
- protected function getNewFunctionCall(array $config)
- {
- $newCall = $config['newFunctionCall'];
- if ($newCall !== null) {
- return $newCall;
- }
- return 'There is no replacement, just remove call';
- }
-
- /**
- * Allow user to lookup the official docs related to this deprecation / breaking change.
- *
- * @param array $config The converted structure for a single function.
- *
- * @return string
- */
- protected function getDocsUrl(array $config)
- {
- return $config['docsUrl'];
+ return $config['fqcn'] . $concat . $config['name'];
}
}