aboutsummaryrefslogtreecommitdiffstats
path: root/includes/filebackend/FSFile.php
diff options
context:
space:
mode:
authorSiebrand Mazeland <s.mazeland@xs4all.nl>2013-11-23 19:23:32 +0100
committerSiebrand Mazeland <s.mazeland@xs4all.nl>2013-11-23 19:24:43 +0100
commit34a4bcbd48bf7af458eb110cc383c5bbb6989a31 (patch)
tree52ce514767b8943134d2c476a9d9e82f6e2c7703 /includes/filebackend/FSFile.php
parenta5c35215e27594ed1577f1748504fee2aafadc4c (diff)
downloadmediawikicore-34a4bcbd48bf7af458eb110cc383c5bbb6989a31.tar.gz
mediawikicore-34a4bcbd48bf7af458eb110cc383c5bbb6989a31.zip
Update documentation of file backend classes
Change-Id: I2113aecc53f1b361d9c276113bc0a9f7076cd21c
Diffstat (limited to 'includes/filebackend/FSFile.php')
-rw-r--r--includes/filebackend/FSFile.php13
1 files changed, 8 insertions, 5 deletions
diff --git a/includes/filebackend/FSFile.php b/includes/filebackend/FSFile.php
index 97ce593114c0..3a0aa9747db2 100644
--- a/includes/filebackend/FSFile.php
+++ b/includes/filebackend/FSFile.php
@@ -27,8 +27,11 @@
* @ingroup FileBackend
*/
class FSFile {
- protected $path; // path to file
- protected $sha1Base36; // file SHA-1 in base 36
+ /** @var string Path to file */
+ protected $path;
+
+ /** @var string File SHA-1 in base 36 */
+ protected $sha1Base36;
/**
* Sets up the file object
@@ -155,7 +158,7 @@ class FSFile {
/**
* Placeholder file properties to use for files that don't exist
*
- * @return Array
+ * @return array
*/
public static function placeholderProps() {
$info = array();
@@ -175,7 +178,7 @@ class FSFile {
* Exract image size information
*
* @param array $gis
- * @return Array
+ * @return array
*/
protected function extractImageSizeInfo( array $gis ) {
$info = array();
@@ -240,7 +243,7 @@ class FSFile {
*
* @param string $path absolute local filesystem path
* @param mixed $ext The file extension, or true to extract it from the filename.
- * Set it to false to ignore the extension.
+ * Set it to false to ignore the extension.
* @return array
*/
public static function getPropsFromPath( $path, $ext = true ) {