PHPDoc, demo and function changes

- [Change] Fixed useless PHPDoc stuff
- [Change] Function `FileInfo::getInfo` is now `FileInfo::scan`
- [Change] Return now an array `instead` of `object`
- [New] Added demo project

**Breaking Changes**

Author: TriHydera

.gitignore

@@ -1,2 +1,3 @@
 vendor
-.phpdoc
+.phpdoc
+message.txt

composer.json

@@ -15,5 +15,7 @@
         }
     ],
     "minimum-stability": "stable",
-    "require": {}
+    "require-dev": {
+        "phpstan/phpstan": "^1.11"
+    }
 }

composer.lock

@@ -0,0 +1,8 @@
+<?php
+require __DIR__.'/../vendor/autoload.php';
+
+$fi = new Trihydera\File\FileInfo(__DIR__.'/files');
+
+echo json_encode(
+    $fi->scan()
+);

demo/fileinfo.php

@@ -0,0 +1 @@
+lorem lipsum lorem lipsum lorem lipsum

demo/files/test1.txt

@@ -0,0 +1 @@
+lorem lipsum lorem lipsum lorem lipsum lorem lipsum

demo/files/text2.txt

@@ -26,7 +26,7 @@ public function __construct($dir)
      *
      * @return array An array containing details of files in the directory.
      */
-    public function getInfo()
+    public function scan()
     {
         $details = [];
         $this->listFilesRecursively($this->dir, $details);
@@ -59,7 +59,7 @@ private function listFilesRecursively($dir, &$details)
                 $formattedSize = $this->formatSize($size);
                 $shortCode = substr($hash, 2, 4) . substr($hash, 10, 4);
 
-                $details[$file] = [
+                $details[] = [
                     'id' => $shortCode,
                     'name' => $file,
                     'modified' => date('Y-m-d H:i', $modified),

src/FileInfo.php

@@ -12,7 +12,7 @@ class FileTypes
     /**
      * Array containing file types with their categories and purposes.
      *
-     * @var array
+     * @var array List of file types
      */
     public $types = [
         'exe'   => ['category' => 'Windows', 'purpose' => 'Executable file'],

src/FileTypes.php

@@ -14,7 +14,6 @@ class JsonFile
      *
      * @param string $file The path to the JSON file.
      * @return array The decoded JSON data.
-     * @throws \Exception If the file path is invalid.
      */
     public function read($file)
     {
@@ -27,7 +26,6 @@ public function read($file)
      *
      * @param string $file The path to the JSON file.
      * @param array $data The data to be encoded as JSON and written to the file.
-     * @throws \Exception If the file path is invalid.
      */
     public function write($file, $data)
     {