Merge "Add SpecialBlockModifyFormFields hook"

[lhc/web/wiklou.git] / includes / filerepo / file / ArchivedFile.php

diff --git a/includes/filerepo/file/ArchivedFile.php b/includes/filerepo/file/ArchivedFile.php
index 5d72c0c..0d86c70 100644 (file)
--- a/includes/filerepo/file/ArchivedFile.php
+++ b/includes/filerepo/file/ArchivedFile.php
@@ -27,40 +27,73 @@
  * @ingroup FileAbstraction
  */
 class ArchivedFile {
-       /**#@+
-        * @private
-        */
-       var $id, # filearchive row ID
-               $name, # image name
-               $group, # FileStore storage group
-               $key, # FileStore sha1 key
-               $size, # file dimensions
-               $bits, # size in bytes
-               $width, # width
-               $height, # height
-               $metadata, # metadata string
-               $mime, # mime type
-               $media_type, # media type
-               $description, # upload description
-               $user, # user ID of uploader
-               $user_text, # user name of uploader
-               $timestamp, # time of upload
-               $dataLoaded, # Whether or not all this has been loaded from the database (loadFromXxx)
-               $deleted, # Bitfield akin to rev_deleted
-               $sha1, # sha1 hash of file content
-               $pageCount,
-               $archive_name;
+       /** @var int filearchive row ID */
+       private $id;
 
-       /**
-        * @var MediaHandler
-        */
-       var $handler;
-       /**
-        * @var Title
+       /** @var string File name */
+       private $name;
+
+       /** @var string FileStore storage group */
+       private $group;
+
+       /** @var string FileStore SHA-1 key */
+       private $key;
+
+       /** @var int File size in bytes */
+       private $size;
+
+       /** @var int size in bytes */
+       private $bits;
+
+       /** @var int Width */
+       private $width;
+
+       /** @var int Height */
+       private $height;
+
+       /** @var string Metadata string */
+       private $metadata;
+
+       /** @var string MIME type */
+       private $mime;
+
+       /** @var string Media type */
+       private $media_type;
+
+       /** @var string Upload description */
+       private $description;
+
+       /** @var int User ID of uploader */
+       private $user;
+
+       /** @var string User name of uploader */
+       private $user_text;
+
+       /** @var string Time of upload */
+       private $timestamp;
+
+       /** @var bool Whether or not all this has been loaded from the database (loadFromXxx) */
+       private $dataLoaded;
+
+       /** @var int Bitfield akin to rev_deleted */
+       private $deleted;
+
+       /** @var string SHA-1 hash of file content */
+       private $sha1;
+
+       /** @var string Number of pages of a multipage document, or false for
+        * documents which aren't multipage documents
         */
-       var $title; # image title
+       private $pageCount;
 
-       /**#@-*/
+       /** @var string Original base filename */
+       private $archive_name;
+
+       /** @var MediaHandler */
+       protected $handler;
+
+       /** @var Title */
+       protected $title; # image title
 
        /**
         * @throws MWException
@@ -162,8 +195,7 @@ class ArchivedFile {
        /**
         * Loads a file object from the filearchive table
         *
-        * @param $row
-        *
+        * @param stdClass $row
         * @return ArchivedFile
         */
        public static function newFromRow( $row ) {
@@ -205,7 +237,7 @@ class ArchivedFile {
        /**
         * Load ArchivedFile object fields from a DB row.
         *
-        * @param $row Object database row
+        * @param stdClass $row Object database row
         * @since 1.21
         */
        public function loadFromRow( $row ) {
@@ -506,7 +538,7 @@ class ArchivedFile {
        /**
         * for file or revision rows
         *
-        * @param $field Integer: one of DELETED_* bitfield constants
+        * @param int $field One of DELETED_* bitfield constants
         * @return bool
         */
        public function isDeleted( $field ) {
@@ -518,8 +550,8 @@ class ArchivedFile {
        /**
         * Determine if the current user is allowed to view a particular
         * field of this FileStore image file, if it's marked as deleted.
-        * @param $field Integer
-        * @param $user User object to check, or null to use $wgUser
+        * @param int $field
+        * @param null|User $user User object to check, or null to use $wgUser
         * @return bool
         */
        public function userCan( $field, User $user = null ) {