Uploader Class Reference

Inheritance diagram for Uploader:

Public Member Functions
	__construct ( $fileId, Mime $fileMime=null)
	save ($destinationFolder, $newFileName=null)
	getFileExtension ()
	addValidateCallback ($callbackName, $callbackObject, $callbackMethod)
	removeValidateCallback ($callbackName)
	correctFileNameCase ($fileName)
	checkMimeType ($validTypes=[])
	getUploadedFileName ()
	setAllowCreateFolders ($flag)
	setAllowRenameFiles ($flag)
	setFilesDispersion ($flag)
	setFilenamesCaseSensitivity ($flag)
	setAllowedExtensions ($extensions=[])
	checkAllowedExtension ($extension)

Static Public Member Functions
static	getCorrectFileName ($fileName)
static	getNewFileName ($destinationFile)
static	getDispretionPath ($fileName)
static	getDispersionPath ($fileName)

Data Fields
const	SINGLE_STYLE = 0
const	MULTIPLE_STYLE = 1
const	TMP_NAME_EMPTY = 666
const	MAX_IMAGE_WIDTH = 4096
const	MAX_IMAGE_HEIGHT = 2160

Protected Member Functions
	_afterSave ($result)
	chmod ($file)
	_moveFile ($tmpPath, $destPath)
	_validateFile ()

Static Protected Member Functions
static	_addDirSeparator ($dir)

Protected Attributes
	$_file
	$_fileMimeType
	$_uploadType
	$_uploadedFileName
	$_uploadedFileDir
	$_allowCreateFolders = true
	$_allowRenameFiles = false
	$_enableFilesDispersion = false
	$_caseInsensitiveFilenames = true
	$_dispretionPath = null
	$_fileExists = false
	$_allowedExtensions = null
	$_validateCallbacks = []
	$_result

Detailed Description

File upload class

ATTENTION! This class must be used like abstract class and must added validation by protected file extension list to extended class

@api

Since

100.0.2

Definition at line 17 of file Uploader.php.

Constructor & Destructor Documentation

__construct()

__construct	(		$fileId,
		Mime	$fileMime = null
	)

Init upload

Parameters

string | array	$fileId
\Magento\Framework\File\Mime | null	$fileMime

Exceptions

Definition at line 168 of file Uploader.php.

      {
        $this->_setUploadFileId($fileId);
        if (!file_exists($this->_file['tmp_name'])) {
            $code = empty($this->_file['tmp_name']) ? self::TMP_NAME_EMPTY : 0;
            throw new \Exception('The file was not uploaded.', $code);
        } else {
            $this->_fileExists = true;
        }
        $this->fileMime = $fileMime ?: \Magento\Framework\App\ObjectManager::getInstance()->get(Mime::class);
    }

Member Function Documentation

_addDirSeparator()

static _addDirSeparator (   $dir )

staticprotected

Add directory separator

Parameters

string

$dir

Returns

string

Definition at line 406 of file Uploader.php.

    {
        if (substr($dir, -1) != '/') {
            $dir .= '/';
        }
        return $dir;
    }

_afterSave()

_afterSave (   $result )

protected

After save logic

Parameters

array

$result

Returns

$this @SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 189 of file Uploader.php.

    {
        return $this;
    }

_moveFile()

_moveFile (   $tmpPath,   $destPath  )

protected

Move files from TMP folder into destination folder

Parameters

string	$tmpPath
string	$destPath

Returns

bool|void

Definition at line 293 of file Uploader.php.

    {
        if (is_uploaded_file($tmpPath)) {
            return move_uploaded_file($tmpPath, $destPath);
        } elseif (is_file($tmpPath)) {
            return rename($tmpPath, $destPath);
        }
    }

_validateFile()

_validateFile ( )

protected

Validate file before save

Returns

void

Exceptions

Definition at line 308 of file Uploader.php.

    {
        if ($this->_fileExists === false) {
            return;
        }

        //is file extension allowed
        if (!$this->checkAllowedExtension($this->getFileExtension())) {
            throw new \Exception('Disallowed file type.');
        }
        //run validate callbacks
        foreach ($this->_validateCallbacks as $params) {
            if (is_object($params['object'])
                && method_exists($params['object'], $params['method'])
                && is_callable([$params['object'], $params['method']])
            ) {
                $params['object']->{$params['method']}($this->_file['tmp_name']);
            }
        }
    }

addValidateCallback()

addValidateCallback	(		$callbackName,
			$callbackObject,
			$callbackMethod
	)

Add validation callback model for us in self::_validateFile()

Parameters

string	$callbackName
object	$callbackObject
string	$callbackMethod	Method name of $callbackObject. It must have interface (string $tmpFilePath)

Returns

\Magento\Framework\File\Uploader

Definition at line 348 of file Uploader.php.

    {
        $this->_validateCallbacks[$callbackName] = ['object' => $callbackObject, 'method' => $callbackMethod];
        return $this;
    }

checkAllowedExtension()

checkAllowedExtension

(

$extension

)

Check if specified extension is allowed

Parameters

string

$extension

Returns

boolean

