*
* @since 1.19
*
- * @param string|false $action
+ * @param string|bool $action
*/
public function setAction( $action ) {
$this->mAction = $action;
* Parses the headers, including the HTTP status code and any
* Set-Cookie headers. This function expectes the headers to be
* found in an array in the member variable headerList.
- *
- * @return nothing
*/
protected function parseHeader() {
$lastname = "";
* RFC2616, section 10,
* http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for a
* list of status codes.)
- *
- * @return nothing
*/
protected function setStatus() {
if ( !$this->respHeaders ) {
*
* A bare IPv6 address is accepted despite the lack of square brackets.
*
- * @param $both The string with the host and port
+ * @param $both string The string with the host and port
* @return array
*/
public static function splitHostAndPort( $both ) {
* This will make a broken link if $file is false.
*
* @param $title Title object.
- * @param $file File|false mixed File object or false
+ * @param $file File|bool mixed File object or false
* @param $html String: pre-sanitized HTML
* @return String: HTML
*
*
* @param $text string
*
- * @return string|false
+ * @return string|bool
*/
public function matchStartToEnd( $text ) {
$hash = $this->getHash();
*
* @param $text string
*
- * @return int|false
+ * @return int|bool
*/
public function matchStartAndRemove( &$text ) {
$regexes = $this->getRegexStart();
/**
* Add new language links
*
- * @param $newLinkArray Associative array mapping language code to the page
+ * @param $newLinkArray array Associative array mapping language code to the page
* name
*/
public function addLanguageLinks( $newLinkArray ) {
/**
* Reset the language links and add new language links
*
- * @param $newLinkArray Associative array mapping language code to the page
+ * @param $newLinkArray array Associative array mapping language code to the page
* name
*/
public function setLanguageLinks( $newLinkArray ) {
/**
* Set the displayed file version
*
- * @param $file File|false
+ * @param $file File|bool
* @return Mixed: previous value
*/
public function setFileVersion( $file ) {
* By default, all parameters passed in the URL are used, except for a
* short blacklist.
*
- * @return Associative array
+ * @return array Associative array
*/
function getDefaultQuery() {
if ( !isset( $this->mDefaultQuery ) ) {
/**
* Add a new path pattern to the path router
*
- * @param $path The path pattern to add
- * @param $params The params for this path pattern
- * @param $options The options for this path pattern
+ * @param $path string The path pattern to add
+ * @param $params array The params for this path pattern
+ * @param $options array The options for this path pattern
*/
public function add( $path, $params = array(), $options = array() ) {
if ( is_array( $path ) ) {
/**
* Parse a path and return the query matches for the path
*
- * @param $path The path to parse
+ * @param $path string The path to parse
* @return Array The array of matches for the path
*/
public function parse( $path ) {
/**
* Fetch the set of available skins.
- * @return associative array of strings
+ * @return array associative array of strings
*/
static function getSkinNames() {
global $wgValidSkinNames;
/**
* Get a Message object with its context set
*
- * @param $name Str message name
+ * @param $name string message name
* @return Message
*/
public function getMsg( $name ) {
*
* @param $user User object to check permissions, $wgUser will be used
* if not provided
- * @return Associative array mapping page's name to its SpecialPage object
+ * @return array Associative array mapping page's name to its SpecialPage object
* @deprecated since 1.18 call SpecialPageFactory method directly
*/
static function getUsablePages( User $user = null ) {
/**
* Return categorised listable special pages for all users
*
- * @return Associative array mapping page's name to its SpecialPage object
+ * @return array Associative array mapping page's name to its SpecialPage object
* @deprecated since 1.18 call SpecialPageFactory method directly
*/
static function getRegularPages() {
* Return categorised listable special pages which are available
* for the current user, but not for everyone
*
- * @return Associative array mapping page's name to its SpecialPage object
+ * @return array Associative array mapping page's name to its SpecialPage object
* @deprecated since 1.18 call SpecialPageFactory method directly
*/
static function getRestrictedPages() {
* False otherwise.
*
* @param $par String Subpage string
- * @return Title|false
+ * @return Title|bool
*/
abstract public function getRedirect( $par );
* Load Title object fields from a DB row.
* If false is given, the title will be treated as non-existing.
*
- * @param $row Object|false database row
+ * @param $row Object|bool database row
* @return void
*/
public function loadFromRow( $row ) {
/**
* Get the username corresponding to a given user ID
* @param $id Int User ID
- * @return String|false The corresponding username
+ * @return String|bool The corresponding username
*/
public static function whoIs( $id ) {
$dbr = wfGetDB( DB_SLAVE );
* Get the real name of a user given their user ID
*
* @param $id Int User ID
- * @return String|false The corresponding user's real name
+ * @return String|bool The corresponding user's real name
*/
public static function whoIsReal( $id ) {
$dbr = wfGetDB( DB_SLAVE );
/**
* Creates a single string from an associative array
*
- * @param $headers Associative Array: keys are header field names,
+ * @param $headers array Associative Array: keys are header field names,
* values are ... values.
* @param $endl String: The end of line character. Defaults to "\n"
* @return String
* Get a request header, or false if it isn't set
* @param $name String: case-insensitive header name
*
- * @return string|false
+ * @return string|bool
*/
public function getHeader( $name ) {
$this->initHeaders();
* Revision::FOR_PUBLIC to be displayed to all users
* Revision::FOR_THIS_USER to be displayed to $wgUser
* Revision::RAW get the text regardless of permissions
- * @return String|false The text of the current revision
+ * @return String|bool The text of the current revision
*/
public function getText( $audience = Revision::FOR_PUBLIC ) {
$this->loadLastEdit();
/**
* Get the text of the current revision. No side-effects...
*
- * @return String|false The text of the current revision
+ * @return String|bool The text of the current revision
*/
public function getRawText() {
$this->loadLastEdit();
* If the given revision is newer than the currently set page_latest,
* update the page record. Otherwise, do nothing.
*
- * @param $dbw Database object
+ * @param $dbw DatabaseBase object
* @param $revision Revision object
* @return mixed
*/
/**
* Shortcut to make a specific element with a class attribute
- * @param $text content of the element, will be escaped
- * @param $class class name of the span element
+ * @param $text string content of the element, will be escaped
+ * @param $class string class name of the span element
* @param $tag string element name
* @param $attribs array other attributes
* @return string
/**
* Open a PG connection with given parameters
- * @param $user User name
- * @param $password Password
- * @param $dbName Database name
+ * @param $user string User name
+ * @param $password string Password
+ * @param $dbName string Database name
* @return Status
*/
protected function openConnectionWithParams( $user, $password, $dbName ) {
* separate connection for this allows us to avoid accidental cross-module
* dependencies.
*
- * @param $type The type of connection to get:
+ * @param $type string The type of connection to get:
* - create-db: A connection for creating DBs, suitable for pre-
* installation.
* - create-schema: A connection to the new DB, for creating schemas and
* other similar objects in the new DB.
* - create-tables: A connection with a role suitable for creating tables.
*
- * @return A Status object. On success, a connection object will be in the
+ * @return Status object. On success, a connection object will be in the
* value member.
*/
protected function openPgConnection( $type ) {
/**
* Recursive helper for canCreateObjectsForWebUser().
- * @param $conn Database object
- * @param $targetMember Role ID of the member to look for
- * @param $group Role ID of the group to look for
- * @param $maxDepth Maximum recursive search depth
+ * @param $conn DatabaseBase object
+ * @param $targetMember int Role ID of the member to look for
+ * @param $group int Role ID of the group to look for
+ * @param $maxDepth int Maximum recursive search depth
+ * @return bool
*/
protected function isRoleMember( $conn, $targetMember, $group, $maxDepth ) {
if ( $targetMember === $group ) {
*
* @since 1.19
*
- * @param $parameters Associative array
+ * @param $parameters array Associative array
*/
public function setParameters( $parameters ) {
$this->parameters = $parameters;
* @param $types String|Array Log types to show
* @param $page String|Title The page title to show log entries for
* @param $user String The user who made the log entries
- * @param $param Associative Array with the following additional options:
+ * @param $param array Associative Array with the following additional options:
* - lim Integer Limit of items to show, default is 50
* - conds Array Extra conditions for the query (e.g. "log_action != 'revision'")
* - showIfEmpty boolean Set to false if you don't want any output in case the loglist is empty
* They don't really have native metadata, so just merges together
* XMP and image comment.
*
- * @param $filename full path to file
+ * @param $filename string full path to file
* @return Array metadata array
*/
static public function GIF ( $filename ) {
* sub-blocks in the returned value. Normally this is false,
* except XMP is weird and does a hack where you need to keep
* these length bytes.
- * @return The data.
+ * @return string The data.
*/
static function readBlock( $fh, $includeLengths = false ) {
$data = '';
* Check for zero-sized thumbnails. These can be generated when
* no disk space is available or some other error occurs
*
- * @param $dstPath The location of the suspect file
- * @param $retval Return value of some shell process, file will be deleted if this is non-zero
+ * @param $dstPath string The location of the suspect file
+ * @param $retval int Return value of some shell process, file will be deleted if this is non-zero
* @return bool if removed, false otherwise
*/
function removeBadFile( $dstPath, $retval = 0 ) {
/**
* Accessor/mutator for the Title object
*
- * @param $x New Title object or null to just get the current one
+ * @param $x Title object or null to just get the current one
* @return Title object
*/
function Title( $x = null ) {
* Return the text to be used for a given extension tag.
* This is the ghost of strip().
*
- * @param $params Associative array of parameters:
+ * @param $params array Associative array of parameters:
* name PPNode for the tag name
* attr PPNode for unparsed text where tag attributes are thought to be
* attributes Optional associative array of parsed attributes
* $args is optionally a multi-root PPNode or array containing the template arguments
*
* @param $args PPNode_Hash_Array|array
- * @param $title Title|false
+ * @param $title Title|bool
*
* @return PPTemplateFrame_Hash
*/
/**
* Get log parameter array.
- * @param $params Associative array of log parameters, same as updateLog()
+ * @param $params array Associative array of log parameters, same as updateLog()
* @return array
*/
public function getLogParams( $params ) {
*
* @param $n Integer: the new bitfield.
* @param $o Integer: the old bitfield.
- * @return An array as described above.
+ * @return array An array as described above.
* @since 1.19 public
*/
public static function getChanges( $n, $o ) {
* @since 1.18
* @param $feature String
* @param $data Mixed
- * @return Noolean
+ * @return bool
*/
public function setFeatureData( $feature, $data ) {
$this->features[$feature] = $data;
}
/**
- * @return Double or null if not supported
+ * @return Double|null if not supported
*/
function getScore() {
return null;
/**
* Get the Database object in use
*
- * @return Database
+ * @return DatabaseBase
*/
public function getDatabase() {
return $this->mDb;
* Special page "deleted user contributions".
* Shows a list of the deleted contributions of a user.
*
- * @return none
* @param $par String: (optional) user name of the user for which to show the contributions
*/
function execute( $par ) {
/**
* Pre-cache page existence to speed up link generation
*
- * @param $db Database connection
+ * @param $db DatabaseBase connection
* @param $res ResultWrapper
*/
public function preprocessResults( $db, $res ) {
*
* @param $conds Array
* @param $opts FormOptions
- * @return database result or false (for Recentchangeslinked only)
+ * @return bool|ResultWrapper result or false (for Recentchangeslinked only)
*/
public function doMainQuery( $conds, $opts ) {
$tables = array( 'recentchanges' );
dépôts / lhc / web / wiklou.git / commitdiff