Skip to content

Update auth phpDoc #73

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
Feb 20, 2021
Merged

Update auth phpDoc #73

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
10 changes: 7 additions & 3 deletions src/Redis.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2188,15 +2188,19 @@ public function dbSize()
}

/**
* Authenticate the connection using a password.
* Authenticate the connection using a password or a username and password..
* Warning: The password is sent in plain-text over the network.
*
* @param string $password
* @param mixed $password
*
* @return bool TRUE if the connection is authenticated, FALSE otherwise
*
* @link https://redis.io/commands/auth
* @example $redis->auth('foobared');
* @example
* <pre>
* $redis->auth('bar'); // Authenticate with the password 'bar'
* $redis->auth(['user' => 'foo', 'pass' => 'bar]); // Authenticate with the username 'foo', and password 'bar'
* </pre>
*/
public function auth($password)
{
Expand Down