Download the PHP package tomasvotruba/unused-public without Composer
On this page you can find all versions of the php package tomasvotruba/unused-public. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download tomasvotruba/unused-public
More information about tomasvotruba/unused-public
Files in tomasvotruba/unused-public
Package unused-public
Short Description Detect unused public properties, constants and methods in your code
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package unused-public
Find Unused Public Elements in Your Code
It's easy to find unused private class elements, because they're not used in the class itself. But what about public methods/properties/constants?
How can we detect unused public element?
- find a public method
- find all public method calls in code and templates
- if the public method is not found, it probably unused
That's exactly what this package does.
This technique is very useful for private projects and to detect accidentally used public modifier that should be changed to private as called locally only.
Install
The package is available for PHP 7.2+ version.
Usage
With PHPStan extension installer, everything is ready to run.
Enable each item on their own with simple configuration:
Do you have hundreds of reported public method? You don't have time to check them all, but want to handle them gradually?
Set maximum allowed % configuration instead:
This means maximum 2.5 % of all public methods is allowed as unused:
- If it's 5 %, you'll be alerted.
- If it's 1 %, it will be skipped as tolerated.
Do you want to check local-only method calls that should not be removed, but be turned into private/protected instead?
Exclude methods called in templates
Some methods are used only in TWIG or Blade templates, and could be reported false positively as unused.
How can we exclude them? Add your TWIG or Blade template directories in config to exclude methods names:
Known Limitations
In some cases, the rules report false positives:
- when used only in templates, apart Twig paths, it's not possible to detect them
Skip Public-Only Methods
Open-source vendors design public API to be used by projects. Is element reported as unused, but it's actually designed to be used public?
Mark the class or element with @api annotation to skip it:
