Add Kernel::getProjectDir() #22315

fabpot · 2017-04-06T16:25:33Z

Q	A
Branch?	master
Bug fix?	yes/no
New feature?	yes
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	n/a
License	MIT
Doc PR	symfony/symfony-docs#7768

Kernel::getRootDir() is misleading. It returns the path where AppKernel.php is stored, which is app/ in Symfony 2/3, but src/ in Symfony 4. But most of the time, we are using getRootDir() to get the project root dir, so %kernel.root_dir%/../ is a common idiom.

Changing the value of getRootDir() would be a hard BC break, so I propose to create a new method, getProjectDir() to "replace" getRootDir() gradually.

Taluu · 2017-04-06T16:52:58Z

~~wouldn't it make sense in 4.0 to use root_dir instead ?~~ didn't see the part on the BC, so nvm

And it's a bit related (but not so much too...), but having the path to the console binary (if there's one) could be useful too

linaori · 2017-04-06T17:27:41Z

Finally! \o/

ro0NL · 2017-04-06T17:29:07Z

src/Symfony/Component/HttpKernel/CHANGELOG.md

@@ -4,6 +4,8 @@ CHANGELOG
 3.3.0
 -----

+ * Added `kernel.project_dir` and `Kernel::getProjectDir()`
+ * Deprecated `kernel.root_dir` and `Kernel::getRootDir()`


Not happening right?

Virtually at least :) We cannot really display a deprecation as it's used everywhere. But, I want to get rid of it in Symfony Flex, so that in 4, we can really deprecate root_dir.

So it should have a @deprecated but not a trigger_error()?

well.. deprecation !== crashing :) then again migrating it is a burden.. so i see we care a bit more here.

Adding @deprecated sounds like a good idea 👍

nicolas-grekas

👍

This PR was merged into the 3.3-dev branch. Discussion ---------- Add Kernel::getProjectDir() | Q | A | ------------- | --- | Branch? | master | Bug fix? | yes/no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | n/a | License | MIT | Doc PR | not yet `Kernel::getRootDir()` is misleading. It returns the path where `AppKernel.php` is stored, which is `app/` in Symfony 2/3, but `src/` in Symfony 4. But most of the time, we are using `getRootDir()` to get the project root dir, so `%kernel.root_dir%/../` is a common idiom. Changing the value of `getRootDir()` would be a hard BC break, so I propose to create a new method, `getProjectDir()` to "replace" `getRootDir()` gradually. Commits ------- 1f680cc added Kernel::getProjectDir()

curry684 · 2017-04-07T19:38:47Z

Why not introduce a getKernelDir method as well? It would allow deprecating getRootDir via phpDoc today, and for real in 4.0. PhpDoc deprecations are only respected by IDEs and code checkers so that should ease transition.

This new parameter and method will appear in Symfony 3.3 as per symfony/symfony#22315 We will remove it then.

weaverryan · 2017-04-07T22:40:23Z

Docs issue created and PR description updated - let's make sure we keep track of everything :) (docs team has a lot of catching up to do, but I hope we'll at least have a complete issue list to work from!)

This PR was merged into the 3.3-dev branch. Discussion ---------- [HttpKernel] sync upgrade files | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #22315 | License | MIT | Doc PR | Commits ------- a90e461 sync upgrade files

Tobion · 2017-05-04T09:18:42Z

src/Symfony/Component/HttpKernel/Kernel.php

