jaxon-php / jaxon-mono

jaxon-upload/src/Manager/UploadManager.php

Switch Indentation +159 added lines, -159 removed lines

@@ -31,40 +31,40 @@ 
 
 class UploadManager
 {
-    /**
+/**
      * The id of the upload field in the form
      *
      * @var string
      */
-    protected $sUploadFieldId = '';
+protected $sUploadFieldId = '';
 
-    /**
+/**
      * A user defined function to transform uploaded file names
      *
      * @var Closure
      */
-    protected $cNameSanitizer = null;
+protected $cNameSanitizer = null;
 
-    /**
+/**
      * @var array<string, Filesystem>
      */
-    protected $aFilesystems = [];
+protected $aFilesystems = [];
 
-    /**
+/**
      * @var array
      */
-    private $errorMessages = [
-        0 => 'There is no error, the file uploaded with success',
-        1 => 'The uploaded file exceeds the upload_max_filesize directive in php.ini',
-        2 => 'The uploaded file exceeds the MAX_FILE_SIZE directive that was specified in the HTML form',
-        3 => 'The uploaded file was only partially uploaded',
-        4 => 'No file was uploaded',
-        6 => 'Missing a temporary folder',
-        7 => 'Failed to write file to disk.',
-        8 => 'A PHP extension stopped the file upload.',
-    ];
+private $errorMessages = [
+0 => 'There is no error, the file uploaded with success',
+1 => 'The uploaded file exceeds the upload_max_filesize directive in php.ini',
+2 => 'The uploaded file exceeds the MAX_FILE_SIZE directive that was specified in the HTML form',
+3 => 'The uploaded file was only partially uploaded',
+4 => 'No file was uploaded',
+6 => 'Missing a temporary folder',
+7 => 'Failed to write file to disk.',
+8 => 'A PHP extension stopped the file upload.',
+];
 
-    /**
+/**
      * The constructor
      *
      * @param Validator $xValidator
@@ -74,49 +74,49 @@ 
      * @param StorageManager $xStorageManager
      * @param ConfigManager $xConfigManager
      */
-    public function __construct(private Validator $xValidator, private Translator $xTranslator,
-        private LoggerInterface $xLogger, private FileNameInterface $xFileName,
-        private StorageManager $xStorageManager, private ConfigManager $xConfigManager)
-    {
-        // This feature is not yet implemented
-        $this->setUploadFieldId('');
-    }
+public function __construct(private Validator $xValidator, private Translator $xTranslator,
+private LoggerInterface $xLogger, private FileNameInterface $xFileName,
+private StorageManager $xStorageManager, private ConfigManager $xConfigManager)
+{
+// This feature is not yet implemented
+$this->setUploadFieldId('');
+}
 
-    /**
+/**
      * Generate a random name
      *
      * @return string
      */
-    protected function randomName(): string
-    {
-        return $this->xFileName->random(16);
-    }
+protected function randomName(): string
+{
+return $this->xFileName->random(16);
+}
 
-    /**
+/**
      * Set the id of the upload field in the form
      *
      * @param string $sUploadFieldId
      *
      * @return void
      */
-    public function setUploadFieldId(string $sUploadFieldId): void
-    {
-        $this->sUploadFieldId = $sUploadFieldId;
-    }
+public function setUploadFieldId(string $sUploadFieldId): void
+{
+$this->sUploadFieldId = $sUploadFieldId;
+}
 
-    /**
+/**
      * Filter uploaded file name
      *
      * @param Closure $cNameSanitizer    The closure which filters filenames
      *
      * @return void
      */
-    public function setNameSanitizer(Closure $cNameSanitizer): void
-    {
-        $this->cNameSanitizer = $cNameSanitizer;
-    }
+public function setNameSanitizer(Closure $cNameSanitizer): void
+{
+$this->cNameSanitizer = $cNameSanitizer;
+}
 
-    /**
+/**
      * Make sure the upload dir exists and is writable
      *
      * @param Filesystem $xFilesystem
@@ -125,55 +125,55 @@ 
      * @return string
      * @throws RequestException
      */
-    private function _makeUploadDir(Filesystem $xFilesystem, string $sUploadDir): string
-    {
-        try
-        {
-            $xFilesystem->createDirectory($sUploadDir);
-            if(!$xFilesystem->directoryExists($sUploadDir))
-            {
-                throw new RequestException($this->xTranslator->trans('errors.upload.access'));
-            }
-            return $sUploadDir;
-        }
-        catch(FilesystemException $e)
-        {
-            $this->xLogger->error('Filesystem error.', ['message' => $e->getMessage()]);
-            throw new RequestException($this->xTranslator->trans('errors.upload.access'));
-        }
-    }
+private function _makeUploadDir(Filesystem $xFilesystem, string $sUploadDir): string
+{
+try
+{
+$xFilesystem->createDirectory($sUploadDir);
+if(!$xFilesystem->directoryExists($sUploadDir))
+{
+    throw new RequestException($this->xTranslator->trans('errors.upload.access'));
+}
+return $sUploadDir;
+}
+catch(FilesystemException $e)
+{
+$this->xLogger->error('Filesystem error.', ['message' => $e->getMessage()]);
+throw new RequestException($this->xTranslator->trans('errors.upload.access'));
+}
+}
 
-    /**
+/**
      * @param string $sField
      *
      * @return Filesystem
      * @throws RequestException
      */
-    public function filesystem(string $sField = ''): Filesystem
-    {
-        $sField = trim($sField);
-        if(isset($this->aFilesystems[$sField]))
-        {
-            return $this->aFilesystems[$sField];
-        }
+public function filesystem(string $sField = ''): Filesystem
+{
+$sField = trim($sField);
+if(isset($this->aFilesystems[$sField]))
+{
+return $this->aFilesystems[$sField];
+}
 
-        // Default upload dir
-        $sStorage = $this->xConfigManager->getAppOption('upload.default.storage', 'upload');
-        $sConfigKey = "upload.files.$sField";
-        if($sField !== '' && $this->xConfigManager->hasAppOption($sConfigKey))
-        {
-            $sStorage = $this->xConfigManager->getAppOption("$sConfigKey.storage", $sStorage);
-        }
-        if(!is_string($sStorage))
-        {
-            throw new RequestException($this->xTranslator->trans('errors.upload.adapter'));
-        }
+// Default upload dir
+$sStorage = $this->xConfigManager->getAppOption('upload.default.storage', 'upload');
+$sConfigKey = "upload.files.$sField";
+if($sField !== '' && $this->xConfigManager->hasAppOption($sConfigKey))
+{
+$sStorage = $this->xConfigManager->getAppOption("$sConfigKey.storage", $sStorage);
+}
+if(!is_string($sStorage))
+{
+throw new RequestException($this->xTranslator->trans('errors.upload.adapter'));
+}
 
-        $this->aFilesystems[$sField] = $this->xStorageManager->get($sStorage);
-        return $this->aFilesystems[$sField];
-    }
+$this->aFilesystems[$sField] = $this->xStorageManager->get($sStorage);
+return $this->aFilesystems[$sField];
+}
 
-    /**
+/**
      * Get the path to the upload dir
      *
      * @param string $sField
@@ -181,13 +181,13 @@ 
      * @return string
      * @throws RequestException
      */
-    private function getUploadDir(string $sField): string
-    {
-        $xFileSystem = $this->filesystem($sField);
-        return $this->_makeUploadDir($xFileSystem, $this->randomName() . '/');
-    }
+private function getUploadDir(string $sField): string
+{
+$xFileSystem = $this->filesystem($sField);
+return $this->_makeUploadDir($xFileSystem, $this->randomName() . '/');
+}
 
-    /**
+/**
      * Check uploaded files
      *
      * @param UploadedFile $xHttpFile
@@ -197,43 +197,43 @@ 
      * @return array
      * @throws RequestException
      */
-    private function makeUploadedFile(UploadedFile $xHttpFile, string $sUploadDir, string $sField): array
-    {
-        // Check the uploaded file validity
-        $nErrorCode = $xHttpFile->getError();
-        if($nErrorCode !== UPLOAD_ERR_OK)
-        {
-            $this->xLogger->error('File upload error.', [
-                'code' => $nErrorCode,
-                'message' => $this->errorMessages[$nErrorCode],
-            ]);
-            $sMessage = $this->xTranslator->trans('errors.upload.failed', [
-                'name' => $sField,
-            ]);
-            throw new RequestException($sMessage);
-        }
+private function makeUploadedFile(UploadedFile $xHttpFile, string $sUploadDir, string $sField): array
+{
+// Check the uploaded file validity
+$nErrorCode = $xHttpFile->getError();
+if($nErrorCode !== UPLOAD_ERR_OK)
+{
+$this->xLogger->error('File upload error.', [
+    'code' => $nErrorCode,
+    'message' => $this->errorMessages[$nErrorCode],
+]);
+$sMessage = $this->xTranslator->trans('errors.upload.failed', [
+    'name' => $sField,
+]);
+throw new RequestException($sMessage);
+}
 
-        // Filename without the extension. Needs to be sanitized.
-        $sName = pathinfo($xHttpFile->getClientFilename(), PATHINFO_FILENAME);
-        if($this->cNameSanitizer !== null)
-        {
-            $sName = (string)call_user_func($this->cNameSanitizer,
-                $sName, $sField, $this->sUploadFieldId);
-        }
+// Filename without the extension. Needs to be sanitized.
+$sName = pathinfo($xHttpFile->getClientFilename(), PATHINFO_FILENAME);
+if($this->cNameSanitizer !== null)
+{
+$sName = (string)call_user_func($this->cNameSanitizer,
+    $sName, $sField, $this->sUploadFieldId);
+}
 
-        // Set the user file data
-        $xFile = File::fromHttpFile($this->filesystem($sField), $xHttpFile, $sUploadDir, $sName);
-        // Verify file validity (format, size)
-        if(!$this->xValidator->validateUploadedFile($sField, $xFile))
-        {
-            throw new RequestException($this->xValidator->getErrorMessage());
-        }
+// Set the user file data
+$xFile = File::fromHttpFile($this->filesystem($sField), $xHttpFile, $sUploadDir, $sName);
+// Verify file validity (format, size)
+if(!$this->xValidator->validateUploadedFile($sField, $xFile))
+{
+throw new RequestException($this->xValidator->getErrorMessage());
+}
 
-        // All's right, save the file for copy.
-        return ['temp' => $xHttpFile, 'user' => $xFile];
-    }
+// All's right, save the file for copy.
+return ['temp' => $xHttpFile, 'user' => $xFile];
+}
 
-    /**
+/**
      * Read uploaded files info from HTTP request data
      *
      * @param ServerRequestInterface $xRequest
@@ -241,46 +241,46 @@ 
      * @return array
      * @throws RequestException
      */
-    public function readFromHttpData(ServerRequestInterface $xRequest): array
-    {
-        // Get the uploaded files
-        $aTempFiles = $xRequest->getUploadedFiles();
+public function readFromHttpData(ServerRequestInterface $xRequest): array
+{
+// Get the uploaded files
+$aTempFiles = $xRequest->getUploadedFiles();
 
-        $aUserFiles = [];
-        $aAllFiles = []; // A flat list of all uploaded files
-        foreach($aTempFiles as $sField => $aFiles)
-        {
-            $aUserFiles[$sField] = [];
-            // Get the path to the upload dir
-            $sUploadDir = $this->getUploadDir($sField);
-            if(!is_array($aFiles))
-            {
-                $aFiles = [$aFiles];
-            }
-            foreach($aFiles as $xHttpFile)
-            {
-                $aFile = $this->makeUploadedFile($xHttpFile, $sUploadDir, $sField);
-                $aUserFiles[$sField][] = $aFile['user'];
-                $aAllFiles[] = $aFile;
-            }
-        }
+$aUserFiles = [];
+$aAllFiles = []; // A flat list of all uploaded files
+foreach($aTempFiles as $sField => $aFiles)
+{
+$aUserFiles[$sField] = [];
+// Get the path to the upload dir
+$sUploadDir = $this->getUploadDir($sField);
+if(!is_array($aFiles))
+{
+    $aFiles = [$aFiles];
+}
+foreach($aFiles as $xHttpFile)
+{
+    $aFile = $this->makeUploadedFile($xHttpFile, $sUploadDir, $sField);
+    $aUserFiles[$sField][] = $aFile['user'];
+    $aAllFiles[] = $aFile;
+}
+}
 
-        // Copy the uploaded files from the temp dir to the user dir
-        try
-        {
-            foreach($aAllFiles as $aFiles)
-            {
-                $sPath = $aFiles['user']->path();
-                $xContent = $aFiles['temp']->getStream();
-                $aFiles['user']->filesystem()->write($sPath, $xContent);
-            }
-        }
-        catch(FilesystemException $e)
-        {
-            $this->xLogger->error('Filesystem error.', ['message' => $e->getMessage()]);
-            throw new RequestException($this->xTranslator->trans('errors.upload.access'));
-        }
+// Copy the uploaded files from the temp dir to the user dir
+try
+{
+foreach($aAllFiles as $aFiles)
+{
+    $sPath = $aFiles['user']->path();
+    $xContent = $aFiles['temp']->getStream();
+    $aFiles['user']->filesystem()->write($sPath, $xContent);
+}
+}
+catch(FilesystemException $e)
+{
+$this->xLogger->error('Filesystem error.', ['message' => $e->getMessage()]);
+throw new RequestException($this->xTranslator->trans('errors.upload.access'));
+}
 
-        return $aUserFiles;
-    }
+return $aUserFiles;
+}
 }

