]> git.mxchange.org Git - friendica.git/commitdiff
Add some PHP doc
authorPhilipp Holzer <admin+github@philipp.info>
Tue, 22 Oct 2019 20:51:52 +0000 (22:51 +0200)
committerPhilipp Holzer <admin+github@philipp.info>
Tue, 22 Oct 2019 20:51:52 +0000 (22:51 +0200)
src/Util/FileSystem.php

index 33e04788e6921b184ad600f904300b2f2aea50e3..b3a0ae74de239aa183ac270beb3409527adc2210 100644 (file)
@@ -2,6 +2,9 @@
 
 namespace Friendica\Util;
 
+/**
+ * Util class for filesystem manipulation
+ */
 final class FileSystem
 {
        /**
@@ -9,6 +12,13 @@ final class FileSystem
         */
        private $errorMessage;
 
+       /**
+        * Creates a directory based on a file, which gets accessed
+        *
+        * @param string $file The file
+        *
+        * @return string The directory name (empty if no directory is found, like urls)
+        */
        public function createDir(string $file)
        {
                $dirname = null;
@@ -39,6 +49,13 @@ final class FileSystem
                }
        }
 
+       /**
+        * Creates a stream based on a URL (could be a local file or a real URL)
+        *
+        * @param string $url The file/url
+        *
+        * @return false|resource the open stream ressource
+        */
        public function createStream(string $url)
        {
                $directory = $this->createDir($url);