Merge "Function type hints for LinkHolderArray.php"

[lhc/web/wiklou.git] / includes / specials / SpecialUpload.php

diff --git a/includes/specials/SpecialUpload.php b/includes/specials/SpecialUpload.php
index b46f942..01c0aaf 100644 (file)
--- a/includes/specials/SpecialUpload.php
+++ b/includes/specials/SpecialUpload.php
@@ -32,7 +32,7 @@ class SpecialUpload extends SpecialPage {
        /**
         * Constructor : initialise object
         * Get data POSTed through the form and assign them to the object
-        * @param $request WebRequest : data posted.
+        * @param WebRequest $request Data posted.
         */
        public function __construct( $request = null ) {
                parent::__construct( 'Upload', 'upload' );
@@ -133,8 +133,8 @@ class SpecialUpload extends SpecialPage {
         * Handle permission checking elsewhere in order to be able to show
         * custom error messages.
         *
-        * @param $user User object
-        * @return Boolean
+        * @param User $user
+        * @return bool
         */
        public function userCanExecute( User $user ) {
                return UploadBase::isEnabled() && parent::userCanExecute( $user );
@@ -142,6 +142,7 @@ class SpecialUpload extends SpecialPage {
 
        /**
         * Special page entry point
+        * @param string $par
         */
        public function execute( $par ) {
                $this->setHeaders();
@@ -202,7 +203,7 @@ class SpecialUpload extends SpecialPage {
        /**
         * Show the main upload form
         *
-        * @param $form Mixed: an HTMLForm instance or HTML string to show
+        * @param HTMLForm|string $form An HTMLForm instance or HTML string to show
         */
        protected function showUploadForm( $form ) {
                # Add links if file was previously deleted
@@ -221,8 +222,8 @@ class SpecialUpload extends SpecialPage {
         * Get an UploadForm instance with title and text properly set.
         *
         * @param string $message HTML string to add to the form
-        * @param string $sessionKey session key in case this is a stashed upload
-        * @param $hideIgnoreWarning Boolean: whether to hide "ignore warning" check box
+        * @param string $sessionKey Session key in case this is a stashed upload
+        * @param bool $hideIgnoreWarning Whether to hide "ignore warning" check box
         * @return UploadForm
         */
        protected function getUploadForm( $message = '', $sessionKey = '', $hideIgnoreWarning = false ) {
@@ -328,9 +329,9 @@ class SpecialUpload extends SpecialPage {
         * Stashes the upload, shows the main form, but adds a "continue anyway button".
         * Also checks whether there are actually warnings to display.
         *
-        * @param $warnings Array
-        * @return boolean true if warnings were displayed, false if there are no
-        *         warnings and it should continue processing
+        * @param array $warnings
+        * @return bool True if warnings were displayed, false if there are no
+        *   warnings and it should continue processing
         */
        protected function showUploadWarning( $warnings ) {
                # If there are no warnings, or warnings we can ignore, return early.
@@ -535,7 +536,7 @@ class SpecialUpload extends SpecialPage {
         *
         * Note that the page target can be changed *on the form*, so our check
         * state can get out of sync.
-        * @return Bool|String
+        * @return bool|string
         */
        protected function getWatchCheck() {
                if ( $this->getUser()->getOption( 'watchdefault' ) ) {
@@ -563,7 +564,7 @@ class SpecialUpload extends SpecialPage {
        /**
         * Provides output to the user for a result of UploadBase::verifyUpload
         *
-        * @param array $details result of UploadBase::verifyUpload
+        * @param array $details Result of UploadBase::verifyUpload
         * @throws MWException
         */
        protected function processVerificationError( $details ) {
@@ -642,7 +643,7 @@ class SpecialUpload extends SpecialPage {
        /**
         * Remove a temporarily kept file stashed by saveTempUploadedFile().
         *
-        * @return Boolean: success
+        * @return bool Success
         */
        protected function unsaveUploadedFile() {
                if ( !( $this->mUpload instanceof UploadFromStash ) ) {
@@ -664,8 +665,8 @@ class SpecialUpload extends SpecialPage {
         * Formats a result of UploadBase::getExistsWarning as HTML
         * This check is static and can be done pre-upload via AJAX
         *
-        * @param array $exists the result of UploadBase::getExistsWarning
-        * @return String: empty string if there is no warning or an HTML fragment
+        * @param array $exists The result of UploadBase::getExistsWarning
+        * @return string Empty string if there is no warning or an HTML fragment
         */
        public static function getExistsWarning( $exists ) {
                if ( !$exists ) {
@@ -716,7 +717,7 @@ class SpecialUpload extends SpecialPage {
 
        /**
         * Construct a warning and a gallery from an array of duplicate files.
-        * @param $dupes array
+        * @param array $dupes
         * @return string
         */
        public function getDupeWarning( $dupes ) {
@@ -807,7 +808,7 @@ class UploadForm extends HTMLForm {
         * Get the descriptor of the fieldset that contains the file source
         * selection. The section is 'source'
         *
-        * @return Array: descriptor array
+        * @return array Descriptor array
         */
        protected function getSourceSection() {
                global $wgCopyUploadsFromSpecialUpload;
@@ -901,7 +902,7 @@ class UploadForm extends HTMLForm {
        /**
         * Get the messages indicating which extensions are preferred and prohibitted.
         *
-        * @return String: HTML string containing the message
+        * @return string HTML string containing the message
         */
        protected function getExtensionsMessage() {
                # Print a list of allowed file extensions, if so configured.  We ignore
@@ -947,7 +948,7 @@ class UploadForm extends HTMLForm {
         * Get the descriptor of the fieldset that contains the file description
         * input. The section is 'description'
         *
-        * @return Array: descriptor array
+        * @return array Descriptor array
         */
        protected function getDescriptionSection() {
                if ( $this->mSessionKey ) {
@@ -1045,7 +1046,7 @@ class UploadForm extends HTMLForm {
         * Get the descriptor of the fieldset that contains the upload options,
         * such as "watch this file". The section is 'options'
         *
-        * @return Array: descriptor array
+        * @return array Descriptor array
         */
        protected function getOptionsSection() {
                $user = $this->getUser();
@@ -1144,7 +1145,7 @@ class UploadForm extends HTMLForm {
 class UploadSourceField extends HTMLTextField {
 
        /**
-        * @param $cellAttributes array
+        * @param array $cellAttributes
         * @return string
         */
        function getLabelHtml( $cellAttributes = array() ) {