Init

Author: lennyrouanet

.gitignore

@@ -0,0 +1,7 @@
+# Dependencies
+composer.lock
+vendor/*
+
+# Dev
+.DS_Store
+.nova/*

README.md

@@ -1,2 +1,114 @@
-# file
-Files
+# Files
+
+## Requirments
+
+PHP >= 8.0
+
+
+## Install
+
+`composer require phant/file`
+
+## Usages
+
+### File
+
+```php
+use Phant\File\File;
+
+$file = new File('path/filename.ext');
+```
+
+
+#### Get file path
+
+```php
+$filePath = $file->getPath();
+```
+
+
+#### Verify if file exist file path
+
+```php
+$fileExist = $file->exist();
+```
+
+
+#### Delete file
+
+```php
+$file->delete();
+```
+
+
+#### Get temporary path
+
+```php
+$temoraryDirectory = $file->getTemoraryDirectory();
+```
+
+
+#### Clean filename
+
+```php
+$cleanFilename = File::cleanFilename($dirtyFilename);
+```
+
+
+#### Download file to temporary directory
+
+```php
+$file = File::download($fileUrl);
+```
+
+
+
+### Csv file
+
+```php
+use Phant\File\Csv;
+
+$file = new File('path/filename.csv');
+```
+
+
+#### Verify columns
+
+```php
+$isConform = $file->verifyColumns($columns);
+```
+
+
+#### Get number of lines
+
+```php
+$nbLines = $file->getNbLines();
+```
+
+
+#### Read file by line
+
+```php
+foreach ($file->readFileByLine() as $line) {
+	
+}
+```
+
+
+### Zip file
+
+```php
+use Phant\File\Zip;
+
+$file = new File('path/filename.zip');
+```
+
+
+#### Unarchive
+
+```php
+$files = $file->unarchive();
+foreach ($files as $file) {
+}
+```
+

component/Csv.php

@@ -0,0 +1,79 @@
+<?php
+declare(strict_types=1);
+
+namespace Phant\File;
+use Phant\File\File;
+
+class Csv extends File
+{
+	protected bool $headerInFirstLine;
+	protected array $columns;
+	protected string $delimiter;
+	protected string $textSeparator;
+	
+	public function __construct(string $path, bool $headerInFirstLine = true, string $delimiter = ';', string $textSeparator = '"')
+	{
+		parent::__construct($path);
+		
+		$this->headerInFirstLine = $headerInFirstLine;
+		$this->columns = [];
+		$this->delimiter = $delimiter;
+		$this->textSeparator = $textSeparator;
+	}
+	
+	public function verifyColumns(array $columns): bool
+	{
+		$handle = fopen($this->path, 'r');
+		$this->columns = fgetcsv($handle, 0, $this->delimiter, $this->textSeparator);
+		fclose($handle);
+		
+		if (count($this->columns) != count($columns)) {
+			return false;
+		}
+		
+		foreach ($this->columns as $colonne) {
+			if (!in_array($colonne, $columns)) {
+				return false;
+			}
+		}
+		
+		return true;
+	}
+	
+	public function getNbLines(): int
+	{
+		$nbLines = 0;
+		
+		$handle = fopen($this->path, 'r');
+		
+		while (!feof($handle)) {
+			fgets($handle);
+			$nbLines++;
+		}
+		
+		fclose($handle);
+		
+		return $nbLines;
+	}
+	
+	public function readFileByLine()
+	{
+		$handle = fopen($this->path, 'r');
+
+		$lineNumber = 0;
+		while (($cells = fgetcsv($handle, 0, $this->delimiter, $this->textSeparator)) !== false) {
+			if ($this->headerInFirstLine && $lineNumber === 0) {
+				++$lineNumber;
+				continue;
+			}
+
+			$values = $this->headerInFirstLine ? array_combine($this->columns, $cells) : $cells;
+			
+			yield $values;
+
+			++$lineNumber;
+		}
+		
+		fclose($handle);
+	}
+}

component/File.php

@@ -0,0 +1,68 @@
+<?php
+declare(strict_types=1);
+
+namespace Phant\File;
+
+class File
+{
+	protected string $path;
+	
+	public function __construct(string $path)
+	{
+		$this->path = $path;
+	}
+	
+	public function getPath(): string
+	{
+		return $this->path;
+	}
+	
+	public function exist(): bool
+	{
+		return file_exists($this->path);
+	}
+	
+	public function delete()
+	{
+		unlink($this->path);
+	}
+	
+	public static function getTemoraryDirectory(): string
+	{
+		return realpath(sys_get_temp_dir()) . '/';
+	}
+	
+	public static function cleanFilename(string $fileName): string
+	{
+		$extension = pathinfo($fileName, PATHINFO_EXTENSION);
+		$fileName = pathinfo($fileName, PATHINFO_FILENAME);
+		
+		// Clean local filename
+		$fileName = pathinfo($fileName, PATHINFO_FILENAME);
+		
+		$fileName = strtr(
+			$fileName,
+			['Š' => 'S','Ž' => 'Z','š' => 's','ž' => 'z','Ÿ' => 'Y','À' => 'A','Á' => 'A','Â' => 'A','Ã' => 'A','Ä' => 'A','Å' => 'A','Ç' => 'C','È' => 'E','É' => 'E','Ê' => 'E','Ë' => 'E','Ì' => 'I','Í' => 'I','Î' => 'I','Ï' => 'I','Ñ' => 'N','Ò' => 'O','Ó' => 'O','Ô' => 'O','Õ' => 'O','Ö' => 'O','Ø' => 'O','Ù' => 'U','Ú' => 'U','Û' => 'U','Ü' => 'U','Ý' => 'Y','à' => 'a','á' => 'a','â' => 'a','ã' => 'a','ä' => 'a','å' => 'a','ç' => 'c','è' => 'e','é' => 'e','ê' => 'e','ë' => 'e','ì' => 'i','í' => 'i','î' => 'i','ï' => 'i','ñ' => 'n','ò' => 'o','ó' => 'o','ô' => 'o','õ' => 'o','ö' => 'o','ø' => 'o','ù' => 'u','ú' => 'u','û' => 'u','ü' => 'u','ý' => 'y','ÿ' => 'y']
+		);
+		
+		$fileName = strtr(
+			$fileName,
+			['Þ' => 'TH', 'þ' => 'th', 'Ð' => 'DH', 'ð' => 'dh', 'ß' => 'ss', 'Œ' => 'OE', 'œ' => 'oe', 'Æ' => 'AE', 'æ' => 'ae', 'µ' => 'u']
+		);
+		
+		$fileName = preg_replace(['/\s/', '/\.[\.]+/', '/[^\w_\.\-]/'], ['_', '.', ''], $fileName);
+		
+		return $fileName . '.' . $extension;
+	}
+	
+	public static function download(string $distantPath, ?string $localPath = null): self
+	{
+		if (!$localPath) {
+			$localPath = self::getTemoraryDirectory() . date('Y-m-d_H-i-s') . '-' . self::cleanFilename($distantPath);
+		}
+		
+		file_put_contents($localPath, fopen($distantPath, 'r'));
+		
+		return new self($localPath);
+	}
+}

component/Zip.php

@@ -0,0 +1,29 @@
+<?php
+declare(strict_types=1);
+
+namespace Phant\File;
+use Phant\File\File;
+use \ZipArchive;
+
+class Zip extends File
+{
+	public function unarchive(?string $unarchiveDirectory = null): array
+	{
+		if ($unarchiveDirectory) {
+			$unarchiveDirectory = self::getTemoraryDirectory() . pathinfo($this->path, PATHINFO_FILENAME) . '/';
+		}
+		
+		$files = [];
+		
+		$zip = new ZipArchive;
+		$zip->open($this->path);
+		if ($zip->extractTo($unarchiveDirectory) == true) {
+			for ($i = 0; $i < $zip->numFiles; $i++) {
+				$files[ $zip->getNameIndex($i) ] = new File($unarchiveDirectory . $zip->getNameIndex($i));
+			}
+		}
+		$zip->close();
+		
+		return $files;
+	}
+}

composer.json

@@ -0,0 +1,26 @@
+{
+    "name": "phant/file",
+    "description": "Manage file easily",
+    "license": "MIT",
+    "keywords": ["file manager", "file loader", "file reader", "csv file", "csv reader"],
+    "authors": [
+        {
+            "name": "Lenny ROUANET",
+            "email": "[email protected]"
+        }
+    ],
+    "require": {
+        "php": "^8.0"
+    },
+    "require-dev": {
+        "phpstan/phpstan": "^1.4"
+    },
+    "scripts": {
+        "analyse": "vendor/bin/phpstan analyse component --memory-limit=4G"
+    },
+    "autoload": {
+        "psr-4": {
+            "Phant\\File\\": "component/"
+        }
+    }
+}