symfony / symfony

Sponsor

Sponsor symfony/symfony
Notifications
Star 25.5k
Fork 8.2k

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Filesystem] Add the Path class #41954

Open

theofidry wants to merge 25 commits into symfony:5.4 from theofidry:feature/path-component

+1,902 −1

Contributor

theofidry commented Jul 2, 2021

Q	A
Branch?	5.4
Bug fix?	no
New feature?	yes
Deprecations?	no
Tickets	Fix #26523
License	MIT
Doc PR	TODO

Re-opening #30969 as requested by @fabpot.

This PR proposes a low-level, performant and pure API to manipulate file paths.

Two methods Path::isAbsolute() and Path::isRelative() are similar to Filesystem::isAbsolutePath() and Filesystem::makePathRelative(). They are however different as the methods from Path do not check the existence of the path which is very helpful in some scenarios (for example when manipulating virtual paths such as "regular" paths of a PHAR).

The original code comes from webmozart/path-util from which the path part was extracted. The library is very stable, well tested and documented. It has been heavily used in Puli, which although is no longer active has been a good performance test and is used in several other popular projects such as:

vimeo/psalm
drush/drush
infection/infection
humbug/box
humbug/php-scoper
phpbench/phpbench

It however suffers from lack of maintener from @webmozart which no longer has time to maintain it.

carsonbot added Status: Needs Review Feature Filesystem labels

theofidry added 24 commits


          Add the Path class

f44ebad


          Cleanup

fc4b4b3

- Apply fabbot CS fixes
- Change the header
- Remove the `@since` tags


          Fix the tests

7b27b73


          Fix CS

01840de


          Address various comments

fc46e02


          Replace static usages by self

f8a0062


          Add the mbstring polyfill

73f84f9


          Remove unnused variable

03a70e0


          Fix CS

a45056d


          Fix CS

3042df6


          Use the Filesystem exceptions instead of the PHP root ones

5c9fe3b


          Add myself as an author

c2f43b0


          Remove getFilename()

4a656c0


          Use long lines

a06f9c3


          Mark Path as experimental

e97f4fe


          Remove non-useful phpdoc

3b4e273


          Fix PathTest

f807db3


          Add myself to PathTest

a912bfd


          Apply path

fde3f3b


          Fix the experimental tag

7efea8c


          Various tweaks

471d990


          Update changelog

526b143


          Fix CS

f61a6d7


          Fix fabbot cs

aaa6d2a

theofidry force-pushed the theofidry:feature/path-component branch from 67755b1 to aaa6d2a


          Fix error message formatting

6ac1555

OskarStark reviewed

src/Symfony/Component/Filesystem/Path.php

  
             * ".." segments at the beginning of relative paths are not removed.

             *

             * ```php

             * echo Path::canonicalize("\webmozart\puli\..\css\style.css");

OskarStark Jul 3, 2021
Contributor

While I would agree keeping this as credits, should we change "webmozart" to "symfony" in examples?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment