Dlaczego bezwzględne stałe ścieżki __DIR__ i __FILE__ nie powinny być używane w Symfony

Question

Używam SensioLabs Insight do kontrolowania jakości mojego kodu.

Dla prostego przesłanie pliku, muszę uzyskać bezwzględną ścieżkę do mojego katalogu uploads:

protected function getUploadRootDir() 
{ 
    // the absolute directory path where uploaded 
    return __DIR__.'/../../../../web/'.$this->getUploadDir(); 
} 

Kod pochodzących bezpośrednio z oficjalnej dokumentacji (How to handle file uploads with Doctrine)

Ale SLInsight zgłosi ostrzeżenie, jeśli kod analizowane zawiera __DIR__ lub __FILE__ PHP magiczne stałe:

__DIR__ i __FILE__ stałe mogą powodować konflikt z systemem przesłonięcia zasobów Symfony.

W jaki sposób użycie tych stałych może powodować konflikty z Symfony?

Jak mogę ich uniknąć w moim kodzie?

Answer 1

W przypadku klasy przesyłania plików możesz prawdopodobnie zignorować ten komunikat o błędzie. Ale w innych przypadkach lepiej użyć lokalizatora plików Symfony zamiast ścieżek plików hardcoding. Na przykład:

$path = $this->get('kernel')->locateResource('@AppBundle/Resources/config/services.xml'); 

Zamiast:

$path = __DIR__.'/../../../src/Acme/AppBundle/Resources/config/services.xml' 

Answer 2

To jest właściwie coś, co SensioLabs Insight nie obsługuje poprawnie. Ostrzega przed używaniem stałych ze względu na system nadpisywania zasobów, ale w wielu przypadkach te stałe są używane w miejscach, które nie są powiązane z systemem nadpisywania zasobów (co prawdopodobnie ma miejsce w przypadku tego kodu). Możesz więc zignorować ostrzeżenie w tym przypadku:

Answer 3

Jeśli tworzysz pakiet innej firmy i chcesz, aby zlokalizować kilka zasobów, (dobrze) rozwiązanie proponowane przez @Javier nie ma zastosowania w tym wyjątek to

ServiceNotFoundException in ContainerBuilder.php line 816: 
You have requested a non-existent service "kernel". 

W tym przypadku rozwiązaniem jest użycie $this->getPath(), metodę dziedziczona przez BundleNameBundle z Symfony\Component\HttpKernel\Bundle\Bundle c dziewczyna.

Powoduje to ten sam wynik co realpath(__DIR__).

Wykonanie $this->getPath() . '/Resources/config/doctrine/mappings' jest takie samo jak realpath(__DIR__ . '/Resources/config/doctrine/mappings').

Pierwotnie zaproponowano here.