While browsing this project I've found that stubs live in the same directory as source

I think <div class="highlight highlight-source-neon notranslate position-relative

you have to add any class you import/use as a stub as well </blockquo

<a class="user-mention notranslate" data-hovercard-type="user" data-hover

Move stubs out of src/ about phpstan-magento HOT 6 CLOSED

bitexpert commented on August 26, 2024

Move stubs out of src/

from phpstan-magento.

Comments (6)

shochdoerfer commented on August 26, 2024 1

Thanks for opening an issue first to discuss things.

First of all, yes what is called mocks are actually stubs. The reasoning behind this is that I did not want to confuse people (well, mainly me) with the stubs from PHPStan as they behave fundamentally differently and I could not come up with a better name.

It does not make sense to rely on PHPStan's stubs because doing that would mean we have to add half of Magento's codebase to this repo. The "problem" with PHPStan's stubs (at least the last time I looked at it) was, that you have to add any class you import/use as a stub as well. In our approach, the autoloader simply loads a different implementation if it exists. From that perspective, things work as they should for me.

Does it make sense to move the files out of the src folder? Maybe. Is it worth it? Probably not.

In an ideal world, the subs/mocks would be located in a separate Composer package that depends on a matching Magento version. Because currently, technically false positives could occur when Magento changes one of the classes that we stored as stub/mock. However, I decided against that approach for now, because it simply is way too much management overhead to create a separate package per Magento version and maintain that. Also, so far no one reported false positives from the stub/mock files we provide. As long as that does not happen, I'll leave things as they are.

from phpstan-magento.

szepeviktor commented on August 26, 2024

I see you call stubs "mock".

from phpstan-magento.

szepeviktor commented on August 26, 2024

I think

parameters:
	stubFiles:

could be used instead of a custom solution.

phpstan-magento/src/bitExpert/PHPStan/Magento/Autoload/MockAutoloader.php

Lines 15 to 38 in 91032ba

 /** 

  * The MockAutoloader is responsible to load custom mocked classes or interfaces instead of the original Magento classes 

  * or interfaces. This is needed as not all interfaces expose all public methods that can be called on those objects. 

  */ 

 class MockAutoloader implements Autoloader 

 { 

 public function autoload(string $class): void 

 { 

 $filename = realpath(__DIR__ . '/../../../../' . str_replace('\\', '/', $class) . '.php'); 

 if (!is_bool($filename) && file_exists($filename) && is_readable($filename)) { 

 include($filename); 

 } 

 } 

 public function register(): void 

 { 

 \spl_autoload_register([$this, 'autoload'], true, true); 

 } 

 public function unregister(): void 

 { 

 \spl_autoload_unregister([$this, 'autoload']); 

 } 

 }

from phpstan-magento.

szepeviktor commented on August 26, 2024

you have to add any class you import/use as a stub as well

YES!!

from phpstan-magento.

szepeviktor commented on August 26, 2024

to create a separate package per Magento version and maintain that

@shochdoerfer Would you like me to create and maintain a package - e.g php-stubs/magento-stub - and include your mocks?

from phpstan-magento.

shochdoerfer commented on August 26, 2024

@shochdoerfer Would you like me to create and maintain a package - e.g php-stubs/magento-stub - and include your mocks?

I don't see a benefit in that.

from phpstan-magento.

Move stubs out of src/ about phpstan-magento HOT 6 CLOSED

Comments (6)

Related Issues (20)

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent

	/**
	* The MockAutoloader is responsible to load custom mocked classes or interfaces instead of the original Magento classes
	* or interfaces. This is needed as not all interfaces expose all public methods that can be called on those objects.
	*/
	class MockAutoloader implements Autoloader
	{
	public function autoload(string $class): void
	{
	$filename = realpath(__DIR__ . '/../../../../' . str_replace('\\', '/', $class) . '.php');
	if (!is_bool($filename) && file_exists($filename) && is_readable($filename)) {
	include($filename);
	}
	}

	public function register(): void
	{
	\spl_autoload_register([$this, 'autoload'], true, true);
	}

	public function unregister(): void
	{
	\spl_autoload_unregister([$this, 'autoload']);
	}
	}