EventEspresso\core\services\request\files\FileSubmission

Complexity

Total Complexity

15

Size/Duplication

Total Lines	161
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	0

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	20	2
A	getName()	0	4	1
A	getType()	0	7	2
A	determineType()	0	8	2
A	getExtension()	0	7	2
A	determineExtension()	0	11	2
A	getSize()	0	4	1
A	getTmpFile()	0	4	1
A	__toString()	0	4	1
A	getErrorCode()	0	4	1

<?php

namespace EventEspresso\core\services\request\files;

use finfo;
use InvalidArgumentException;

/**
 * Class FileSubmission
 *
 * All the info about a file from $_FILES (except we determine mimetype ourselves, because what's in $_FILES isn't
 * reliable), but put together onto one object with a few helpers.
 * FilesDataHandler takes care of creating these from $_FILES.
 *
 * @package     Event Espresso
 * @author         Mike Nelson
 * @since         4.9.80.p
 *
 */
class FileSubmission implements FileSubmissionInterface
{
    /**
     * @var string original name on the client machine
     */
    protected $name;

    /**
     * @var string mime type
     */
    protected $type;

    /**
     * @var string file extension
     */
    protected $extension;

    /**
     * @var int in bytes
     */
    protected $size;

    /**
     * @var string local filepath to the temporary file
     */
    protected $tmp_file;

    /**
     * @var int one of UPLOAD_ERR_OK, UPLOAD_ERR_NO_FILE, UPLOAD_ERR_INI_SIZE, UPLOAD_ERR_FORM_SIZE or other values
     * although those aren't expected.
     */
    protected $error_code;

    /**
     * FileSubmission constructor.
     * @param $name
     * @param $tmp_file
     * @param $size
     * @param null $error_code
     * @throws InvalidArgumentException
     */
    public function __construct($name, $tmp_file, $size, $error_code = null)
    {
        $this->name = basename($name);
        $scheme = parse_url($tmp_file, PHP_URL_SCHEME);
        if (in_array($scheme, ['http', 'https'])) {
            // Wait a minute- just local filepaths please, no URL schemes allowed!
            throw new InvalidArgumentException(
                sprintf(
                    // @codingStandardsIgnoreStart
                    esc_html__('The scheme ("%1$s") on the temporary file ("%2$s") indicates is located elsewhere, that’s not ok!', 'event_espresso'),
                    // @codingStandardsIgnoreEnd
                    $scheme,
                    $tmp_file
                )
            );
        }
        $this->tmp_file = (string) $tmp_file;
        $this->size = (int) $size;
        $this->error_code = (int) $error_code;
    }

    /**
     * @return string
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * Gets the file's mime type
     * @return string
     */
    public function getType()
    {
        if (!$this->type) {
            $this->type = $this->determineType();
        }
        return $this->type;
    }

    /**
     * @since 4.9.80.p
     * @return string
     */
    protected function determineType()
    {
        if (!$this->getTmpFile()) {
            return '';
        }
        $finfo = new finfo(FILEINFO_MIME_TYPE);
        return $finfo->file($this->getTmpFile());
    }

    /**
     * Gets the file's extension.
     * @since 4.9.80.p
     * @return string
     */
    public function getExtension()
    {
        if (!$this->extension) {
            $this->extension = $this->determineExtension();
        }
        return $this->extension;
    }

    /**
     * Determine's the file's extension given the temporary file.
     * @since 4.9.80.p
     * @return string
     */
    protected function determineExtension()
    {
        $position_of_period = strrpos($this->getName(), '.');
        if ($position_of_period === false) {
            return '';
        }
        return mb_substr(
            $this->getName(),
            $position_of_period + 1
        );
    }

    /**
     * Gets the size of the file
     * @return int
     */
    public function getSize()
    {
        return $this->size;
    }

    /**
     * Gets the path to the temporary file which was uploaded.
     * @return string
     */
    public function getTmpFile()
    {
        return $this->tmp_file;
    }

    /**
     * @since 4.9.80.p
     * @return string
     */
    public function __toString()
    {
        return $this->getName();
    }

    /**
     * Gets the error code PHP reported for the file upload.
     * @return string
     */
    public function getErrorCode()
    {
        return $this->error_code;
    }
}
// End of file FileSubmission.php
// Location: EventEspresso\core\services\request\files/FileSubmission.php