For example, documenting the method getUser() with "get the User object" does not add any information that's not already there. But I have to read the text first to understand that it doesn't document anything that's not already obvious from the code. Some of this is from a time when we had a PHPCS sniff that was complaining when a line like `@param User $user` doesn't end with some descriptive text. Some users started adding text like `@param User $user The User` back then. Let's please remove this. Change-Id: I0ea8d051bc732466c73940de9259f87ffb86ce7a
21 lines
526 B
PHP
21 lines
526 B
PHP
<?php
|
|
|
|
class ApiTestContext extends RequestContext {
|
|
|
|
/**
|
|
* Returns a DerivativeContext with the request variables in place
|
|
*
|
|
* @param WebRequest $request WebRequest request object including parameters and session
|
|
* @param User|null $user
|
|
* @return DerivativeContext
|
|
*/
|
|
public function newTestContext( WebRequest $request, User $user = null ) {
|
|
$context = new DerivativeContext( $this );
|
|
$context->setRequest( $request );
|
|
if ( $user !== null ) {
|
|
$context->setUser( $user );
|
|
}
|
|
|
|
return $context;
|
|
}
|
|
}
|