Spiral\Validation\Checker\FileChecker

Complexity

Total Complexity

8

Size/Duplication

Total Lines	89
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
A	exists()	0	3	1
A	extension()	0	15	3
A	size()	0	7	2
A	uploaded()	0	3	1

<?php

/**
 * Spiral Framework.
 *
 * @license   MIT
 * @author    Anton Titov (Wolfy-J)
 */

declare(strict_types=1);

namespace Spiral\Validation\Checker;

use Psr\Http\Message\UploadedFileInterface;
use Spiral\Core\Container\SingletonInterface;
use Spiral\Files\FilesInterface;
use Spiral\Validation\AbstractChecker;
use Spiral\Validation\Checker\Traits\FileTrait;

/**
 * @inherit-messages
 */
final class FileChecker extends AbstractChecker implements SingletonInterface
{
    use FileTrait;

    /**
     * {@inheritdoc}
     */
    public const MESSAGES = [
        'exists'    => '[[File does not exists.]]',
        'uploaded'  => '[[File not received, please try again.]]',
        'size'      => '[[File exceeds the maximum file size of {1}KB.]]',
        'extension' => '[[File has an invalid file format.]]',
    ];

    /**
     * {@inheritdoc}
     */
    public const ALLOW_EMPTY_VALUES = ['exists', 'uploaded'];

    /**
     * @param FilesInterface $files
     */
    public function __construct(FilesInterface $files)
    {
        $this->files = $files;
    }

    /**
     * Check if file exist.
     *
     * @param mixed $file
     * @return bool
     */
    public function exists($file): bool
    {
        return !empty($this->resolveFilename($file));
    }

    /**
     * Check if file been uploaded.
     *
     * @param mixed $file Local file or uploaded file array.
     * @return bool
     */
    public function uploaded($file): bool
    {
        return $this->isUploaded($file);
    }

    /**
     * Check if file size less that specified value in KB.
     *
     * @param mixed $file Local file or uploaded file array.
     * @param int   $size Size in KBytes.
     * @return bool
     */
    public function size($file, int $size): bool
    {
        if (empty($filename = $this->resolveFilename($file))) {
            return false;
        }

        return $this->files->size($filename) <= ($size * 1024);
    }

    /**
     * Check if file extension in whitelist. Client name of uploaded file will be used!
     * It is recommended to use external validation like media type based on file mimetype or
     * ensure that resource is properly converted.
     *
     * @param mixed        $file
     * @param array|string $extensions
     * @return bool
     */
    public function extension($file, $extensions): bool
    {
        if (!is_array($extensions)) {
            $extensions = array_slice(func_get_args(), 1);
        }

        if ($file instanceof UploadedFileInterface) {
            return in_array(
                $this->files->extension($file->getClientFilename()),

It seems like $file->getClientFilename() can also be of type null; however, parameter $filename of Spiral\Files\FilesInterface::extension() does only seem to accept string, maybe add an additional type check?

                $extensions,
                true
            );
        }

        return in_array($this->files->extension($file), $extensions, true);
    }
}