wikimedia / mediawiki

includes/filebackend/FileBackend.php

Doc Comments +2 added lines, -2 removed lines

@@ -192,7 +192,7 @@ 
 	/**
 	 * Get an explanatory message if this backend is read-only
 	 *
-	 * @return string|bool Returns false if the backend is not read-only
+	 * @return string|false Returns false if the backend is not read-only
 	 */
 	final public function getReadOnlyReason() {
 		return ( $this->readOnly != '' ) ? $this->readOnly : false;
@@ -1392,7 +1392,7 @@ 
 	 * "mwstore://backend/container/...", or null if there is no parent.
 	 *
 	 * @param string $storagePath
-	 * @return string|null
+	 * @return string
 	 */
 	final public static function parentStoragePath( $storagePath ) {
 		$storagePath = dirname( $storagePath );

includes/filebackend/FileBackendStore.php

Doc Comments +4 added lines, -4 removed lines

@@ -753,7 +753,7 @@ 
 	/**
 	 * @see FileBackendStore::getFileSha1Base36()
 	 * @param array $params
-	 * @return bool|string
+	 * @return false|string
 	 */
 	protected function doGetFileSha1Base36( array $params ) {
 		$fsFile = $this->getLocalReference( $params );
@@ -1190,7 +1190,7 @@ 
 	 * @param FileBackendStoreOpHandle[] $fileOpHandles
 	 *
 	 * @throws FileBackendError
-	 * @return array Map of Status objects
+	 * @return Status[] Map of Status objects
 	 */
 	final public function executeOpHandlesInternal( array $fileOpHandles ) {
 		$ps = Profiler::instance()->scopedProfileIn( __METHOD__ . "-{$this->name}" );
@@ -1578,7 +1578,7 @@ 
 	 * Subclasses can override this to be more restrictive.
 	 *
 	 * @param string $container
-	 * @return string|null
+	 * @return string
 	 */
 	protected function resolveContainerName( $container ) {
 		return $container;
@@ -1592,7 +1592,7 @@ 
 	 *
 	 * @param string $container Container name
 	 * @param string $relStoragePath Storage path relative to the container
-	 * @return string|null Path or null if not valid
+	 * @return string Path or null if not valid
 	 */
 	protected function resolveContainerPath( $container, $relStoragePath ) {
 		return $relStoragePath;

includes/filebackend/filejournal/FileJournal.php

Doc Comments +2 added lines, -2 removed lines

@@ -216,7 +216,7 @@ 
 
 	/**
 	 * @see FileJournal::doGetCurrentPosition()
-	 * @return int|bool
+	 * @return boolean
 	 */
 	protected function doGetCurrentPosition() {
 		return false;
@@ -225,7 +225,7 @@ 
 	/**
 	 * @see FileJournal::doGetPositionAtTime()
 	 * @param int|string $time Timestamp
-	 * @return int|bool
+	 * @return boolean
 	 */
 	protected function doGetPositionAtTime( $time ) {
 		return false;

includes/filebackend/FileOp.php

Doc Comments +1 added lines, -1 removed lines

@@ -128,7 +128,7 @@
 	 * Get the value of the parameter with the given name
 	 *
 	 * @param string $name
-	 * @return mixed Returns null if the parameter is not set
+	 * @return string Returns null if the parameter is not set
 	 */
 	final public function getParam( $name ) {
 		return isset( $this->params[$name] ) ? $this->params[$name] : null;

includes/filebackend/FSFile.php

Doc Comments +4 added lines, -4 removed lines

@@ -63,7 +63,7 @@ 
 	/**
 	 * Get the file size in bytes
 	 *
-	 * @return int|bool
+	 * @return integer
 	 */
 	public function getSize() {
 		return filesize( $this->path );
@@ -72,7 +72,7 @@ 
 	/**
 	 * Get the file's last-modified timestamp
 	 *
-	 * @return string|bool TS_MW timestamp or false on failure
+	 * @return string|false TS_MW timestamp or false on failure
 	 */
 	public function getTimestamp() {
 		MediaWiki\suppressWarnings();
@@ -195,7 +195,7 @@ 
 	 * fairly neatly.
 	 *
 	 * @param bool $recache
-	 * @return bool|string False on failure
+	 * @return string|false False on failure
 	 */
 	public function getSha1Base36( $recache = false ) {
 
@@ -248,7 +248,7 @@ 
 	 * fairly neatly.
 	 *
 	 * @param string $path
-	 * @return bool|string False on failure
+	 * @return string|false False on failure
 	 */
 	public static function getSha1Base36FromPath( $path ) {
 		$fsFile = new self( $path );

includes/filebackend/SwiftFileBackend.php

Doc Comments +5 added lines, -5 removed lines

@@ -1290,7 +1290,7 @@ 
 	 * (lists are truncated to 10000 item with no way to page), and is just a performance risk.
 	 *
 	 * @param string $container Resolved Swift container
-	 * @param array $readGrps List of the possible criteria for a request to have
+	 * @param string[] $readGrps List of the possible criteria for a request to have
 	 * access to read a container. Each item is one of the following formats:
 	 *   - account:user        : Grants access if the request is by the given user
 	 *   - ".r:<regex>"        : Grants access if the request is from a referrer host that
@@ -1298,7 +1298,7 @@ 
 	 *                           Setting this to '*' effectively makes a container public.
 	 *   -".rlistings:<regex>" : Grants access if the request is from a referrer host that
 	 *                           matches the expression and the request is for a listing.
-	 * @param array $writeGrps A list of the possible criteria for a request to have
+	 * @param string[] $writeGrps A list of the possible criteria for a request to have
 	 * access to write to a container. Each item is of the following format:
 	 *   - account:user       : Grants access if the request is by the given user
 	 * @return Status
@@ -1681,7 +1681,7 @@ 
 	 * @param array $creds From getAuthentication()
 	 * @param string $container
 	 * @param string $object
-	 * @return array
+	 * @return string
 	 */
 	protected function storageUrl( array $creds, $container = null, $object = null ) {
 		$parts = array( $creds['storage_url'] );
@@ -1880,7 +1880,7 @@ 
 class SwiftFileBackendDirList extends SwiftFileBackendList {
 	/**
 	 * @see Iterator::current()
-	 * @return string|bool String (relative path) or false
+	 * @return string String (relative path) or false
 	 */
 	public function current() {
 		return substr( current( $this->bufferIter ), $this->suffixStart, -1 );
@@ -1897,7 +1897,7 @@ 
 class SwiftFileBackendFileList extends SwiftFileBackendList {
 	/**
 	 * @see Iterator::current()
-	 * @return string|bool String (relative path) or false
+	 * @return string String (relative path) or false
 	 */
 	public function current() {
 		list( $path, $stat ) = current( $this->bufferIter );

includes/filerepo/file/ArchivedFile.php

Doc Comments +2 added lines, -2 removed lines

@@ -215,7 +215,7 @@ 
 
 	/**
 	 * Fields in the filearchive table
-	 * @return array
+	 * @return string[]
 	 */
 	static function selectFields() {
 		return array(
@@ -421,7 +421,7 @@ 
 	/**
 	 * Returns the number of pages of a multipage document, or false for
 	 * documents which aren't multipage documents
-	 * @return bool|int
+	 * @return string|boolean
 	 */
 	function pageCount() {
 		if ( !isset( $this->pageCount ) ) {

includes/filerepo/file/File.php

Doc Comments +13 added lines, -13 removed lines

@@ -160,7 +160,7 @@ 
 	 * Most subclasses will want to call assertRepoDefined() here.
 	 *
 	 * @param Title|string|bool $title
-	 * @param FileRepo|bool $repo
+	 * @param FileRepo $repo
 	 */
 	function __construct( $title, $repo ) {
 		// Some subclasses do not use $title, but set name/title some other way
@@ -411,7 +411,7 @@ 
 	 * Most callers don't check the return value, but ForeignAPIFile::getPath
 	 * returns false.
 	 *
-	 * @return string|bool ForeignAPIFile::getPath can return false
+	 * @return string ForeignAPIFile::getPath can return false
 	 */
 	public function getPath() {
 		if ( !isset( $this->path ) ) {
@@ -457,7 +457,7 @@ 
 	 * Overridden by LocalFile, UnregisteredLocalFile
 	 *
 	 * @param int $page
-	 * @return int|bool
+	 * @return boolean
 	 */
 	public function getWidth( $page = 1 ) {
 		return false;
@@ -471,7 +471,7 @@ 
 	 * Overridden by LocalFile, UnregisteredLocalFile
 	 *
 	 * @param int $page
-	 * @return bool|int False on failure
+	 * @return boolean False on failure
 	 */
 	public function getHeight( $page = 1 ) {
 		return false;
@@ -484,7 +484,7 @@ 
 	 *
 	 * @param int $desiredWidth
 	 * @param int $page
-	 * @return bool|int
+	 * @return integer
 	 */
 	public function getThumbnailBucket( $desiredWidth, $page = 1 ) {
 		global $wgThumbnailBuckets, $wgThumbnailMinimumBucketDistance;
@@ -633,7 +633,7 @@ 
 	 * Get handler-specific metadata
 	 * Overridden by LocalFile, UnregisteredLocalFile
 	 * STUB
-	 * @return bool|array
+	 * @return boolean
 	 */
 	public function getMetadata() {
 		return false;
@@ -642,7 +642,7 @@ 
 	/**
 	 * Like getMetadata but returns a handler independent array of common values.
 	 * @see MediaHandler::getCommonMetaArray()
-	 * @return array|bool Array or false if not supported
+	 * @return boolean Array or false if not supported
 	 * @since 1.23
 	 */
 	public function getCommonMetaArray() {
@@ -660,7 +660,7 @@ 
 	 *
 	 * @param array|string $metadata Array or string of (serialized) metadata
 	 * @param int $version Version number.
-	 * @return array Array containing metadata, or what was passed to it on fail
+	 * @return ApiResult Array containing metadata, or what was passed to it on fail
 	 *   (unserializing if not array)
 	 */
 	public function convertMetadataVersion( $metadata, $version ) {
@@ -1359,7 +1359,7 @@ 
 	/**
 	 * Get a MediaHandler instance for this file
 	 *
-	 * @return MediaHandler|bool Registered MediaHandler for file's MIME type
+	 * @return MediaHandler Registered MediaHandler for file's MIME type
 	 *   or false if none found
 	 */
 	function getHandler() {
@@ -1782,7 +1782,7 @@ 
 	 * @param bool $watch
 	 * @param string|bool $timestamp
 	 * @param null|User $user User object or null to use $wgUser
-	 * @return bool
+	 * @return boolean|null
 	 * @throws MWException
 	 */
 	function recordUpload( $oldver, $desc, $license = '', $copyStatus = '', $source = '',
@@ -1817,7 +1817,7 @@ 
 	}
 
 	/**
-	 * @param bool|IContextSource $context Context to use (optional)
+	 * @param IContextSource $context Context to use (optional)
 	 * @return bool
 	 */
 	function formatMetadata( $context = false ) {
@@ -1964,7 +1964,7 @@ 
 	 * Returns the number of pages of a multipage document, or false for
 	 * documents which aren't multipage documents
 	 *
-	 * @return bool|int
+	 * @return string|boolean
 	 */
 	function pageCount() {
 		if ( !isset( $this->pageCount ) ) {
@@ -2108,7 +2108,7 @@ 
 	 * Returns false if the file does not have a description page, or retrieving the timestamp
 	 * would be expensive.
 	 * @since 1.25
-	 * @return string|bool
+	 * @return boolean
 	 */
 	public function getDescriptionTouched() {
 		return false;

includes/filerepo/file/ForeignAPIFile.php

Doc Comments +5 added lines, -5 removed lines

@@ -33,7 +33,7 @@ 
 	protected $repoClass = 'ForeignApiRepo';
 
 	/**
-	 * @param Title|string|bool $title
+	 * @param Title|null $title
 	 * @param ForeignApiRepo $repo
 	 * @param array $info
 	 * @param bool $exists
@@ -151,7 +151,7 @@ 
 
 	/**
 	 * @param int $page
-	 * @return int|number
+	 * @return integer
 	 */
 	public function getWidth( $page = 1 ) {
 		return isset( $this->mInfo['width'] ) ? intval( $this->mInfo['width'] ) : 0;
@@ -166,7 +166,7 @@ 
 	}
 
 	/**
-	 * @return bool|null|string
+	 * @return string|null
 	 */
 	public function getMetadata() {
 		if ( isset( $this->mInfo['metadata'] ) ) {
@@ -205,7 +205,7 @@ 
 	}
 
 	/**
-	 * @return bool|int|null
+	 * @return integer|null
 	 */
 	public function getSize() {
 		return isset( $this->mInfo['size'] ) ? intval( $this->mInfo['size'] ) : null;
@@ -268,7 +268,7 @@ 
 	}
 
 	/**
-	 * @return bool|string
+	 * @return string|false
 	 */
 	function getTimestamp() {
 		return wfTimestamp( TS_MW,