Skip to content

Commit

Permalink
[6.x] Format docs (#30749)
Browse files Browse the repository at this point in the history
* format cookie docs

* simplify if statement

* revert if-else

* fix more docblocks

* more doc formatting
  • Loading branch information
iamgergo authored and taylorotwell committed Dec 4, 2019
1 parent f675d01 commit 6dff618
Show file tree
Hide file tree
Showing 10 changed files with 34 additions and 34 deletions.
4 changes: 2 additions & 2 deletions src/Illuminate/Auth/Access/Gate.php
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ public function define($ability, $callback)
*
* @param string $name
* @param string $class
* @param array|null $abilities
* @param array|null $abilities
* @return $this
*/
public function resource($name, $class, array $abilities = null)
Expand Down Expand Up @@ -379,7 +379,7 @@ public function raw($ability, $arguments = [])
*
* @param \Illuminate\Contracts\Auth\Authenticatable|null $user
* @param \Closure|string|array $class
* @param string|null $method
* @param string|null $method
* @return bool
*/
protected function canBeCalledWithUser($user, $class, $method = null)
Expand Down
2 changes: 1 addition & 1 deletion src/Illuminate/Auth/Access/HandlesAuthorization.php
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ trait HandlesAuthorization
* Create a new access response.
*
* @param string|null $message
* @param mixed $code
* @param mixed $code
* @return \Illuminate\Auth\Access\Response
*/
protected function allow($message = null, $code = null)
Expand Down
8 changes: 4 additions & 4 deletions src/Illuminate/Auth/Access/Response.php
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@ public function __construct($allowed, $message = '', $code = null)
/**
* Create a new "allow" Response.
*
* @param string|null $message
* @param mixed $code
* @param string|null $message
* @param mixed $code
* @return \Illuminate\Auth\Access\Response
*/
public static function allow($message = null, $code = null)
Expand All @@ -57,8 +57,8 @@ public static function allow($message = null, $code = null)
/**
* Create a new "deny" Response.
*
* @param string|null $message
* @param mixed $code
* @param string|null $message
* @param mixed $code
* @return \Illuminate\Auth\Access\Response
*/
public static function deny($message = null, $code = null)
Expand Down
2 changes: 1 addition & 1 deletion src/Illuminate/Auth/Events/Login.php
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ class Login
/**
* Create a new event instance.
*
* @param string $guard
* @param string $guard
* @param \Illuminate\Contracts\Auth\Authenticatable $user
* @param bool $remember
* @return void
Expand Down
2 changes: 1 addition & 1 deletion src/Illuminate/Auth/Events/Logout.php
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ class Logout
/**
* Create a new event instance.
*
* @param string $guard
* @param string $guard
* @param \Illuminate\Contracts\Auth\Authenticatable $user
* @return void
*/
Expand Down
8 changes: 4 additions & 4 deletions src/Illuminate/Auth/Passwords/PasswordBroker.php
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ public function getUser(array $credentials)
/**
* Create a new password reset token for the given user.
*
* @param \Illuminate\Contracts\Auth\CanResetPassword $user
* @param \Illuminate\Contracts\Auth\CanResetPassword $user
* @return string
*/
public function createToken(CanResetPasswordContract $user)
Expand All @@ -154,7 +154,7 @@ public function createToken(CanResetPasswordContract $user)
/**
* Delete password reset tokens of the given user.
*
* @param \Illuminate\Contracts\Auth\CanResetPassword $user
* @param \Illuminate\Contracts\Auth\CanResetPassword $user
* @return void
*/
public function deleteToken(CanResetPasswordContract $user)
Expand All @@ -165,8 +165,8 @@ public function deleteToken(CanResetPasswordContract $user)
/**
* Validate the given password reset token.
*
* @param \Illuminate\Contracts\Auth\CanResetPassword $user
* @param string $token
* @param \Illuminate\Contracts\Auth\CanResetPassword $user
* @param string $token
* @return bool
*/
public function tokenExists(CanResetPasswordContract $user, $token)
Expand Down
2 changes: 1 addition & 1 deletion src/Illuminate/Auth/Passwords/PasswordBrokerManager.php
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ public function setDefaultDriver($name)
* Dynamically call the default driver instance.
*
* @param string $method
* @param array $parameters
* @param array $parameters
* @return mixed
*/
public function __call($method, $parameters)
Expand Down
2 changes: 1 addition & 1 deletion src/Illuminate/Auth/RequestGuard.php
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ class RequestGuard implements Guard
*
* @param callable $callback
* @param \Illuminate\Http\Request $request
* @param \Illuminate\Contracts\Auth\UserProvider|null $provider
* @param \Illuminate\Contracts\Auth\UserProvider|null $provider
* @return void
*/
public function __construct(callable $callback, Request $request, UserProvider $provider = null)
Expand Down
4 changes: 2 additions & 2 deletions src/Illuminate/Auth/SessionGuard.php
Original file line number Diff line number Diff line change
Expand Up @@ -339,7 +339,7 @@ protected function failedBasicResponse()
* Attempt to authenticate a user using the given credentials.
*
* @param array $credentials
* @param bool $remember
* @param bool $remember
* @return bool
*/
public function attempt(array $credentials = [], $remember = false)
Expand Down Expand Up @@ -381,7 +381,7 @@ protected function hasValidCredentials($user, $credentials)
* Log the given user ID into the application.
*
* @param mixed $id
* @param bool $remember
* @param bool $remember
* @return \Illuminate\Contracts\Auth\Authenticatable|false
*/
public function loginUsingId($id, $remember = false)
Expand Down
34 changes: 17 additions & 17 deletions src/Illuminate/Cookie/CookieJar.php
Original file line number Diff line number Diff line change
Expand Up @@ -50,14 +50,14 @@ class CookieJar implements JarContract
/**
* Create a new cookie instance.
*
* @param string $name
* @param string $value
* @param int $minutes
* @param string $name
* @param string $value
* @param int $minutes
* @param string|null $path
* @param string|null $domain
* @param bool|null $secure
* @param bool $httpOnly
* @param bool $raw
* @param bool|null $secure
* @param bool $httpOnly
* @param bool $raw
* @param string|null $sameSite
* @return \Symfony\Component\HttpFoundation\Cookie
*/
Expand All @@ -73,13 +73,13 @@ public function make($name, $value, $minutes = 0, $path = null, $domain = null,
/**
* Create a cookie that lasts "forever" (five years).
*
* @param string $name
* @param string $value
* @param string $name
* @param string $value
* @param string|null $path
* @param string|null $domain
* @param bool|null $secure
* @param bool $httpOnly
* @param bool $raw
* @param bool|null $secure
* @param bool $httpOnly
* @param bool $raw
* @param string|null $sameSite
* @return \Symfony\Component\HttpFoundation\Cookie
*/
Expand Down Expand Up @@ -117,7 +117,7 @@ public function hasQueued($key, $path = null)
* Get a queued cookie instance.
*
* @param string $key
* @param mixed $default
* @param mixed $default
* @param string $path
* @return \Symfony\Component\HttpFoundation\Cookie
*/
Expand Down Expand Up @@ -157,7 +157,7 @@ public function queue(...$parameters)
* Remove a cookie from the queue.
*
* @param string $name
* @param string|null $path
* @param string|null $path
* @return void
*/
public function unqueue($name, $path = null)
Expand All @@ -178,9 +178,9 @@ public function unqueue($name, $path = null)
/**
* Get the path and domain, or the default values.
*
* @param string $path
* @param string $domain
* @param bool|null $secure
* @param string $path
* @param string $domain
* @param bool|null $secure
* @param string|null $sameSite
* @return array
*/
Expand All @@ -194,7 +194,7 @@ protected function getPathAndDomain($path, $domain, $secure = null, $sameSite =
*
* @param string $path
* @param string $domain
* @param bool $secure
* @param bool $secure
* @param string|null $sameSite
* @return $this
*/
Expand Down

0 comments on commit 6dff618

Please sign in to comment.