Skip to content
This repository was archived by the owner on Jan 29, 2020. It is now read-only.

Commit 3cca1a7

Browse files
committed
Update method chaining DocBlocks consistency to self
1 parent 804edca commit 3cca1a7

11 files changed

+28
-28
lines changed

src/Adapter/AbstractAdapter.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ public function getCredential()
3636
* Sets the credential for binding
3737
*
3838
* @param mixed $credential
39-
* @return AbstractAdapter Provides a fluent interface
39+
* @return self Provides a fluent interface
4040
*/
4141
public function setCredential($credential)
4242
{
@@ -60,7 +60,7 @@ public function getIdentity()
6060
* Sets the identity for binding
6161
*
6262
* @param mixed $identity
63-
* @return AbstractAdapter Provides a fluent interface
63+
* @return self Provides a fluent interface
6464
*/
6565
public function setIdentity($identity)
6666
{

src/Adapter/DbTable/AbstractAdapter.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ public function __construct(
105105
* setTableName() - set the table name to be used in the select query
106106
*
107107
* @param string $tableName
108-
* @return AbstractAdapter Provides a fluent interface
108+
* @return self Provides a fluent interface
109109
*/
110110
public function setTableName($tableName)
111111
{
@@ -117,7 +117,7 @@ public function setTableName($tableName)
117117
* setIdentityColumn() - set the column name to be used as the identity column
118118
*
119119
* @param string $identityColumn
120-
* @return AbstractAdapter Provides a fluent interface
120+
* @return self Provides a fluent interface
121121
*/
122122
public function setIdentityColumn($identityColumn)
123123
{
@@ -129,7 +129,7 @@ public function setIdentityColumn($identityColumn)
129129
* setCredentialColumn() - set the column name to be used as the credential column
130130
*
131131
* @param string $credentialColumn
132-
* @return AbstractAdapter Provides a fluent interface
132+
* @return self Provides a fluent interface
133133
*/
134134
public function setCredentialColumn($credentialColumn)
135135
{
@@ -143,7 +143,7 @@ public function setCredentialColumn($credentialColumn)
143143
* false) parameters. Default is false.
144144
*
145145
* @param int|bool $flag
146-
* @return AbstractAdapter Provides a fluent interface
146+
* @return self Provides a fluent interface
147147
*/
148148
public function setAmbiguityIdentity($flag)
149149
{

src/Adapter/DbTable/CallbackCheckAdapter.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ public function __construct(
5656
* credential.
5757
*
5858
* @param callable $validationCallback
59-
* @return CallbackCheckAdapter Provides a fluent interface
59+
* @return self Provides a fluent interface
6060
* @throws Exception\InvalidArgumentException
6161
*/
6262
public function setCredentialValidationCallback($validationCallback)

src/Adapter/DbTable/CredentialTreatmentAdapter.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ public function __construct(
6262
* 'MD5(?)'
6363
*
6464
* @param string $treatment
65-
* @return CredentialTreatmentAdapter Provides a fluent interface
65+
* @return self Provides a fluent interface
6666
*/
6767
public function setCredentialTreatment($treatment)
6868
{

src/Adapter/Digest.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ public function getFilename()
6767
* Sets the filename option value
6868
*
6969
* @param mixed $filename
70-
* @return Digest Provides a fluent interface
70+
* @return self Provides a fluent interface
7171
*/
7272
public function setFilename($filename)
7373
{
@@ -89,7 +89,7 @@ public function getRealm()
8989
* Sets the realm option value
9090
*
9191
* @param mixed $realm
92-
* @return Digest Provides a fluent interface
92+
* @return self Provides a fluent interface
9393
*/
9494
public function setRealm($realm)
9595
{
@@ -111,7 +111,7 @@ public function getUsername()
111111
* Sets the username option value
112112
*
113113
* @param mixed $username
114-
* @return Digest Provides a fluent interface
114+
* @return self Provides a fluent interface
115115
*/
116116
public function setUsername($username)
117117
{
@@ -132,7 +132,7 @@ public function getPassword()
132132
* Sets the password option value
133133
*
134134
* @param mixed $password
135-
* @return Digest Provides a fluent interface
135+
* @return self Provides a fluent interface
136136
*/
137137
public function setPassword($password)
138138
{

src/Adapter/Http.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -220,7 +220,7 @@ public function __construct(array $config)
220220
* Setter for the basicResolver property
221221
*
222222
* @param Http\ResolverInterface $resolver
223-
* @return Http Provides a fluent interface
223+
* @return self Provides a fluent interface
224224
*/
225225
public function setBasicResolver(Http\ResolverInterface $resolver)
226226
{
@@ -243,7 +243,7 @@ public function getBasicResolver()
243243
* Setter for the digestResolver property
244244
*
245245
* @param Http\ResolverInterface $resolver
246-
* @return Http Provides a fluent interface
246+
* @return self Provides a fluent interface
247247
*/
248248
public function setDigestResolver(Http\ResolverInterface $resolver)
249249
{
@@ -266,7 +266,7 @@ public function getDigestResolver()
266266
* Setter for the Request object
267267
*
268268
* @param HTTPRequest $request
269-
* @return Http Provides a fluent interface
269+
* @return self Provides a fluent interface
270270
*/
271271
public function setRequest(HTTPRequest $request)
272272
{
@@ -289,7 +289,7 @@ public function getRequest()
289289
* Setter for the Response object
290290
*
291291
* @param HTTPResponse $response
292-
* @return Http Provides a fluent interface
292+
* @return self Provides a fluent interface
293293
*/
294294
public function setResponse(HTTPResponse $response)
295295
{

src/Adapter/Http/ApacheResolver.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ public function __construct($path = '')
5050
* Set the path to the credentials file
5151
*
5252
* @param string $path
53-
* @return ApacheResolver Provides a fluent interface
53+
* @return self Provides a fluent interface
5454
* @throws Exception\InvalidArgumentException if path is not readable
5555
*/
5656
public function setFile($path)

src/Adapter/Http/FileResolver.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ public function __construct($path = '')
3939
* Set the path to the credentials file
4040
*
4141
* @param string $path
42-
* @return FileResolver Provides a fluent interface
42+
* @return self Provides a fluent interface
4343
* @throws Exception\InvalidArgumentException if path is not readable
4444
*/
4545
public function setFile($path)

src/Adapter/Ldap.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ public function getOptions()
7070
* this adapter.
7171
*
7272
* @param array $options The array of arrays of Zend\Ldap\Ldap options
73-
* @return Ldap Provides a fluent interface
73+
* @return self Provides a fluent interface
7474
*/
7575
public function setOptions($options)
7676
{
@@ -99,7 +99,7 @@ public function getUsername()
9999
* Sets the username for binding
100100
*
101101
* @param string $username The username for binding
102-
* @return Ldap Provides a fluent interface
102+
* @return self Provides a fluent interface
103103
*/
104104
public function setUsername($username)
105105
{
@@ -121,7 +121,7 @@ public function getPassword()
121121
* Sets the password for the account
122122
*
123123
* @param string $password The password of the account being authenticated
124-
* @return Ldap Provides a fluent interface
124+
* @return self Provides a fluent interface
125125
*/
126126
public function setPassword($password)
127127
{
@@ -146,7 +146,7 @@ public function getLdap()
146146
* Set an Ldap connection
147147
*
148148
* @param ZendLdap\Ldap $ldap An existing Ldap object
149-
* @return Ldap Provides a fluent interface
149+
* @return self Provides a fluent interface
150150
*/
151151
public function setLdap(ZendLdap\Ldap $ldap)
152152
{

src/AuthenticationService.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ public function getAdapter()
5757
* Sets the authentication adapter
5858
*
5959
* @param Adapter\AdapterInterface $adapter
60-
* @return AuthenticationService Provides a fluent interface
60+
* @return self Provides a fluent interface
6161
*/
6262
public function setAdapter(Adapter\AdapterInterface $adapter)
6363
{
@@ -85,7 +85,7 @@ public function getStorage()
8585
* Sets the persistent storage handler
8686
*
8787
* @param Storage\StorageInterface $storage
88-
* @return AuthenticationService Provides a fluent interface
88+
* @return self Provides a fluent interface
8989
*/
9090
public function setStorage(Storage\StorageInterface $storage)
9191
{

0 commit comments

Comments
 (0)