Ein Beispiel gef\u00e4llig? Kein Problem. Hier kommt ein einfaches Szenario:<\/p>\n
\u00a0\u00a0\u00a0\u00a0public\u00a0function\u00a0run()\r\n\u00a0\u00a0\u00a0\u00a0\u00a0{\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0$items\u00a0=\u00a0[];\r\n-\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0array_push($items,\u00a0$item);\r\n+\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0$items[]\u00a0=\u00a0$item;\r\n \u00a0\u00a0\u00a0\u00a0}<\/pre>\nIn diesem Beispiel w\u00fcrde Rector die Funktion array_push()<\/code> durch eine zeitgem\u00e4\u00dfe Schreibweise ersetzen.<\/p>\nEin wenig komplexer darf es schon sein? Auch das ist kein Problem.<\/p>\n
\u00a0class\u00a0MyViewHelper\u00a0implements\u00a0ViewHelperInterface\r\n\u00a0{\r\n-\u00a0\u00a0\u00a0\u00a0public\u00a0function\u00a0render(array\u00a0$firstParameter,\u00a0string\u00a0$secondParameter\u00a0=\u00a0null)\r\n+\u00a0\u00a0\u00a0\u00a0public\u00a0function\u00a0initializeArguments()\r\n\u00a0\u00a0\u00a0\u00a0\u00a0{\r\n+\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0$this->registerArgument('firstParameter',\u00a0'array',\u00a0'',\u00a0true);\r\n+\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0$this->registerArgument('secondParameter',\u00a0'string',\u00a0'',\u00a0false,\u00a0null);\r\n+\u00a0\u00a0\u00a0\u00a0}\r\n+\r\n+\u00a0\u00a0\u00a0\u00a0public\u00a0function\u00a0render()\r\n+\u00a0\u00a0\u00a0\u00a0{\r\n+\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0$firstParameter\u00a0=\u00a0$this->arguments['firstParameter'];\r\n+\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0$secondParameter\u00a0=\u00a0$this->arguments['secondParameter'];\r\n\u00a0\u00a0\u00a0\u00a0\u00a0}\r\n\u00a0}<\/pre>\nHier werden die Argumente im TYPO3 Fluid Viewhelper nicht mehr wie in \u00e4lteren TYPO3-Versionen der Methode render()<\/code> \u00fcbergeben. Das w\u00fcrde in TYPO3 v10.4 LTS zu einem Fehler f\u00fchren. Also werden die Argumente zun\u00e4chst deklariert und innerhalb der Funktion wieder zugewiesen. Alleine diese Regel erspart einem enorm viel Zeit.<\/p>\nUnterst\u00fctzt werden neben TYPO3 auch Symfony, Drupal, CakePHP und sicherlich bald auch noch viele weitere.<\/p>\n
Das bei Upgrades oft genutzte „Suchen und Ersetzen“ wird mittels Rector obsolet. Aber die Software kann weitaus mehr. Das Paket ist leicht zu installieren und anzuwenden. Wie genau du Rector f\u00fcr TYPO3 aufsetzt und nutzt, erf\u00e4hrst du im folgenden Artikel.<\/p>\n
1. Installation von Rector f\u00fcr TYPO3<\/h2>\n
Rector f\u00fcr TYPO3 ist ein PHP-Paket welches einfach via Composer<\/a> installiert werden kann.<\/p>\ncomposer require --dev ssch\/typo3-rector<\/pre>\nSollte es zu Kompatibilit\u00e4tsproblemen bei der Installation kommen, dann einfach das folgende Paket anstatt dessen installieren.<\/p>\n
composer require --dev ssch\/typo3-rector-prefixed<\/pre>\nAn dieser Stelle ein gro\u00dfes Dankesch\u00f6n an Sebastian Schreiber und alle Entwickler, die an Rector f\u00fcr TYPO3 mitarbeiten. Als Programmierer kannst das Projekt auf GitHub<\/a> unterst\u00fctzen. Hier findest du auch eine Anleitung, falls du kein Composer nutzt.<\/p>\n2. Konfigurieren<\/h2>\n
Nachdem du Rector installiert hast, muss es zun\u00e4chst noch konfiguriert werden, was allerdings schnell erledigt ist. Zun\u00e4chst f\u00fchren wir im Root-Verzeichnis, also dort, wo auch die globale composer.json liegt, folgendes Statement aus:<\/p>\n
\/\/ F\u00fcr ssch\/typo3-rector (PHP >= 7.4)\r\ncp\u00a0.\/vendor\/ssch\/typo3-rector\/templates\/rector.php.dist\u00a0rector.php\r\n\r\n\/\/ F\u00fcr rector\/rector 0.13.4 (PHP < 7.4)\r\n.\/vendor\/bin\/rector\u00a0init\u00a0--template-type=typo3<\/pre>\nNun finden wir in unserem Root-Verzeichnis eine Datei namens rector.php. Den Inhalt fassen wir noch an ein zwei Stellen an, sodass die Datei wie folgt aussieht:<\/p>\n
<?php\r\n\r\ndeclare(strict_types=1);\r\n\r\nuse Rector\\Core\\Configuration\\Option;\r\nuse Rector\\Core\\ValueObject\\PhpVersion;\r\nuse Rector\\PostRector\\Rector\\NameImportingPostRector;\r\nuse Ssch\\TYPO3Rector\\Set\\Typo3SetList;\r\nuse Symfony\\Component\\DependencyInjection\\Loader\\Configurator\\ContainerConfigurator;\r\n\r\nreturn static function (ContainerConfigurator $containerConfigurator): void {\r\n\/\/ get parameters\r\n$parameters = $containerConfigurator->parameters();\r\n\r\n\/\/\u00a0Define\u00a0what\u00a0rule\u00a0sets\u00a0will\u00a0be\u00a0applied\r\n$containerConfigurator->import(Typo3SetList::TYPO3_76);\r\n$containerConfigurator->import(Typo3SetList::TYPO3_87);\r\n$containerConfigurator->import(Typo3SetList::TCA_87);\r\n$containerConfigurator->import(Typo3SetList::TYPO3_95);\r\n$containerConfigurator->import(Typo3SetList::TCA_95);\r\n$containerConfigurator->import(Typo3SetList::TYPO3_104);\r\n$containerConfigurator->import(Typo3SetList::TCA_104);\r\n$containerConfigurator->import(Typo3SetList::DATABASE_TO_DBAL);\r\n$containerConfigurator->import(Typo3SetList::UNDERSCORE_TO_NAMESPACE);\r\n\r\n\/\/ FQN classes are not imported by default. If you don't do it manually after every Rector run, enable it by:\r\n$parameters->set(Option::AUTO_IMPORT_NAMES, true);\r\n\r\n\/\/ this will not import root namespace classes, like \\DateTime or \\Exception\r\n$parameters->set(Option::IMPORT_SHORT_CLASSES, false);\r\n\r\n\/\/ this will not import classes used in PHP DocBlocks, like in \/** @var \\Some\\Class *\/\r\n$parameters->set(Option::IMPORT_DOC_BLOCKS, false);\r\n\r\n\/\/ Define your target version which you want to support\r\n$parameters->set(Option::PHP_VERSION_FEATURES, PhpVersion::PHP_74);\r\n\r\n\/\/ If you would like to see the changelog url when a rector is applied\r\n\/\/ $parameters->set(Typo3Option::OUTPUT_CHANGELOG, true);\r\n\r\n\/\/ If you set option Typo3Option::AUTO_IMPORT_NAMES to true, you should consider excluding some TYPO3 files.\r\n$parameters->set(Option::SKIP, [\r\nNameImportingPostRector::class => [\r\n'ClassAliasMap.php',\r\n'ext_localconf.php',\r\n'ext_emconf.php',\r\n'ext_tables.php',\r\n__DIR__ . '\/**\/TCA\/*',\r\n__DIR__ . '\/**\/Configuration\/RequestMiddlewares.php',\r\n__DIR__ . '\/**\/Configuration\/Commands.php',\r\n__DIR__ . '\/**\/Configuration\/AjaxRoutes.php',\r\n__DIR__ . '\/**\/Configuration\/Extbase\/Persistence\/Classes.php',\r\n],\r\n]);\r\n\r\n\/\/ If you have trouble that rector cannot run because some TYPO3 constants are not defined add an additional constants file\r\n\/\/ Have a look at https:\/\/github.com\/sabbelasichon\/typo3-rector\/blob\/master\/typo3.constants.php\r\n\/\/ $parameters->set(Option::AUTOLOAD_PATHS, [\r\n\/\/ __DIR__ . '\/typo3.constants.php'\r\n\/\/ ]);\r\n\r\n\/\/ get services (needed for register a single rule)\r\n\/\/ $services = $containerConfigurator->services();\r\n\r\n\/\/ register a single rule\r\n\/\/ $services->set(InjectAnnotationRector::class);\r\n};<\/pre>\nIn der Zeile 18 habe ich definiert, welche Regelsammlungen angewendet werden sollen.<\/p>\n
\/\/ Define what rule sets will be applied\r\n$containerConfigurator->import(Typo3SetList::TYPO3_76);\r\n$containerConfigurator->import(Typo3SetList::TYPO3_87);\r\n$containerConfigurator->import(Typo3SetList::TCA_87);\r\n$containerConfigurator->import(Typo3SetList::TYPO3_95);\r\n$containerConfigurator->import(Typo3SetList::TCA_95);\r\n$containerConfigurator->import(Typo3SetList::TYPO3_104);\r\n$containerConfigurator->import(Typo3SetList::TCA_104);\r\n$containerConfigurator->import(Typo3SetList::DATABASE_TO_DBAL);\r\n$containerConfigurator->import(Typo3SetList::UNDERSCORE_TO_NAMESPACE);<\/pre>\nEine \u00dcbersicht aller Regeln<\/a> speziell f\u00fcr TYPO3 findet ihr im GitHub, ebenso wie die \u00dcbersicht aller Regelsammlungen<\/a>.<\/p>\nNeben den Regelsammlungen habe ich in Zeile 39 die Ziel-PHP-Version von PHP_72 auf PHP_74 angehoben.<\/p>\n
\/\/ Define your target version which you want to support\r\n$parameters->set(Option::PHP_VERSION_FEATURES, PhpVersion::PHP_74);<\/pre>\nEs ist nicht zwingend notwendig, dass Rector dann auch mit PHP 7.4 ausgef\u00fchrt wird, die PHP-Applikation sollte es hingegen schon. Die \u00fcber 600 allgemeinen Rector PHP Regeln gibt es ebenfalls auf GitHub<\/a>.<\/p>\n3. Rector ausf\u00fchren<\/h2>\n
Einmal konfiguriert, kann Rector auf jeden beliebigen Zielpfad ausgef\u00fchrt werden. Wie bereits bei der Konfiguration befinden wir uns wieder im Root-Verzeichnis, um das Tool anzuwenden.<\/p>\n
.\/vendor\/bin\/rector process public\/typo3conf\/ext\/my_extension --dry-run<\/pre>\nMit --dry-run<\/code> wird wie bei Composer zun\u00e4chst angezeigt, welche \u00c4nderungen durchgef\u00fchrt werden.<\/p>\n![\"Beispielhafte](\"https:\/\/www.clickstorm.de\/blog\/wp-content\/uploads\/2021\/02\/rector_php_typo3_dry-run.png\")
<\/p>\n
Wenn alles soweit ok ist, dann f\u00fchren wir die Aktion nochmal durch, nur ohne den Parameter.<\/p>\n
vendor\/bin\/typo3-rector\u00a0process\u00a0public\/typo3conf\/ext\/my_extension<\/pre>\nAlle \u00c4nderungen sind somit in den Dateien gespeichert. Wie bereits beschrieben, l\u00e4sst sich der Pfad beliebig anpassen.
\nNun w\u00fcnschen wir dir viel Spa\u00df beim Anwenden.<\/p>\n
Sebastian Schreiber hat mit Never Code Alone<\/a> das Tool nochmal ausgiebiger vorgestellt.<\/p>\n![\"Info](\"https:\/\/www.clickstorm.de\/blog\/wp-content\/plugins\/clickstorm-embed\/images\/comment-alt-exclamation.svg\")
<\/p>\nDieses Video wird \u00fcber eine externe Plattform (YouTube) gehostet. Das Laden bedarf der Zustimmung unserer Datenschutzbestimmungen.<\/a><\/p>\n