Skip to content

Commit

Permalink
Add usage to HttpSocket::configAuth()
Browse files Browse the repository at this point in the history
Fixes #2336
  • Loading branch information
markstory committed Dec 4, 2011
1 parent 71b41ed commit 1bc3583
Showing 1 changed file with 24 additions and 1 deletion.
25 changes: 24 additions & 1 deletion lib/Cake/Network/Http/HttpSocket.php
Expand Up @@ -157,7 +157,30 @@ public function __construct($config = array()) {
}

/**
* Set authentication settings
* Set authentication settings.
*
* Accepts two forms of parameters. If all you need is a username + password, as with
* Basic authentication you can do the following:
*
* {{{
* $http->configAuth('Basic', 'mark', 'secret');
* }}}
*
* If you are using an authentication strategy that requires more inputs, like Digest authentication
* you can call `configAuth()` with an array of user information.
*
* {{{
* $http->configAuth('Digest', array(
* 'user' => 'mark',
* 'pass' => 'secret',
* 'realm' => 'my-realm',
* 'nonce' => 1235
* ));
* }}}
*
* To remove any set authentication strategy, call `configAuth()` with no parameters:
*
* `$http->configAuth();`
*
* @param string $method Authentication method (ie. Basic, Digest). If empty, disable authentication
* @param mixed $user Username for authentication. Can be an array with settings to authentication class
Expand Down

0 comments on commit 1bc3583

Please sign in to comment.