+     */
+    public function getProjectDir()
+    {
+        if (null === $this->projectDir) {


This implementation is really strange. It basically assigns the variable twice. Once in the method and once in the constructor.

@Tobion the method itself can be overwritten to change the logic (for instance for people wanting to avoid issues with open base dir). But the Kernel still wants to ensure its private property stores the right thing.

And then, the default implementation relies on the property internally to avoid doing the filesystem traversal multiple times

aschempp · 2017-05-08T12:59:23Z

src/Symfony/Component/HttpKernel/Kernel.php

@@ -59,6 +59,8 @@
    protected $startTime;
    protected $loadClassCache;

+    private $projectDir;


Is there a reason this is private and not protected like $rootDir. I need to override this in my kernel and can't really do at runtime…

I believe the extension point is the public method, not the property.

Well the issue is that the property is set in __construct and later used by getKernelParameters. My kernel does not know the path at construct time, so I would need to override multiple methods for no reason…

@iltar Following your argument, this line should use $this->getProjectDir() then. The current code is inconsistent and I suggest that we change private $projectDir to protected $projectDir so it matches protected $rootDir.

Making things protected means we then have to ensure backward compatibility on the access to the property. This is a strong commitment. So we never replace private with protected without a strong use case for it. And if you have one, please open a dedicated issue to discuss it instead of doing it on the merged PR (people are generally looking at opened discussion only when catching up)

See #22728 for alternative

This PR was merged into the 3.3 branch. Discussion ---------- use getProjectDir() when possible | Q | A | ------------- | --- | Branch? | 3.3 | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | continues #22315 | License | MIT | Doc PR | Commits ------- a8e298a use getProjectDir() when possible

added Kernel::getProjectDir()

1f680cc

carsonbot added Status: Needs Review Bug Feature labels Apr 6, 2017

fabpot mentioned this pull request Apr 6, 2017

[Question] Where should the old app/Resources/ contents live now? symfony/flex#40

Closed

ro0NL reviewed Apr 6, 2017

View reviewed changes

nicolas-grekas added this to the 3.3 milestone Apr 7, 2017

nicolas-grekas approved these changes Apr 7, 2017

View reviewed changes

fabpot merged commit 1f680cc into symfony:master Apr 7, 2017

fabpot deleted the real-root-dir branch April 7, 2017 17:17

ghost pushed a commit to lazerball/HitTracker that referenced this pull request Apr 7, 2017

add new kernel getProjectDir() and project_dir parameter

2d6f3aa

This new parameter and method will appear in Symfony 3.3 as per symfony/symfony#22315 We will remove it then.

weaverryan mentioned this pull request Apr 7, 2017

New Method: Kernel::getProjectDir() symfony/symfony-docs#7768

Closed

xabbuh mentioned this pull request Apr 20, 2017

[HttpKernel] sync upgrade files #22485

Merged

fabpot mentioned this pull request May 1, 2017

Release v3.3.0-BETA1 #22603

Merged

Tobion reviewed May 4, 2017

View reviewed changes

aschempp reviewed May 8, 2017

View reviewed changes

aschempp mentioned this pull request May 8, 2017

[4.4-beta1] kernel.project_dir parameter points to the manager bundle directory contao/manager-bundle#28

Closed

xabbuh mentioned this pull request May 22, 2017

use getProjectDir() when possible #22843

Merged

ro0NL mentioned this pull request Nov 13, 2017

[RFC] Deprecate Kernel::getRootDir? #24293

Closed

This was referenced Sep 10, 2018

Deprecate getRootDir and promote getProjectDir instead symfony/http-kernel#18

Closed

Deprecate getRootDir and promote getProjectDir instead #28434

Closed

greg0ire mentioned this pull request Jan 2, 2020

Symfony 5 parameter fix doctrine/DoctrineMigrationsBundle#295

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Kernel::getProjectDir() #22315

Add Kernel::getProjectDir() #22315

fabpot commented Apr 6, 2017 •

edited by weaverryan

Taluu commented Apr 6, 2017 •

edited

linaori commented Apr 6, 2017

ro0NL Apr 6, 2017

fabpot Apr 7, 2017

thewilkybarkid Apr 7, 2017

ro0NL Apr 7, 2017

nicolas-grekas left a comment

curry684 commented Apr 7, 2017 •

edited

weaverryan commented Apr 7, 2017

Tobion May 4, 2017

stof May 4, 2017

aschempp May 8, 2017

linaori May 8, 2017

aschempp May 8, 2017

leofeyer May 17, 2017

stof May 17, 2017

leofeyer May 17, 2017 •

edited

chalasr May 17, 2017

Add Kernel::getProjectDir() #22315

Add Kernel::getProjectDir() #22315

Conversation

fabpot commented Apr 6, 2017 • edited by weaverryan

Taluu commented Apr 6, 2017 • edited

linaori commented Apr 6, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nicolas-grekas left a comment

Choose a reason for hiding this comment

curry684 commented Apr 7, 2017 • edited

weaverryan commented Apr 7, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

leofeyer May 17, 2017 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fabpot commented Apr 6, 2017 •

edited by weaverryan

Taluu commented Apr 6, 2017 •

edited

curry684 commented Apr 7, 2017 •

edited

leofeyer May 17, 2017 •

edited