From 913d365a0853e1558eb87db5b54403dc62616156 Mon Sep 17 00:00:00 2001 From: Daniel Siepmann Date: Thu, 9 Mar 2017 11:49:41 +0100 Subject: [PATCH] TASK: Improve documentation * Provide basic usage. * Provide what's included. --- Readme.rst | 29 +++++++++++++++++++++++++++-- 1 file changed, 27 insertions(+), 2 deletions(-) diff --git a/Readme.rst b/Readme.rst index 50a98b1..8640a98 100644 --- a/Readme.rst +++ b/Readme.rst @@ -19,9 +19,34 @@ Run:: make install -Copy the ``vendor/composer/autoload_classaliasmap.php`` generated by ``composer`` in your TYPO3 installation to ``LegacyClassnames.php`` in the root of this project. +and copy the ``vendor/composer/autoload_classaliasmap.php`` generated by ``composer`` in your TYPO3 +installation to ``LegacyClassnames.php`` in the root of this project. Usage ===== -Will follow. +Run:: + + ./vendor/bin/phpcbf + +This will run the auto fixer recursive for ```` fixing all issues. + +Afterwards you should run:: + + ./vendor/bin/phpcs + +To get information about possible issues that were not autofixed. + +What's included? +================ + +Currently we can migrate calls to old legacy class names of the TYPO3 core like ``Tx_Extbase...`` to +new ones like ``\TYPO3\Extbase\...``. This is done for: + +- PHPDocuments, like Includes and annotations for IDEs. + +- Inheritance like ``extends`` and ``implements``. + +- Static calls like ``t3lib_div::`` to ``\TYPO3\Core\Utility\GeneralUtility``. + +- Typehints in methods and function like injects.