vortrixs/joomla-namespace-checker

Checks for correct namespace usage in Joomla projects

Joomla Namespace Checker (JNSC)

For migrating to Joomla 3.8.x, _(*1)

This script scans a directory recursively for PHP files containing calls to the old classes (e.g. JFactory)., _(*2)

DISCLAIMER: Keep in mind that the results from this tool are only suggestions and that these changes are NOT required for your application to work until Joomla 5 is released. Thanks to @anibalsanchez for pointing this out (#6)., _(*3)

As a side note you can always find the full definition for the new class names in Joomlas own repository., _(*4)

Note: I'm not actively supporting this repository at the moment as I'm not working with Joomla anymore, but do feel free to submit PRs if you have any changes or found any bugs., _(*5)

Requirements

• PHP 7.x

Usage

Using Composer

Add the package to your composer.json, _(*6)

composer require --dev vortrixs/joomla-namespace-checker

Afterwards you can run it using, _(*7)

vendor/bin/jnsc path/to/your/project/

This should work as long as PHP is in your $PATH., _(*8)

If this does not work you can always execute the PHAR directly, _(*9)

php vendor/vortrixs/joomla-namespace-checker/bin/jnsc.phar

Using the PHAR

Download the PHAR from the latest release and run it like so, _(*10)

$ php jnsc.phar path/to/your/project

If any calls are found you will get the following output:, _(*11)

FILE: path/to/your/project/someFile.php
-------------------------------------------------------------------------------------
Line: 12 | Class found: JTable        | Replace with: Joomla\CMS\Table\Table
Line: 21 | Class found: JPlugin       | Replace with: Joomla\CMS\Plugin\CMSPlugin
Line: 47 | Class found: JPluginHelper | Replace with: Joomla\CMS\Plugin\PluginHelper
Line: 56 | Class found: JFactory      | Replace with: Joomla\CMS\Factory
Line: 75 | Class found: JPluginHelper | Replace with: Joomla\CMS\Plugin\PluginHelper
Line: 84 | Class found: JFactory      | Replace with: Joomla\CMS\Factory
-------------------------------------------------------------------------------------

Excluding paths & files

Pass the --exclude option to exclude directories and files., _(*12)

$ php jnsc.phar --exclude=/somepath/,somefile.php,some/other/path/ path/to/your/project

The exclusion is very basic so you might have to tweak the paths a bit, this also means wildcards like * are not supported., _(*13)

e.g. if you pass --exclude=google, it will filter out anything that has google in it's path or filename., _(*14)

To reliably filter out a whole directory wrap it in / / and for single files use filename.ext., _(*15)

Automatically update files after scan

With the -u option on the command line, the classnames are replaced in the file, use statements are inserted immediately after the <?php tag, and the file is rewritten with the changes. JEventDispatcher, JDispatcher and JRequest calls will be excluded from fix list and should be fixed manually according to suggestions., _(*16)