diff --git a/Readme.rst b/Readme.rst
index a7a1243..e87a3a8 100644
--- a/Readme.rst
+++ b/Readme.rst
@@ -100,6 +100,14 @@ Also we check for the following deprecated calls:
- Check for ``create`` on ``ObjectManager``, which is "stupid" just all ``create`` calls are marked
with a warning.
+Beside the features above which are covered by ``phpcs`` and phpcbf``, the following linting is also
+available to generate a report of possible issues and during coding through ``phpcs``:
+
+- Check for usage of removed functions.
+ The functions are configured via yaml files. The location of them is configurable, default is
+ inside the standard itself, and we try to deliver all information.
+ For configuration options see ``removedFunctionConfigFiles``.
+
What does it look like?
=======================
@@ -194,3 +202,21 @@ Example:
.. code:: bash
--runtime-set vendor YourVendor
+
+``removedFunctionConfigFiles``
+ Configure your vendor through ``ruleset.xml`` or using ``--runtime-set``. Default is
+ ``Configuration/Removed/Functions/*.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
+
+
+
+Example:
+
+.. code:: bash
+
+ --runtime-set removedFunctionConfigFiles "/Some/Absolute/Path/*.yaml"
diff --git a/composer.json b/composer.json
index 4f488fb..2a3c23e 100644
--- a/composer.json
+++ b/composer.json
@@ -8,7 +8,8 @@
}
},
"require": {
- "squizlabs/php_codesniffer": "2.8.*"
+ "squizlabs/php_codesniffer": "2.8.*",
+ "symfony/yaml": "3.2.*"
},
"license": "GPL-2.0+",
"authors": [
diff --git a/src/Standards/Typo3Update/Configuration/Removed/Functions/7.0.yaml b/src/Standards/Typo3Update/Configuration/Removed/Functions/7.0.yaml
new file mode 100644
index 0000000..3913b8c
--- /dev/null
+++ b/src/Standards/Typo3Update/Configuration/Removed/Functions/7.0.yaml
@@ -0,0 +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
+ 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'
+ 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'
+ 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'
+ 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'
+ docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-61783-RemoveDeprecatedMailFunctionality.html'
+ \TYPO3\CMS\Frontend\Utility\EidUtility::connectDB:
+ newFunctionCall: 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()'
+ 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()'
+ docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-61822-GetUniqueFieldsFunctionRemoved.html'
+ \TYPO3\CMS\Core\Utility\PhpOptionsUtility::isSafeModeEnabled:
+ newFunctionCall: null
+ docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-61820-PhpOptionsUtilityDeprecatedFunctionsRemoved.html'
+ \TYPO3\CMS\Core\Utility\PhpOptionsUtility::isMagicQuotesGpcEnabled:
+ newFunctionCall: null
+ docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-61820-PhpOptionsUtilityDeprecatedFunctionsRemoved.html'
+ \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::isLocalconfWritable:
+ newFunctionCall: 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'
+ 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'
+ 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'
+ 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'
+ 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'
+ 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'
+ 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'
+ docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62670-DeprecatedCodeRemovalInMultipleSysexts.html'
+ \TYPO3\CMS\Frontend\ContentObjec\ContentObjectRenderer->joinTSarrays:
+ newFunctionCall: 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'
+ docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62670-DeprecatedCodeRemovalInMultipleSysexts.html'
+ \TYPO3\CMS\Recordlist\Browser\ElementBrowser->isWebFolder:
+ newFunctionCall: null
+ docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62670-DeprecatedCodeRemovalInMultipleSysexts.html'
+ \TYPO3\CMS\Recordlist\Browser\ElementBrowser->checkFolder:
+ newFunctionCall: null
+ docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62670-DeprecatedCodeRemovalInMultipleSysexts.html'
+ \TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList->getTreeObject:
+ newFunctionCall: null
+ docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62670-DeprecatedCodeRemovalInMultipleSysexts.html'
+ \TYPO3\CMS\Filelist\FileList->dirData:
+ newFunctionCall: 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'
+ 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'
+ 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'
+ docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62670-DeprecatedCodeRemovalInMultipleSysexts.html'
+ \TYPO3\CMS\Lowlevel\View\DatabaseIntegrityView->func_filesearch:
+ newFunctionCall: null
+ docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62670-DeprecatedCodeRemovalInMultipleSysexts.html'
+ \TYPO3\CMS\Lowlevel\View\DatabaseIntegrityView->findFile:
+ newFunctionCall: null
+ docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62670-DeprecatedCodeRemovalInMultipleSysexts.html'
+ \TYPO3\CMS\Rtehtmlarea\RteHtmlAreaBase->buildStyleSheet:
+ newFunctionCall: null
+ docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62670-DeprecatedCodeRemovalInMultipleSysexts.html'
+ \TYPO3\CMS\Rtehtmlarea\RteHtmlAreaBase->loremIpsumInsert:
+ newFunctionCall: null
+ docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62670-DeprecatedCodeRemovalInMultipleSysexts.html'
+ \TYPO3\CMS\Workspaces\Service\StagesService->checkCustomStagingForWS:
+ newFunctionCall: 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'
+ 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'
+ 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'
+ 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'
+ 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'
+ # docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62416-DeprecatedCodeRemovalInCoreSysext.html'
+ \TYPO3\CMS\Core\Category\CategoryRegistry->applyTca:
+ newFunctionCall: 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
+ # docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62416-DeprecatedCodeRemovalInCoreSysext.html'
+ \TYPO3\CMS\Core\Resource\FileRepository->addToIndex:
+ newFunctionCall: 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'
+ 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'
+ 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'
+ 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'
+ # 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'
+ 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'
+ 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'
+ 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'
+ 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'
+ 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()"
+ 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()"
+ 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'
+ docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62416-DeprecatedCodeRemovalInCoreSysext.html'
+ \TYPO3\CMS\Core\Utility\File\BasicFileUtility->blindPath:
+ newFunctionCall: 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
+ docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62416-DeprecatedCodeRemovalInCoreSysext.html'
+ \TYPO3\CMS\Core\Utility\File\BasicFileUtility->rmDoubleSlash:
+ newFunctionCall: 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'
+ 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'
+ 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'
+ 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'
+ 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"
+ 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"
+ docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62416-DeprecatedCodeRemovalInCoreSysext.html'
+ \TYPO3\CMS\Core\Localization\Locales->getTerLocales:
+ newFunctionCall: null
+ docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62416-DeprecatedCodeRemovalInCoreSysext.html'
+ \TYPO3\CMS\Core\Localization\Locales->getTerLocaleDependencies:
+ newFunctionCall: null
+ docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62416-DeprecatedCodeRemovalInCoreSysext.html'
+ \TYPO3\CMS\Core\Localization\Locales->convertToTerLocales:
+ newFunctionCall: null
+ docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62416-DeprecatedCodeRemovalInCoreSysext.html'
+ \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::getInsertionNeedles:
+ newFunctionCall: null
+ docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62416-DeprecatedCodeRemovalInCoreSysext.html'
+ \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::insertModuleFunction:
+ newFunctionCall: null
+ docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62416-DeprecatedCodeRemovalInCoreSysext.html'
+ \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::getRequiredExtensionListArray:
+ newFunctionCall: null
+ docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62416-DeprecatedCodeRemovalInCoreSysext.html'
+ \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::writeNewExtensionList:
+ newFunctionCall: null
+ docsUrl: 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.0/Breaking-62416-DeprecatedCodeRemovalInCoreSysext.html'
+ \TYPO3\CMS\Core\Utility\PhpOptionsUtility::isSqlSafeModeEnabled:
+ newFunctionCall: 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'
+ 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.1.yaml b/src/Standards/Typo3Update/Configuration/Removed/Functions/7.1.yaml
new file mode 100644
index 0000000..f1184a1
--- /dev/null
+++ b/src/Standards/Typo3Update/Configuration/Removed/Functions/7.1.yaml
@@ -0,0 +1,4 @@
+# Breaking changes in 7.1: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.1/Index.html
+# Nothing in here? Right, there were no breaking changes to functions in this version.
+# We keep this file to let you know we didn't forget anything.
+'7.1': []
diff --git a/src/Standards/Typo3Update/Configuration/Removed/Functions/7.2.yaml b/src/Standards/Typo3Update/Configuration/Removed/Functions/7.2.yaml
new file mode 100644
index 0000000..d1cb239
--- /dev/null
+++ b/src/Standards/Typo3Update/Configuration/Removed/Functions/7.2.yaml
@@ -0,0 +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'
+ 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'
+ 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'
+ 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'
+ 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'
+ 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'
+ 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'
+ 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'
+ 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'
+ 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'
+ 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'
+# 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
new file mode 100644
index 0000000..15ff9b8
--- /dev/null
+++ b/src/Standards/Typo3Update/Configuration/Removed/Functions/7.3.yaml
@@ -0,0 +1,13 @@
+# Breaking changes in 7.3: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.3/Index.html#breaking-changes
+'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.'
+ docsUrl: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.3/Breaking-67402-ExtbaseAbstractDomainObjectInitializeObject.html
+ \TYPO3\CMS\Extbase\Persistence\Repository::replace:
+ newFunctionCall: 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
+ 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
new file mode 100644
index 0000000..ee9bbd5
--- /dev/null
+++ b/src/Standards/Typo3Update/Configuration/Removed/Functions/7.4.yaml
@@ -0,0 +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
+ docsUrl: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.4/Breaking-68001-RemovedExtJSCoreAndExtJSAdapters.html
+ \TYPO3\CMS\Core\Page\PageRenderer::getExtCorePath:
+ newFunctionCall: null
+ docsUrl: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.4/Breaking-68001-RemovedExtJSCoreAndExtJSAdapters.html
+ \TYPO3\CMS\Core\Page\PageRenderer::loadExtCore:
+ newFunctionCall: null
+ docsUrl: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.4/Breaking-68001-RemovedExtJSCoreAndExtJSAdapters.html
+ \TYPO3\CMS\Core\Page\PageRenderer::enableExtCoreDebug:
+ newFunctionCall: null
+ docsUrl: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.4/Breaking-68001-RemovedExtJSCoreAndExtJSAdapters.html
+ \TYPO3\CMS\Core\Page\PageRenderer::setExtCorePath:
+ newFunctionCall: null
+ docsUrl: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.4/Breaking-68001-RemovedExtJSCoreAndExtJSAdapters.html
+ \TYPO3\CMS\Backend\Controller\EditDocumentController->functionMenus:
+ newFunctionCall: 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'
+ 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'
+ docsUrl: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.4/Breaking-67646-LibraryInclusionInFrontend.html
+ \TYPO3\CMS\Backend\Template\DocumentTemplate\DocumentTemplate->formWidthText:
+ newFunctionCall: null
+ docsUrl: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.4/Breaking-67565-DeprecatedBackendRelatedMethodsRemoved.html
+ \TYPO3\CMS\Backend\View\PageLayoutView->getBackendLayoutConfiguration:
+ newFunctionCall: null
+ docsUrl: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.4/Breaking-67565-DeprecatedBackendRelatedMethodsRemoved.html
+ \TYPO3\CMS\Backend\View\PageLayoutView->wordWrapper:
+ newFunctionCall: null
+ docsUrl: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.4/Breaking-67565-DeprecatedBackendRelatedMethodsRemoved.html
+ \TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController->checkJumpUrlReferer:
+ newFunctionCall: 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'
+ 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'
+ 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'
+ 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'
+ 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'
+ 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'
+ docsUrl: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.4/Breaking-68276-RemoveExtJSQuicktipsIfPossible.html
+ \TYPO3\CMS\IndexedSearch\Indexer->removeLoginpagesWithContentHash:
+ newFunctionCall: 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'
+ 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'
+ # 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'
+ 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'
+ docsUrl: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.4/Breaking-68186-AdjustedAndRemovedMethodsInEIDArea.html
+ \TYPO3\CMS\Backend\View\PageLayoutView->linkRTEbutton:
+ newFunctionCall: null
+ docsUrl: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.4/Breaking-68020-DroppedDisableBigButtons.html
+ \TYPO3\CMS\Backend\View\PageLayoutView->isRTEforField:
+ newFunctionCall: null
+ docsUrl: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.4/Breaking-68020-DroppedDisableBigButtons.html
+ \TYPO3\CMS\Backend\View\PageLayoutView->getSpecConfForField:
+ newFunctionCall: null
+ docsUrl: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.4/Breaking-68020-DroppedDisableBigButtons.html
diff --git a/src/Standards/Typo3Update/Configuration/Removed/Functions/7.5.yaml b/src/Standards/Typo3Update/Configuration/Removed/Functions/7.5.yaml
new file mode 100644
index 0000000..a8e1483
--- /dev/null
+++ b/src/Standards/Typo3Update/Configuration/Removed/Functions/7.5.yaml
@@ -0,0 +1,2 @@
+# Breaking changes in 7.5: https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.5/Index.html#breaking-changes
+'7.5': []
diff --git a/src/Standards/Typo3Update/Sniffs/Deprecated/AjaxRegistrationSniff.php b/src/Standards/Typo3Update/Sniffs/Deprecated/AjaxRegistrationSniff.php
new file mode 100644
index 0000000..14574ac
--- /dev/null
+++ b/src/Standards/Typo3Update/Sniffs/Deprecated/AjaxRegistrationSniff.php
@@ -0,0 +1,99 @@
+
+ *
+ * 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 PhpCsTokens;
+
+/**
+ * Analyses feature 6991.
+ *
+ * @see https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.6/Feature-69916-PSR-7-basedRoutingForBackendAJAXRequests.html
+ */
+class Typo3Update_Sniffs_Deprecated_AjaxRegistrationSniff implements PhpCsSniff
+{
+ /**
+ * Defines files to check.
+ * As soon as PHP_CS 3 is used, define them in ruleset.xml.
+ *
+ * @var array
+ */
+ public $filenamesToCheck = [
+ 'ext_tables.php',
+ 'ext_localconf.php',
+ ];
+
+ /**
+ * Returns the token types that this sniff is interested in.
+ *
+ * @return array
+ */
+ public function register()
+ {
+ return PhpCsTokens::$stringTokens;
+ }
+
+ /**
+ * Processes the tokens that this sniff is interested in.
+ *
+ * @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 (in_array(basename($phpcsFile->getFilename()), $this->filenamesToCheck) === false) {
+ return;
+ }
+
+ $tokens = $phpcsFile->getTokens();
+ if (preg_match('/"AJAX"|\'AJAX\'/', $tokens[$stackPtr]['content']) !== 1) {
+ return;
+ }
+ $equalSign = $phpcsFile->findNext(T_EQUAL, $stackPtr, null, false, null, true);
+ if ($equalSign === false) {
+ return;
+ }
+ $tokenToCheck = $phpcsFile->findNext(T_WHITESPACE, $equalSign + 1, null, true, null, true);
+ if ($tokenToCheck === false) {
+ return;
+ }
+ $token = $tokens[$tokenToCheck];
+ if ($token['code'] !== T_CONSTANT_ENCAPSED_STRING) {
+ return;
+ }
+
+ $phpcsFile->addWarning(
+ 'Defining AJAX using %s is no longer supported with a single String like %s.'
+ . ' Since TYPO3 7.6, use PSR-7-based Routing for Backend AJAX Requests.'
+ . ' See: %s',
+ $tokenToCheck,
+ '',
+ [
+ "\$GLOBALS['TYPO3_CONF_VARS']['BE']['AJAX'][\$ajaxID]",
+ $token['content'],
+ 'https://docs.typo3.org/typo3cms/extensions/core/Changelog/7.6/Feature-69916-PSR-7-basedRoutingForBackendAJAXRequests.html'
+ ]
+ );
+ }
+}
diff --git a/src/Standards/Typo3Update/Sniffs/OptionsAccessTrait.php b/src/Standards/Typo3Update/Sniffs/OptionsAccessTrait.php
index 7193e07..9920467 100644
--- a/src/Standards/Typo3Update/Sniffs/OptionsAccessTrait.php
+++ b/src/Standards/Typo3Update/Sniffs/OptionsAccessTrait.php
@@ -54,4 +54,21 @@ trait OptionsAccessTrait
}
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/GenericFunctionCallSniff.php b/src/Standards/Typo3Update/Sniffs/Removed/GenericFunctionCallSniff.php
new file mode 100644
index 0000000..b81ff7d
--- /dev/null
+++ b/src/Standards/Typo3Update/Sniffs/Removed/GenericFunctionCallSniff.php
@@ -0,0 +1,301 @@
+
+ *
+ * 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;
+
+/**
+ * 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
+{
+ 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.
+ *
+ * @param array $typo3Versions
+ * @return array
+ */
+ protected function prepareStructure(array $typo3Versions)
+ {
+ $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;
+ }
+
+ /**
+ * Returns the token types that this sniff is interested in.
+ *
+ * @return array
+ */
+ public function register()
+ {
+ 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)
+ {
+ 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'];
+ }
+
+ /**
+ * The original function call, to allow user to check matches.
+ *
+ * As we match the function 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 The converted structure for a single function.
+ *
+ * @return string
+ */
+ protected function getOldFunctionCall(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'];
+ }
+}