Definition at line 513 of file Uploader.php.

    {
        if (!is_array($this->_allowedExtensions) || empty($this->_allowedExtensions)) {
            return true;
        }

        return in_array(strtolower($extension), $this->_allowedExtensions);
    }

checkMimeType()

checkMimeType

(

$validTypes = []

)

Used to check if uploaded file mime type is valid or not

Parameters

string[]

$validTypes @access public

Returns

bool

Definition at line 421 of file Uploader.php.

    {
        if (count($validTypes) > 0) {
            if (!in_array($this->_getMimeType(), $validTypes)) {
                return false;
            }
        }
        return true;
    }

chmod()

chmod (   $file )

protected

Set access permissions to file.

Parameters

string

$file

Returns

void

Deprecated:

100.0.8

Definition at line 281 of file Uploader.php.

    {
        chmod($file, 0777);
    }

correctFileNameCase()

correctFileNameCase

(

$fileName

)

Convert filename to lowercase in case of case-insensitive file names

Parameters

string

$fileName

Returns

string

Definition at line 392 of file Uploader.php.

    {
        if ($this->_caseInsensitiveFilenames) {
            return strtolower($fileName);
        }
        return $fileName;
    }

getCorrectFileName()

static getCorrectFileName (   $fileName )

static

Correct filename with special chars and spaces

Parameters

string

$fileName

Returns

string

Definition at line 375 of file Uploader.php.

    {
        $fileName = preg_replace('/[^a-z0-9_\\-\\.]+/i', '_', $fileName);
        $fileInfo = pathinfo($fileName);

        if (preg_match('/^_+$/', $fileInfo['filename'])) {
            $fileName = 'file.' . $fileInfo['extension'];
        }
        return $fileName;
    }

getDispersionPath()

static getDispersionPath (   $fileName )

static

Get dispertion path

Parameters

string

$fileName

Returns

string

Since

101.0.4

Definition at line 642 of file Uploader.php.

    {
        $char = 0;
        $dispertionPath = '';
        while ($char < 2 && $char < strlen($fileName)) {
            if (empty($dispertionPath)) {
                $dispertionPath = '/' . ('.' == $fileName[$char] ? '_' : $fileName[$char]);
            } else {
                $dispertionPath = self::_addDirSeparator(
                    $dispertionPath
                ) . ('.' == $fileName[$char] ? '_' : $fileName[$char]);
            }
            $char++;
        }
        return $dispertionPath;
    }

getDispretionPath()

static getDispretionPath (   $fileName )

static

Get dispertion path

Parameters

string

$fileName

Returns

string

Deprecated:

101.0.4

Definition at line 630 of file Uploader.php.

    {
        return self::getDispersionPath($fileName);
    }

getFileExtension()

getFileExtension

(

)

Returns extension of the uploaded file

Returns

string

Definition at line 334 of file Uploader.php.

    {
        return $this->_fileExists ? pathinfo($this->_file['name'], PATHINFO_EXTENSION) : '';
    }

getNewFileName()

static getNewFileName (   $destinationFile )

static

Get new file name if the same is already exists

Parameters

string

$destinationFile

Returns

string

Definition at line 605 of file Uploader.php.

    {
        $fileInfo = pathinfo($destinationFile);
        if (file_exists($destinationFile)) {
            $index = 1;
            $baseName = $fileInfo['filename'] . '.' . $fileInfo['extension'];
            while (file_exists($fileInfo['dirname'] . '/' . $baseName)) {
                $baseName = $fileInfo['filename'] . '_' . $index . '.' . $fileInfo['extension'];
                $index++;
            }
            $destFileName = $baseName;
        } else {
            return $fileInfo['basename'];
        }

        return $destFileName;
    }

getUploadedFileName()

getUploadedFileName

(

)

Returns a name of uploaded file

@access public

Returns

string

Definition at line 437 of file Uploader.php.

    {
        return $this->_uploadedFileName;
    }

removeValidateCallback()

removeValidateCallback

(

$callbackName

)

Delete validation callback model for us in self::_validateFile()

Parameters

string

$callbackName

@access public

Returns

\Magento\Framework\File\Uploader

Definition at line 361 of file Uploader.php.

    {
        if (isset($this->_validateCallbacks[$callbackName])) {
            unset($this->_validateCallbacks[$callbackName]);
        }
        return $this;
    }

save()

save	(		$destinationFolder,
			$newFileName = null
	)

Used to save uploaded file into destination folder with original or new file name (if specified).

Parameters

string	$destinationFolder
string	$newFileName

Returns

array

Exceptions

