Inspection Profile
When you inspect your code, you have to tell PhpStorm which types of problems you would like to search for and get reports about. Such configuration can be preserved as an inspection profile.
Inspection profile defines the types of problems to be sought for, severity of these problems, and color scheme of alerts. Profiles are configurable in the Inspections dialog box.
Inspection profiles can be stored on the IDE or project level:
- Project profiles are shared and accessible for the team members. They are stored in project.
- IDE profiles are intended for personal use only and are stored locally in XML files under the USER_HOME/.<PhpStorm version>/config/inspection directory.
PhpStorm comes with the following pre-defined inspection profiles:
- Default: This local (IDE level) profile is intended for personal use only and is stored locally in the file Default.xml under the USER_HOME/.<PhpStorm version>/config/inspection directory.
- Project Default: When a new project is created, its Project Default
profile is copied from the settings of a template project. This profile is shared by default.
After that, any modifications to the project default profile will pass unnoticed to any other project.
When the settings of the Project Default profile are modified in the Template Project settings, then the changed profile will apply to all newly created projects, but the existing projects will not be affected.
Project Default profile is stored in the file Project_Default.xml, in the directory <project>/.idea/inspectionProfiles.
One can have as many inspection profiles as required. Whenever a new profile is created, it is in fact a copy of the Default profile (Add), or the currently selected profile (Copy). The newly created profiles are stored in XML files, located depending on the type of the base profile .
The files <profile_name>.xml representing inspection profiles appear whenever some changes to the profiles are done and applied. The files store only differences against the base profile.
Refer to the section Customizing Profiles for details.
Inspection Scope
A project can be divided into several areas of inspections, or scopes, where different inspections should apply. Associating an inspection profile with a scope is described in the section Defining Scope-Profile Combination.
Examples of Code Inspections
Numerous automated Code Inspections help you easily detect different inconsistencies. In PhpStorm you will find that all inspections are grouped by their goals and sense. Every inspection has an appropriate description. The most common tasks that are covered by the static code analysis are:
- Finding probable bugs.
- Locating dead code.
- Detecting performance issues.
- Improving code structure and maintainability.
- Conforming to coding guidelines and standards.
- Conforming to specifications.
Unresolved JavaScript Function or Method
This inspection detects references to undefined JavaScript functions or methods.
Examples of PHP Code Inspections
Unresolved include
This inspection detects attempts to include not actually existing files and suggests two quick fixes: to create a file with the specified name or use a PHPDOC annotation.
Dynamic method is called as static
This inspection checks whether a call to a static function is actually applied to a static function.
The function do_something() is called as static while actually it is dynamic.
Unimplemented abstract method in class
This inspection checks whether classes inherited from abstract superclasses are either explicitly declared as abstract or the functions inherited from the superclass are implemented.
The class ConcreteClass is inherited from an abstract class AbstractClass and has not been explicitly declared as abstract. At the same time, the function GetValue(), which is inherited from AbstractClass, has not been implemented.
Parameter type
PHP variables do not have types, therefore basically parameter types are not specified in definitions of functions. However, if the type of a parameter is defined explicitly, the function should be called with parameters of the appropriate type.
The function do_something has the parameter of the type integer but is called with a string.
Undefined class constant
This inspection detects references to constants that are not actually defined in the specified class.
The constant NotExistingConst is referenced to as a constant of the class Animal, while actually it is not defined in this class.
Undefined constant inspection
This inspection detects references to constants that are not actually defined anywhere within the inspection scope.
The referenced constant UndefinedConst is not defined anywhere within the inspection scope.
Undefined class
This inspection detects references to classes that are not actually defined anywhere within the inspection scope.
The referenced class NotExistingClass is not defined.
Undefined field
This inspection detects references to fields of a class that are not actually defined in this class.
The $obj variable is an instance of the class Animal. The declaration of the $var contains a reference to the field field of the class Animal, which is not defined on this class.
Call of undefined function
This inspection detects references to functions that are not defined anywhere within the inspection scope.
The called function undefined_function() is not defined anywhere within the inspection scope.
Undefined variable
This inspection detects references to variables that are not declared and initialized anywhere within the inspection scope. PHP does not require that each variable should be declared and initialized. PHP can initialize such variable on the fly and assign it the zero value. However, this inspection allows you to detect discrepancies of this kind.
Note
In the PHP context, the Undefined field and Undefined method inspections may erroneously report severe problems when actually no problems take place. This happens when you attempt to access a property or to assign a value to a property that is not explicitly defined while the referenced class contains the _get() or _set() magic methods. No error should be reported because these methods are invoked every time an undefined property is referenced, however, PhpStorm still treats them as errors or warnings, depending on the severity you have specified for the inspection in general.
To suppress reporting errors in such cases, re-configure the inspection severity. To do that, open the Inspections page of the Settings dialog box, click the inspection name in the list and select the Downgrade severity if __magic methods are present in class check box in the Options area. After that undefined properties in such cases will be indicated one step lower than specified fir inspections in general, by default, Info instead of Warning.
