Download the PHP package inviqa/phpstan-magento1 without Composer
On this page you can find all versions of the php package inviqa/phpstan-magento1. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download inviqa/phpstan-magento1
More information about inviqa/phpstan-magento1
Files in inviqa/phpstan-magento1
Package phpstan-magento1
Short Description Extension for PHPStan to allow analysis of Magento 1 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 phpstan-magento1
phpstan-magento1 extension
Extension for PHPStan to allow analysis of Magento 1 code.
Currently it assumes Magento is installed in the public/ directory of the project root. Further work is needed in phpstan itself to allow more intellegence for extensions to be more customised whilst working with both phpstan/phpstan and phpstan/phpstan-shim.
By default phpstan with this extension will test public/app/code/local only.
Usage
Add phpstan.neon to your Magento 1 project.
Make sure it has
Whilst this extension depends on phpstan/phpstan, it can also depend on phpstan/phpstan-shim, which decouples its dependencies from the project's own use of them.
With coupled dependencies:
With uncoupled phar package:
Alternative Magento path
Add to the project's phpstan.neon:
Known Issues
Data/SQL scripts can't be tested
Since these scripts use a presumed $this variable due to being included from a setup class, work is needed to:
- work out the correct setup class
- somehow make phpstan aware of it for the file
Magento fluent interface classes aren't fluent for sub-classes
This causes subsequent calls to the class object to assume the scope of the super-class that defined the return type.
This is due to their PHPDoc not using the up to date way of specifying fluency with subclasses using "$this" as the type.
Options to resolve:
- Avoid using the fluent interface on these classes
- Patch Magento code to use $this as the return type
- Define @method PHPDoc for the called methods in the subclass
- Add the error to the parameters.ignoreErrors phpstan configuration to ignore it - this loses the ability to properly type the subseqent methods of the fluent interface
Mage_Core_Model_Abstract::load $id is not an integer
This is due to an inadequate PHPDoc of the load method of the Mage_Core_Model_Abstract class. It should have used a "mixed" type to support when a field is specified as the 2nd argument.
PHPStan extensions have no way of altering existing method parameters.
Options to resolve:
- Patch the Magento code to use mixed as the $id parameter type
- If available in the chain of super-classes, use the loadBy{Field} method, which has the correct parameter typing
- Define @method PHPDoc in your class (which extends Mage_Core_Model_Abstract or a subclass of it) with the correct parameter types
- Add the error to the parameters.ignoreErrors phpstan configuration to ignore it