Spacing +13 added lines, -13 removed lines

@@ -130,13 +130,13 @@ 
         try
         {
             $xFilesystem->createDirectory($sUploadDir);
-            if(!$xFilesystem->directoryExists($sUploadDir))
+            if (!$xFilesystem->directoryExists($sUploadDir))
             {
                 throw new RequestException($this->xTranslator->trans('errors.upload.access'));
             }
             return $sUploadDir;
         }
-        catch(FilesystemException $e)
+        catch (FilesystemException $e)
         {
             $this->xLogger->error('Filesystem error.', ['message' => $e->getMessage()]);
             throw new RequestException($this->xTranslator->trans('errors.upload.access'));
@@ -152,7 +152,7 @@ 
     public function filesystem(string $sField = ''): Filesystem
     {
         $sField = trim($sField);
-        if(isset($this->aFilesystems[$sField]))
+        if (isset($this->aFilesystems[$sField]))
         {
             return $this->aFilesystems[$sField];
         }
@@ -160,11 +160,11 @@ 
         // Default upload dir
         $sStorage = $this->xConfigManager->getAppOption('upload.default.storage', 'upload');
         $sConfigKey = "upload.files.$sField";
-        if($sField !== '' && $this->xConfigManager->hasAppOption($sConfigKey))
+        if ($sField !== '' && $this->xConfigManager->hasAppOption($sConfigKey))
         {
             $sStorage = $this->xConfigManager->getAppOption("$sConfigKey.storage", $sStorage);
         }
-        if(!is_string($sStorage))
+        if (!is_string($sStorage))
         {
             throw new RequestException($this->xTranslator->trans('errors.upload.adapter'));
         }
@@ -201,7 +201,7 @@ 
     {
         // Check the uploaded file validity
         $nErrorCode = $xHttpFile->getError();
-        if($nErrorCode !== UPLOAD_ERR_OK)
+        if ($nErrorCode !== UPLOAD_ERR_OK)
         {
             $this->xLogger->error('File upload error.', [
                 'code' => $nErrorCode,
@@ -215,7 +215,7 @@ 
 
         // Filename without the extension. Needs to be sanitized.
         $sName = pathinfo($xHttpFile->getClientFilename(), PATHINFO_FILENAME);
-        if($this->cNameSanitizer !== null)
+        if ($this->cNameSanitizer !== null)
         {
             $sName = (string)call_user_func($this->cNameSanitizer,
                 $sName, $sField, $this->sUploadFieldId);
@@ -224,7 +224,7 @@ 
         // Set the user file data
         $xFile = File::fromHttpFile($this->filesystem($sField), $xHttpFile, $sUploadDir, $sName);
         // Verify file validity (format, size)
-        if(!$this->xValidator->validateUploadedFile($sField, $xFile))
+        if (!$this->xValidator->validateUploadedFile($sField, $xFile))
         {
             throw new RequestException($this->xValidator->getErrorMessage());
         }
@@ -248,16 +248,16 @@ 
 
         $aUserFiles = [];
         $aAllFiles = []; // A flat list of all uploaded files
-        foreach($aTempFiles as $sField => $aFiles)
+        foreach ($aTempFiles as $sField => $aFiles)
         {
             $aUserFiles[$sField] = [];
             // Get the path to the upload dir
             $sUploadDir = $this->getUploadDir($sField);
-            if(!is_array($aFiles))
+            if (!is_array($aFiles))
             {
                 $aFiles = [$aFiles];
             }
-            foreach($aFiles as $xHttpFile)
+            foreach ($aFiles as $xHttpFile)
             {
                 $aFile = $this->makeUploadedFile($xHttpFile, $sUploadDir, $sField);
                 $aUserFiles[$sField][] = $aFile['user'];
@@ -268,14 +268,14 @@ 
         // Copy the uploaded files from the temp dir to the user dir
         try
         {
-            foreach($aAllFiles as $aFiles)
+            foreach ($aAllFiles as $aFiles)
             {
                 $sPath = $aFiles['user']->path();
                 $xContent = $aFiles['temp']->getStream();
                 $aFiles['user']->filesystem()->write($sPath, $xContent);
             }
         }
-        catch(FilesystemException $e)
+        catch (FilesystemException $e)
         {
             $this->xLogger->error('Filesystem error.', ['message' => $e->getMessage()]);
             throw new RequestException($this->xTranslator->trans('errors.upload.access'));