spelling: one

[friendica.git] / src / Util / FileSystem.php

diff --git a/src/Util/FileSystem.php b/src/Util/FileSystem.php
index 33e04788e6921b184ad600f904300b2f2aea50e3..e86d6b595ab324b4262dbcdaad96675fa72b68b5 100644 (file)
--- a/src/Util/FileSystem.php
+++ b/src/Util/FileSystem.php
@@ -1,14 +1,43 @@
 <?php
+/**
+ * @copyright Copyright (C) 2010-2023, the Friendica project
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ */
 
 namespace Friendica\Util;
 
-final class FileSystem
+/**
+ * Util class for filesystem manipulation
+ */
+class FileSystem
 {
        /**
         * @var string a error message
         */
        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 +68,15 @@ 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 resource the open stream rssource
+        *
+        * @throws \UnexpectedValueException
+        */
        public function createStream(string $url)
        {
                $directory = $this->createDir($url);