Definition at line 203 of file Uploader.php.

    {
        $this->_validateFile();
        $this->validateDestination($destinationFolder);

        $this->_result = false;
        $destinationFile = $destinationFolder;
        $fileName = isset($newFileName) ? $newFileName : $this->_file['name'];
        $fileName = static::getCorrectFileName($fileName);
        if ($this->_enableFilesDispersion) {
            $fileName = $this->correctFileNameCase($fileName);
            $this->setAllowCreateFolders(true);
            $this->_dispretionPath = static::getDispersionPath($fileName);
            $destinationFile .= $this->_dispretionPath;
            $this->_createDestinationFolder($destinationFile);
        }

        if ($this->_allowRenameFiles) {
            $fileName = static::getNewFileName(
                static::_addDirSeparator($destinationFile) . $fileName
            );
        }

        $destinationFile = static::_addDirSeparator($destinationFile) . $fileName;

        try {
            $this->_result = $this->_moveFile($this->_file['tmp_name'], $destinationFile);
        } catch (\Exception $e) {
            // if the file exists and we had an exception continue anyway
            if (file_exists($destinationFile)) {
                $this->_result = true;
            } else {
                throw $e;
            }
        }

        if ($this->_result) {
            if ($this->_enableFilesDispersion) {
                $fileName = str_replace('\\', '/', self::_addDirSeparator($this->_dispretionPath)) . $fileName;
            }
            $this->_uploadedFileName = $fileName;
            $this->_uploadedFileDir = $destinationFolder;
            $this->_result = $this->_file;
            $this->_result['path'] = $destinationFolder;
            $this->_result['file'] = $fileName;

            $this->_afterSave($this->_result);
        }

        return $this->_result;
    }

setAllowCreateFolders()

setAllowCreateFolders

(

$flag

)

Used to set _allowCreateFolders value

Parameters

bool

$flag

@access public

Returns

$this

Definition at line 449 of file Uploader.php.

    {
        $this->_allowCreateFolders = $flag;
        return $this;
    }

setAllowedExtensions()

setAllowedExtensions

(

$extensions = []

)

Set allowed extensions

Parameters

string[]

$extensions

Returns

$this

Definition at line 499 of file Uploader.php.

    {
        foreach ((array)$extensions as $extension) {
            $this->_allowedExtensions[] = strtolower($extension);
        }
        return $this;
    }

setAllowRenameFiles()

setAllowRenameFiles

(

$flag

)

Used to set _allowRenameFiles value

Parameters

bool

$flag

@access public

Returns

$this

Definition at line 462 of file Uploader.php.

    {
        $this->_allowRenameFiles = $flag;
        return $this;
    }

setFilenamesCaseSensitivity()

setFilenamesCaseSensitivity

(

$flag

)

File names Case-sensitivity setter

Parameters

bool

$flag

Returns

$this

Definition at line 487 of file Uploader.php.

    {
        $this->_caseInsensitiveFilenames = $flag;
        return $this;
    }

setFilesDispersion()

setFilesDispersion

(

$flag

)

Used to set _enableFilesDispersion value

Parameters

bool

$flag

@access public

Returns

$this

Definition at line 475 of file Uploader.php.

    {
        $this->_enableFilesDispersion = $flag;
        return $this;
    }

Field Documentation

$_allowCreateFolders

$_allowCreateFolders = true

protected

Definition at line 67 of file Uploader.php.

$_allowedExtensions

$_allowedExtensions = null

protected

Definition at line 110 of file Uploader.php.

$_allowRenameFiles

$_allowRenameFiles = false

protected

Definition at line 76 of file Uploader.php.

$_caseInsensitiveFilenames

$_caseInsensitiveFilenames = true

protected

Definition at line 94 of file Uploader.php.

$_dispretionPath

$_dispretionPath = null

protected

Definition at line 100 of file Uploader.php.

$_enableFilesDispersion

$_enableFilesDispersion = false

protected

Definition at line 84 of file Uploader.php.

$_file

$_file

protected

Definition at line 25 of file Uploader.php.

$_fileExists

$_fileExists = false

protected

Definition at line 105 of file Uploader.php.

$_fileMimeType

$_fileMimeType

protected

Definition at line 33 of file Uploader.php.

$_result

$_result

protected

Definition at line 159 of file Uploader.php.

$_uploadedFileDir

$_uploadedFileDir

protected

Definition at line 58 of file Uploader.php.

$_uploadedFileName

$_uploadedFileName

protected

Definition at line 50 of file Uploader.php.

$_uploadType

$_uploadType

protected

Definition at line 41 of file Uploader.php.

$_validateCallbacks

$_validateCallbacks = []

protected

Definition at line 118 of file Uploader.php.

MAX_IMAGE_HEIGHT

const MAX_IMAGE_HEIGHT = 2160

Maximum Image Height resolution in pixels. For image resizing on client side

Deprecated:

See also

\Magento\Framework\Image\Adapter\UploadConfigInterface::getMaxHeight()

Definition at line 151 of file Uploader.php.

MAX_IMAGE_WIDTH

const MAX_IMAGE_WIDTH = 4096

Maximum Image Width resolution in pixels. For image resizing on client side

Deprecated:

See also

\Magento\Framework\Image\Adapter\UploadConfigInterface::getMaxWidth()

Definition at line 144 of file Uploader.php.

MULTIPLE_STYLE

const MULTIPLE_STYLE = 1

Definition at line 130 of file Uploader.php.

SINGLE_STYLE

const SINGLE_STYLE = 0

#+ File upload type (multiple or single)

Definition at line 128 of file Uploader.php.

TMP_NAME_EMPTY

const TMP_NAME_EMPTY = 666

#- Temp file name empty code

Definition at line 137 of file Uploader.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/framework/File/Uploader.php