From 56d692bac7ed2a60706c0d09837ac0dce75cc7fa Mon Sep 17 00:00:00 2001 From: Daniel Siepmann Date: Thu, 30 Mar 2017 13:18:18 +0200 Subject: [PATCH] TASK: Add missing docs * Add docs for new feature. Relates: #33 --- Readme.rst | 26 +++++++++++++++++++ .../Typo3Update/Sniffs/OptionsAccessTrait.php | 2 +- 2 files changed, 27 insertions(+), 1 deletion(-) 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/src/Standards/Typo3Update/Sniffs/OptionsAccessTrait.php b/src/Standards/Typo3Update/Sniffs/OptionsAccessTrait.php index 9db7ee7..9920467 100644 --- a/src/Standards/Typo3Update/Sniffs/OptionsAccessTrait.php +++ b/src/Standards/Typo3Update/Sniffs/OptionsAccessTrait.php @@ -62,7 +62,7 @@ trait OptionsAccessTrait */ public function getRemovedFunctionConfigFiles() { - $configFiles = PhpCs::getConfigData('removedfunctionConfigFiles'); + $configFiles = PhpCs::getConfigData('removedFunctionConfigFiles'); if (!$configFiles) { $configFiles = __DIR__ . '/../Configuration/Removed/Functions/*.yaml'; }