Skip to content

"An instance of X" phpdocs removal #32973

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

Closed
wants to merge 1 commit into from
Closed

"An instance of X" phpdocs removal #32973

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
3 changes: 1 addition & 2 deletions src/Symfony/Bridge/Doctrine/DependencyInjection/AbstractDoctrineExtension.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,7 @@ abstract class AbstractDoctrineExtension extends Extension
protected $drivers = [];

/**
* @param array $objectManager A configured object manager
* @param ContainerBuilder $container A ContainerBuilder instance
* @param array $objectManager A configured object manager
*
* @throws \InvalidArgumentException
*/
Expand Down
8 changes: 3 additions & 5 deletions src/Symfony/Bundle/FrameworkBundle/HttpCache/HttpCache.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,7 @@ class HttpCache extends BaseHttpCache
protected $kernel;

/**
* @param KernelInterface $kernel A KernelInterface instance
* @param string $cacheDir The cache directory (default used if null)
* @param string $cacheDir The cache directory (default used if null)
*/
public function __construct(KernelInterface $kernel, string $cacheDir = null)
{
Expand All @@ -43,9 +42,8 @@ public function __construct(KernelInterface $kernel, string $cacheDir = null)
/**
* Forwards the Request to the backend and returns the Response.
*
* @param Request $request A Request instance
* @param bool $raw Whether to catch exceptions or not
* @param Response $entry A Response instance (the stale entry if present, null otherwise)
* @param bool $raw Whether to catch exceptions or not
* @param Response $entry A Response instance (the stale entry if present, null otherwise)
*
* @return Response A Response instance
*/
Expand Down
8 changes: 2 additions & 6 deletions src/Symfony/Bundle/FrameworkBundle/Routing/Router.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,12 +36,8 @@ class Router extends BaseRouter implements WarmableInterface, ServiceSubscriberI
private $paramFetcher;

/**
* @param ContainerInterface $container A ContainerInterface instance
* @param mixed $resource The main resource to load
* @param array $options An array of options
* @param RequestContext $context The context
* @param ContainerInterface|null $parameters A ContainerInterface instance allowing to fetch parameters
* @param LoggerInterface|null $logger
* @param mixed $resource The main resource to load
* @param array $options An array of options
*/
public function __construct(ContainerInterface $container, $resource, array $options = [], RequestContext $context = null, ContainerInterface $parameters = null, LoggerInterface $logger = null, string $defaultLocale = null)
{
Expand Down
8 changes: 3 additions & 5 deletions src/Symfony/Bundle/FrameworkBundle/Translation/Translator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,11 +65,9 @@ class Translator extends BaseTranslator implements WarmableInterface
* * debug: Whether to enable debugging or not (false by default)
* * resource_files: List of translation resources available grouped by locale.
*
* @param ContainerInterface $container A ContainerInterface instance
* @param MessageFormatterInterface $formatter The message formatter
* @param string $defaultLocale
* @param array $loaderIds An array of loader Ids
* @param array $options An array of options
* @param string $defaultLocale
* @param array $loaderIds An array of loader Ids
* @param array $options An array of options
*
* @throws InvalidArgumentException
*/
Expand Down
5 changes: 2 additions & 3 deletions src/Symfony/Bundle/TwigBundle/TemplateIterator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,8 @@ class TemplateIterator implements \IteratorAggregate
private $defaultPath;

/**
* @param KernelInterface $kernel A KernelInterface instance
* @param array $paths Additional Twig paths to warm
* @param string|null $defaultPath The directory where global templates can be stored
* @param array $paths Additional Twig paths to warm
* @param string|null $defaultPath The directory where global templates can be stored
*/
public function __construct(KernelInterface $kernel, array $paths = [], string $defaultPath = null)
{
Expand Down
3 changes: 1 addition & 2 deletions src/Symfony/Bundle/WebProfilerBundle/DependencyInjection/WebProfilerExtension.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,7 @@ class WebProfilerExtension extends Extension
/**
* Loads the web profiler configuration.
*
* @param array $configs An array of configuration settings
* @param ContainerBuilder $container A ContainerBuilder instance
* @param array $configs An array of configuration settings
*/
public function load(array $configs, ContainerBuilder $container)
{
Expand Down
8 changes: 2 additions & 6 deletions src/Symfony/Component/BrowserKit/AbstractBrowser.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,7 @@ abstract class AbstractBrowser
private $isMainRequest = true;

/**
* @param array $server The server parameters (equivalent of $_SERVER)
* @param History $history A History instance to store the browser history
* @param CookieJar $cookieJar A CookieJar instance to store the cookies
* @param array $server The server parameters (equivalent of $_SERVER)
*/
public function __construct(array $server = [], History $history = null, CookieJar $cookieJar = null)
{
Expand Down Expand Up @@ -295,7 +293,6 @@ public function clickLink(string $linkText): Crawler
/**
* Submits a form.
*
* @param Form $form A Form instance
* @param array $values An array of form field values
* @param array $serverParameters An array of server parameters
*
Expand Down Expand Up @@ -683,8 +680,7 @@ protected function getAbsoluteUri(string $uri)
/**
* Makes a request from a Request object directly.
*
* @param Request $request A Request instance
* @param bool $changeHistory Whether to update the history or not (only used internally for back(), forward(), and reload())
* @param bool $changeHistory Whether to update the history or not (only used internally for back(), forward(), and reload())
*
* @return Crawler
*/
Expand Down
3 changes: 1 addition & 2 deletions src/Symfony/Component/BrowserKit/CookieJar.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,8 +132,7 @@ public function updateFromSetCookie(array $setCookies, $uri = null)
/**
* Updates the cookie jar from a Response object.
*
* @param Response $response A Response object
* @param string $uri The base URL
* @param string $uri The base URL
*/
public function updateFromResponse(Response $response, string $uri = null)
{
Expand Down
3 changes: 1 addition & 2 deletions src/Symfony/Component/Console/Helper/ProgressBar.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,7 @@ final class ProgressBar
private static $formats;

/**
* @param OutputInterface $output An OutputInterface instance
* @param int $max Maximum steps (0 if unknown)
* @param int $max Maximum steps (0 if unknown)
*/
public function __construct(OutputInterface $output, int $max = 0, float $minSecondsBetweenRedraws = 0.1)
{
Expand Down
9 changes: 3 additions & 6 deletions src/Symfony/Component/Console/Helper/QuestionHelper.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -353,9 +353,8 @@ private function mostRecentlyEnteredValue(string $entered)
/**
* Gets a hidden response from user.
*
* @param OutputInterface $output An Output instance
* @param resource $inputStream The handler resource
* @param bool $trimmable Is the answer trimmable
* @param resource $inputStream The handler resource
* @param bool $trimmable Is the answer trimmable
*
* @throws RuntimeException In case the fallback is deactivated and the response cannot be hidden
*/
Expand Down Expand Up @@ -416,9 +415,7 @@ private function getHiddenResponse(OutputInterface $output, $inputStream, bool $
/**
* Validates an attempt.
*
* @param callable $interviewer A callable that will ask for a question and return the result
* @param OutputInterface $output An Output instance
* @param Question $question A Question instance
* @param callable $interviewer A callable that will ask for a question and return the result
*
* @return mixed The validated response
*
Expand Down
3 changes: 1 addition & 2 deletions src/Symfony/Component/ErrorHandler/FatalErrorHandler/FatalErrorHandlerInterface.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,7 @@ interface FatalErrorHandlerInterface
/**
* Attempts to convert an error into an exception.
*
* @param array $error An array as returned by error_get_last()
* @param FatalErrorException $exception A FatalErrorException instance
* @param array $error An array as returned by error_get_last()
*
* @return FatalErrorException|null A FatalErrorException instance if the class is able to convert the error, null otherwise
*/
Expand Down
4 changes: 0 additions & 4 deletions src/Symfony/Component/ExpressionLanguage/ParsedExpression.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,6 @@ class ParsedExpression extends Expression
{
private $nodes;

/**
* @param string $expression An expression
* @param Node $nodes A Node representing the expression
*/
public function __construct(string $expression, Node $nodes)
{
parent::__construct($expression);
Expand Down
5 changes: 0 additions & 5 deletions src/Symfony/Component/HttpFoundation/Session/Session.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,6 @@ class Session implements SessionInterface, \IteratorAggregate, \Countable
private $data = [];
private $usageIndex = 0;

/**
* @param SessionStorageInterface $storage A SessionStorageInterface instance
* @param AttributeBagInterface $attributes An AttributeBagInterface instance, (defaults null for default AttributeBag)
* @param FlashBagInterface $flashes A FlashBagInterface instance (defaults null for default FlashBag)
*/
public function __construct(SessionStorageInterface $storage = null, AttributeBagInterface $attributes = null, FlashBagInterface $flashes = null)
{
$this->storage = $storage ?: new NativeSessionStorage();
Expand Down
5 changes: 2 additions & 3 deletions src/Symfony/Component/HttpKernel/Config/FileLocator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,8 @@ class FileLocator extends BaseFileLocator
private $path;

/**
* @param KernelInterface $kernel A KernelInterface instance
* @param string|null $path The path the global resource directory
* @param array $paths An array of paths where to look for resources
* @param string|null $path The path the global resource directory
* @param array $paths An array of paths where to look for resources
*/
public function __construct(KernelInterface $kernel, string $path = null, array $paths = [])
{
Expand Down
3 changes: 1 addition & 2 deletions src/Symfony/Component/HttpKernel/EventListener/FragmentListener.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,7 @@ class FragmentListener implements EventSubscriberInterface
private $fragmentPath;

/**
* @param UriSigner $signer A UriSigner instance
* @param string $fragmentPath The path that triggers this listener
* @param string $fragmentPath The path that triggers this listener
*/
public function __construct(UriSigner $signer, string $fragmentPath = '/_fragment')
{
Expand Down
1 change: 0 additions & 1 deletion src/Symfony/Component/HttpKernel/EventListener/LocaleListener.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,6 @@ class LocaleListener implements EventSubscriberInterface
private $requestStack;

/**
* @param RequestStack $requestStack A RequestStack instance
* @param string $defaultLocale The default locale
* @param RequestContextAwareInterface|null $router The router
*/
Expand Down
7 changes: 2 additions & 5 deletions src/Symfony/Component/HttpKernel/EventListener/ProfilerListener.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,8 @@ class ProfilerListener implements EventSubscriberInterface
protected $parents;

/**
* @param Profiler $profiler A Profiler instance
* @param RequestStack $requestStack A RequestStack instance
* @param RequestMatcherInterface|null $matcher A RequestMatcher instance
* @param bool $onlyException True if the profiler only collects data when an exception occurs, false otherwise
* @param bool $onlyMasterRequests True if the profiler only collects data when the request is a master request, false otherwise
* @param bool $onlyException True if the profiler only collects data when an exception occurs, false otherwise
* @param bool $onlyMasterRequests True if the profiler only collects data when the request is a master request, false otherwise
*/
public function __construct(Profiler $profiler, RequestStack $requestStack, RequestMatcherInterface $matcher = null, bool $onlyException = false, bool $onlyMasterRequests = false)
{
Expand Down
7 changes: 3 additions & 4 deletions src/Symfony/Component/HttpKernel/EventListener/RouterListener.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,10 +50,9 @@ class RouterListener implements EventSubscriberInterface
private $debug;

/**
* @param UrlMatcherInterface|RequestMatcherInterface $matcher The Url or Request matcher
* @param RequestStack $requestStack A RequestStack instance
* @param RequestContext|null $context The RequestContext (can be null when $matcher implements RequestContextAwareInterface)
* @param LoggerInterface|null $logger The logger
* @param UrlMatcherInterface|RequestMatcherInterface $matcher The Url or Request matcher
* @param RequestContext|null $context The RequestContext (can be null when $matcher implements RequestContextAwareInterface)
* @param LoggerInterface|null $logger The logger
* @param string $projectDir
* @param bool $debug
*
Expand Down
1 change: 0 additions & 1 deletion src/Symfony/Component/HttpKernel/Fragment/AbstractSurrogateFragmentRenderer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ abstract class AbstractSurrogateFragmentRenderer extends RoutableFragmentRendere
* The "fallback" strategy when surrogate is not available should always be an
* instance of InlineFragmentRenderer.
*
* @param SurrogateInterface $surrogate An Surrogate instance
* @param FragmentRendererInterface $inlineStrategy The inline strategy to use when the surrogate is not supported
* @param UriSigner $signer
*/
Expand Down
1 change: 0 additions & 1 deletion src/Symfony/Component/HttpKernel/Fragment/FragmentRendererInterface.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ interface FragmentRendererInterface
* Renders a URI and returns the Response content.
*
* @param string|ControllerReference $uri A URI as a string or a ControllerReference instance
* @param Request $request A Request instance
* @param array $options An array of options
*
* @return Response A Response instance
Expand Down
6 changes: 2 additions & 4 deletions src/Symfony/Component/HttpKernel/Fragment/RoutableFragmentRenderer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,8 @@ public function setFragmentPath($path)
/**
* Generates a fragment URI for a given controller.
*
* @param ControllerReference $reference A ControllerReference instance
* @param Request $request A Request instance
* @param bool $absolute Whether to generate an absolute URL or not
* @param bool $strict Whether to allow non-scalar attributes or not
* @param bool $absolute Whether to generate an absolute URL or not
* @param bool $strict Whether to allow non-scalar attributes or not
*
* @return string A fragment URI
*/
Expand Down
21 changes: 7 additions & 14 deletions src/Symfony/Component/HttpKernel/HttpCache/HttpCache.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -256,8 +256,7 @@ public function terminate(Request $request, Response $response)
/**
* Forwards the Request to the backend without storing the Response in the cache.
*
* @param Request $request A Request instance
* @param bool $catch Whether to process exceptions
* @param bool $catch Whether to process exceptions
*
* @return Response A Response instance
*/
Expand All @@ -271,8 +270,7 @@ protected function pass(Request $request, $catch = false)
/**
* Invalidates non-safe methods (like POST, PUT, and DELETE).
*
* @param Request $request A Request instance
* @param bool $catch Whether to process exceptions
* @param bool $catch Whether to process exceptions
*
* @return Response A Response instance
*
Expand Down Expand Up @@ -320,8 +318,7 @@ protected function invalidate(Request $request, $catch = false)
* the backend using conditional GET. When no matching cache entry is found,
* it triggers "miss" processing.
*
* @param Request $request A Request instance
* @param bool $catch Whether to process exceptions
* @param bool $catch Whether to process exceptions
*
* @return Response A Response instance
*
Expand Down Expand Up @@ -366,9 +363,7 @@ protected function lookup(Request $request, $catch = false)
* The original request is used as a template for a conditional
* GET request with the backend.
*
* @param Request $request A Request instance
* @param Response $entry A Response instance to validate
* @param bool $catch Whether to process exceptions
* @param bool $catch Whether to process exceptions
*
* @return Response A Response instance
*/
Expand Down Expand Up @@ -429,8 +424,7 @@ protected function validate(Request $request, Response $entry, $catch = false)
* Unconditionally fetches a fresh response from the backend and
* stores it in the cache if is cacheable.
*
* @param Request $request A Request instance
* @param bool $catch Whether to process exceptions
* @param bool $catch Whether to process exceptions
*
* @return Response A Response instance
*/
Expand Down Expand Up @@ -462,9 +456,8 @@ protected function fetch(Request $request, $catch = false)
* All backend requests (cache passes, fetches, cache validations)
* run through this method.
*
* @param Request $request A Request instance
* @param bool $catch Whether to catch exceptions or not
* @param Response $entry A Response instance (the stale entry if present, null otherwise)
* @param bool $catch Whether to catch exceptions or not
* @param Response $entry A Response instance (the stale entry if present, null otherwise)
*
* @return Response A Response instance
*/
Expand Down
7 changes: 3 additions & 4 deletions src/Symfony/Component/HttpKernel/HttpCache/SurrogateInterface.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,10 +78,9 @@ public function process(Request $request, Response $response);
/**
* Handles a Surrogate from the cache.
*
* @param HttpCache $cache An HttpCache instance
* @param string $uri The main URI
* @param string $alt An alternative URI
* @param bool $ignoreErrors Whether to ignore errors or not
* @param string $uri The main URI
* @param string $alt An alternative URI
* @param bool $ignoreErrors Whether to ignore errors or not
*
* @return string
*
Expand Down
13 changes: 5 additions & 8 deletions src/Symfony/Component/HttpKernel/HttpKernel.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,8 +109,7 @@ public function terminateWithException(\Exception $exception, Request $request =
*
* Exceptions are not caught.
*
* @param Request $request A Request instance
* @param int $type The type of the request (one of HttpKernelInterface::MASTER_REQUEST or HttpKernelInterface::SUB_REQUEST)
* @param int $type The type of the request (one of HttpKernelInterface::MASTER_REQUEST or HttpKernelInterface::SUB_REQUEST)
*
* @return Response A Response instance
*
Expand Down Expand Up @@ -174,9 +173,8 @@ private function handleRaw(Request $request, int $type = self::MASTER_REQUEST)
/**
* Filters a response object.
*
* @param Response $response A Response instance
* @param Request $request An error message in case the response is not a Response object
* @param int $type The type of the request (one of HttpKernelInterface::MASTER_REQUEST or HttpKernelInterface::SUB_REQUEST)
* @param Request $request An error message in case the response is not a Response object
* @param int $type The type of the request (one of HttpKernelInterface::MASTER_REQUEST or HttpKernelInterface::SUB_REQUEST)
*
* @return Response The filtered Response instance
*
Expand Down Expand Up @@ -209,9 +207,8 @@ private function finishRequest(Request $request, int $type)
/**
* Handles an exception by trying to convert it to a Response.
*
* @param \Exception $e An \Exception instance
* @param Request $request A Request instance
* @param int $type The type of the request (one of HttpKernelInterface::MASTER_REQUEST or HttpKernelInterface::SUB_REQUEST)
* @param \Exception $e An \Exception instance
* @param int $type The type of the request (one of HttpKernelInterface::MASTER_REQUEST or HttpKernelInterface::SUB_REQUEST)
*
* @throws \Exception
*/
Expand Down
5 changes: 1 addition & 4 deletions src/Symfony/Component/HttpKernel/HttpKernelBrowser.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,7 @@ class HttpKernelBrowser extends AbstractBrowser
private $catchExceptions = true;

/**
* @param HttpKernelInterface $kernel An HttpKernel instance
* @param array $server The server parameters (equivalent of $_SERVER)
* @param History $history A History instance to store the browser history
* @param CookieJar $cookieJar A CookieJar instance to store the cookies
* @param array $server The server parameters (equivalent of $_SERVER)
*/
public function __construct(HttpKernelInterface $kernel, array $server = [], History $history = null, CookieJar $cookieJar = null)
{
Expand Down
Loading