Skip to content

Fix some docblocks #33197

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

Merged
merged 1 commit into from
Aug 18, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
use Symfony\Component\Config\Definition\ConfigurationInterface;
use Symfony\Component\Console\Exception\LogicException;
use Symfony\Component\Console\Helper\Table;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Style\StyleInterface;
use Symfony\Component\DependencyInjection\Extension\ExtensionInterface;

Expand All @@ -26,6 +27,9 @@
*/
abstract class AbstractConfigCommand extends ContainerDebugCommand
{
/**
* @param OutputInterface|StyleInterface $output
*/
protected function listBundles($output)
{
$title = 'Available registered bundles with their extension alias if available';
Expand Down
7 changes: 7 additions & 0 deletions src/Symfony/Component/BrowserKit/Cookie.php
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,11 @@ public static function fromString($cookie, $url = null)
);
}

/**
* @param string $dateValue
*
* @return string|null
*/
private static function parseDate($dateValue)
{
// trim single quotes around date if present
Expand All @@ -207,6 +212,8 @@ private static function parseDate($dateValue)
if (false !== $date = date_create($dateValue, new \DateTimeZone('GMT'))) {
return $date->format('U');
}

return null;
}

/**
Expand Down
4 changes: 2 additions & 2 deletions src/Symfony/Component/BrowserKit/CookieJar.php
Original file line number Diff line number Diff line change
Expand Up @@ -111,8 +111,8 @@ public function clear()
/**
* Updates the cookie jar from a response Set-Cookie headers.
*
* @param array $setCookies Set-Cookie headers from an HTTP response
* @param string $uri The base URL
* @param string[] $setCookies Set-Cookie headers from an HTTP response
* @param string $uri The base URL
*/
public function updateFromSetCookie(array $setCookies, $uri = null)
{
Expand Down
5 changes: 5 additions & 0 deletions src/Symfony/Component/Filesystem/Filesystem.php
Original file line number Diff line number Diff line change
Expand Up @@ -743,6 +743,11 @@ private function getSchemeAndHierarchy($filename)
return 2 === \count($components) ? [$components[0], $components[1]] : [null, $components[0]];
}

/**
* @param callable $func
*
* @return mixed
*/
private static function box($func)
{
self::$lastError = null;
Expand Down
26 changes: 13 additions & 13 deletions src/Symfony/Component/Process/Process.php
Original file line number Diff line number Diff line change
Expand Up @@ -217,7 +217,7 @@ public function run($callback = null/*, array $env = []*/)
* This is identical to run() except that an exception is thrown if the process
* exits with a non-zero exit code.
*
* @return self
* @return $this
*
* @throws RuntimeException if PHP was compiled with --enable-sigchild and the enhanced sigchild compatibility mode is not enabled
* @throws ProcessFailedException if the process didn't terminate successfully
Expand Down Expand Up @@ -942,7 +942,7 @@ public function getCommandLine()
*
* @param string|array $commandline The command to execute
*
* @return self The current Process instance
* @return $this
*/
public function setCommandLine($commandline)
{
Expand Down Expand Up @@ -978,7 +978,7 @@ public function getIdleTimeout()
*
* @param int|float|null $timeout The timeout in seconds
*
* @return self The current Process instance
* @return $this
*
* @throws InvalidArgumentException if the timeout is negative
*/
Expand All @@ -996,7 +996,7 @@ public function setTimeout($timeout)
*
* @param int|float|null $timeout The timeout in seconds
*
* @return self The current Process instance
* @return $this
*
* @throws LogicException if the output is disabled
* @throws InvalidArgumentException if the timeout is negative
Expand All @@ -1017,7 +1017,7 @@ public function setIdleTimeout($timeout)
*
* @param bool $tty True to enabled and false to disable
*
* @return self The current Process instance
* @return $this
*
* @throws RuntimeException In case the TTY mode is not supported
*/
Expand Down Expand Up @@ -1058,7 +1058,7 @@ public function isTty()
*
* @param bool $bool
*
* @return self
* @return $this
*/
public function setPty($bool)
{
Expand Down Expand Up @@ -1098,7 +1098,7 @@ public function getWorkingDirectory()
*
* @param string $cwd The new working directory
*
* @return self The current Process instance
* @return $this
*/
public function setWorkingDirectory($cwd)
{
Expand Down Expand Up @@ -1130,7 +1130,7 @@ public function getEnv()
*
* @param array $env The new environment variables
*
* @return self The current Process instance
* @return $this
*/
public function setEnv(array $env)
{
Expand Down Expand Up @@ -1161,7 +1161,7 @@ public function getInput()
*
* @param string|int|float|bool|resource|\Traversable|null $input The content
*
* @return self The current Process instance
* @return $this
*
* @throws LogicException In case the process is running
*/
Expand Down Expand Up @@ -1195,7 +1195,7 @@ public function getOptions()
*
* @param array $options The new options
*
* @return self The current Process instance
* @return $this
*
* @deprecated since version 3.3, to be removed in 4.0.
*/
Expand Down Expand Up @@ -1229,7 +1229,7 @@ public function getEnhanceWindowsCompatibility()
*
* @param bool $enhance
*
* @return self The current Process instance
* @return $this
*
* @deprecated since version 3.3, to be removed in 4.0. Enhanced Windows compatibility will always be enabled.
*/
Expand Down Expand Up @@ -1265,7 +1265,7 @@ public function getEnhanceSigchildCompatibility()
*
* @param bool $enhance
*
* @return self The current Process instance
* @return $this
*
* @deprecated since version 3.3, to be removed in 4.0.
*/
Expand All @@ -1283,7 +1283,7 @@ public function setEnhanceSigchildCompatibility($enhance)
*
* @param bool $inheritEnv
*
* @return self The current Process instance
* @return $this
*/
public function inheritEnvironmentVariables($inheritEnv = true)
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,11 @@ public function __construct(RequestStack $requestStack = null, UrlGeneratorInter
/**
* Registers a firewall's LogoutListener, allowing its URL to be generated.
*
* @param string $key The firewall key
* @param string $logoutPath The path that starts the logout process
* @param string $csrfTokenId The ID of the CSRF token
* @param string $csrfParameter The CSRF token parameter name
* @param CsrfTokenManagerInterface|null $csrfTokenManager A CsrfTokenManagerInterface instance
* @param string $key The firewall key
* @param string $logoutPath The path that starts the logout process
* @param string|null $csrfTokenId The ID of the CSRF token
* @param string|null $csrfParameter The CSRF token parameter name
* @param string|null $context The listener context
*/
public function registerListener($key, $logoutPath, $csrfTokenId, $csrfParameter, CsrfTokenManagerInterface $csrfTokenManager = null/*, string $context = null*/)
{
Expand Down
7 changes: 7 additions & 0 deletions src/Symfony/Component/Workflow/Registry.php
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,13 @@ public function get($subject, $workflowName = null)
return $matched;
}

/**
* @param SupportStrategyInterface $supportStrategy
* @param object $subject
* @param string|null $workflowName
*
* @return bool
*/
private function supports(Workflow $workflow, $supportStrategy, $subject, $workflowName)
{
if (null !== $workflowName && $workflowName !== $workflow->getName()) {
Expand Down