Thanks to visit codestin.com
Credit goes to github.com

Skip to content

[Config] Provide more precise phpdoc for FileLocatorInterface::locate() #53670

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jan 30, 2024
Merged

[Config] Provide more precise phpdoc for FileLocatorInterface::locate() #53670

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Provide more precise phpdoc for FileLocatorInterface::locate
  • Loading branch information
@VincentLanglet
VincentLanglet committed Jan 29, 2024
commit b2afd326668dcf13d282c927d0c4f15dc6d14dc7
4 changes: 3 additions & 1 deletion src/Symfony/Component/Config/FileLocator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,9 @@ public function __construct(string|array $paths = [])
}

/**
* @return string|array
* @return string|string[]
*
* @psalm-return ($first is true ? string : string[])
*/
public function locate(string $name, ?string $currentPath = null, bool $first = true)
{
Expand Down
4 changes: 3 additions & 1 deletion src/Symfony/Component/Config/FileLocatorInterface.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,12 @@ interface FileLocatorInterface
* @param string|null $currentPath The current path
* @param bool $first Whether to return the first occurrence or an array of filenames
*
* @return string|array The full path to the file or an array of file paths
* @return string|string[] The full path to the file or an array of file paths
*
* @throws \InvalidArgumentException If $name is empty
* @throws FileLocatorFileNotFoundException If a file is not found
*
* @psalm-return ($first is true ? string : string[])
*/
public function locate(string $name, ?string $currentPath = null, bool $first = true);
}