Inheritance diagram for Database:

Public Member Functions
	__construct (\Magento\Framework\App\Helper\Context $context, \Magento\MediaStorage\Model\File\Storage\DatabaseFactory $dbStorageFactory, \Magento\MediaStorage\Model\File\Storage\File $fileStorage, Filesystem $filesystem)

	checkDbUsage ()

	getStorageDatabaseModel ()

	getStorageFileModel ()

	getResourceStorageModel ()

	saveFile ($filename)

	renameFile ($oldName, $newName)

	copyFile ($oldName, $newName)

	fileExists ($filename)

	getUniqueFilename ($directory, $filename)

	getMediaRelativePath ($fullPath)

	deleteFolder ($folderName)

	deleteFile ($filename)

	saveUploadedFile ($result)

	getMediaBaseDir ()

Public Member Functions inherited from AbstractHelper
	__construct (Context $context)

	isModuleOutputEnabled ($moduleName=null)

Protected Member Functions
	_removeAbsPathFromFileName ($filename)

Protected Member Functions inherited from AbstractHelper
	_getRequest ()

	_getModuleName ()

	_getUrl ($route, $params=[])

Protected Attributes
	$_databaseModel = null

	$_resourceModel = null

	$_useDb = null

	$_mediaBaseDirectory

	$_filesystem

	$_dbStorageFactory

	$_fileStorage

Protected Attributes inherited from AbstractHelper
	$_moduleName

	$_request

	$_moduleManager

	$_logger

	$_urlBuilder

	$_httpHeader

	$_eventManager

	$_remoteAddress

	$urlEncoder

	$urlDecoder

	$scopeConfig

	$_cacheConfig

Detailed Description

Database saving file helper

@api

Since: 100.0.2

Definition at line 18 of file Database.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Framework\App\Helper\Context	$context,
		\Magento\MediaStorage\Model\File\Storage\DatabaseFactory	$dbStorageFactory,
		\Magento\MediaStorage\Model\File\Storage\File	$fileStorage,
		Filesystem	$filesystem
	)

Parameters

\Magento\Framework\App\Helper\Context	$context
\Magento\MediaStorage\Model\File\Storage\DatabaseFactory	$dbStorageFactory
\Magento\MediaStorage\Model\File\Storage\File	$fileStorage
Filesystem	$filesystem

Definition at line 67 of file Database.php.

       {
         $this->_filesystem = $filesystem;
         $this->_dbStorageFactory = $dbStorageFactory;
         $this->_fileStorage = $fileStorage;
         parent::__construct($context);
     }

Member Function Documentation

◆ _removeAbsPathFromFileName()

_removeAbsPathFromFileName ( $filename )

protected

Convert full file path to local (as used by model) If not - returns just a filename

Parameters

string $filename

Returns: string

Definition at line 318 of file Database.php.

     {
         return $this->getMediaRelativePath($filename);
     }

◆ checkDbUsage()

checkDbUsage ( )

Check if we use DB storage

Returns: bool

Definition at line 84 of file Database.php.

     {
         if (null === $this->_useDb) {
             $currentStorage = (int)$this->scopeConfig->getValue(
                 \Magento\MediaStorage\Model\File\Storage::XML_PATH_STORAGE_MEDIA,
                 'default'
             );
             $this->_useDb = $currentStorage == \Magento\MediaStorage\Model\File\Storage::STORAGE_MEDIA_DATABASE;
         }
 
         return $this->_useDb;
     }

◆ copyFile()

copyFile	(	$oldName,
		$newName
	)

Copy file in DB storage

Parameters

string	$oldName
string	$newName

Returns: void

Definition at line 171 of file Database.php.

     {
         if ($this->checkDbUsage()) {
             $this->getStorageDatabaseModel()->copyFile(
                 $this->_removeAbsPathFromFileName($oldName),
                 $this->_removeAbsPathFromFileName($newName)
             );
         }
     }

◆ deleteFile()

deleteFile ( $filename )

Deletes from DB files, which belong to one folder

Parameters

string $filename

Returns: void

Definition at line 271 of file Database.php.

     {
         if ($this->checkDbUsage()) {
             $this->getStorageDatabaseModel()->deleteFile($this->_removeAbsPathFromFileName($filename));
         }
     }

◆ deleteFolder()

deleteFolder ( $folderName )

Deletes from DB files, which belong to one folder

Parameters

string $folderName

Returns: void

Definition at line 258 of file Database.php.

     {
         if ($this->checkDbUsage()) {
             $this->getResourceStorageModel()->deleteFolder($this->_removeAbsPathFromFileName($folderName));
         }
     }

◆ fileExists()

fileExists ( $filename )

Check whether file exists in DB

Parameters

string $filename can be both full path or partial (like in DB)

Returns: bool|null

Definition at line 187 of file Database.php.

     {
         if ($this->checkDbUsage()) {
             return $this->getStorageDatabaseModel()->fileExists($this->_removeAbsPathFromFileName($filename));
         } else {
             return null;
         }
     }

◆ getMediaBaseDir()

getMediaBaseDir ( )

Return Media base dir

Returns: string

Definition at line 328 of file Database.php.

     {
         if (null === $this->_mediaBaseDirectory) {
             $mediaDir = $this->_filesystem->getDirectoryRead(DirectoryList::MEDIA)->getAbsolutePath();
             $this->_mediaBaseDirectory = rtrim($mediaDir, '/');
         }
         return $this->_mediaBaseDirectory;
     }

◆ getMediaRelativePath()

getMediaRelativePath ( $fullPath )

Return relative uri for media content by full path

Parameters

string $fullPath

Returns: string

Definition at line 246 of file Database.php.

     {
         $relativePath = ltrim(str_replace($this->getMediaBaseDir(), '', $fullPath), '\\/');
         return str_replace('\\', '/', $relativePath);
     }

◆ getResourceStorageModel()

getResourceStorageModel ( )

Get storage model

Returns: \Magento\MediaStorage\Model\ResourceModel\File\Storage\Database

Definition at line 126 of file Database.php.

     {
         if ($this->_resourceModel === null) {
             $this->_resourceModel = $this->getStorageDatabaseModel()->getResource();
         }
         return $this->_resourceModel;
     }

◆ getStorageDatabaseModel()

getStorageDatabaseModel ( )

Get database storage model

Returns: \Magento\MediaStorage\Model\File\Storage\Database

Definition at line 102 of file Database.php.

     {
         if ($this->_databaseModel === null) {
             $this->_databaseModel = $this->_dbStorageFactory->create();
         }
 
         return $this->_databaseModel;
     }

◆ getStorageFileModel()

getStorageFileModel ( )

Get file storage model

Returns: \Magento\MediaStorage\Model\File\Storage\File

Definition at line 116 of file Database.php.

     {
         return $this->_fileStorage;
     }

◆ getUniqueFilename()

getUniqueFilename	(	$directory,
		$filename
	)

Get unique name for passed file in case this file already exists

Parameters

string	$directory	- can be both full path or partial (like in DB)
string	$filename	- not just a filename. Can have directory chunks. return will have this form

Returns: string

Definition at line 203 of file Database.php.

     {
         if ($this->checkDbUsage()) {
             $directory = $this->_removeAbsPathFromFileName($directory);
             if ($this->fileExists($directory . $filename)) {
                 $index = 1;
                 $extension = strrchr($filename, '.');
                 $filenameWoExtension = substr($filename, 0, -1 * strlen($extension));
                 while ($this->fileExists($directory . $filenameWoExtension . '_' . $index . $extension)) {
                     $index++;
                 }
                 $filename = $filenameWoExtension . '_' . $index . $extension;
             }
         }
         return $filename;
     }

◆ renameFile()

renameFile	(	$oldName,
		$newName
	)

Rename file in DB storage

Parameters

string	$oldName
string	$newName

Returns: void

Definition at line 154 of file Database.php.

     {
         if ($this->checkDbUsage()) {
             $this->getStorageDatabaseModel()->renameFile(
                 $this->_removeAbsPathFromFileName($oldName),
                 $this->_removeAbsPathFromFileName($newName)
             );
         }
     }

◆ saveFile()

saveFile ( $filename )

Save file in DB storage

Parameters

string $filename

Returns: void

Definition at line 140 of file Database.php.

     {
         if ($this->checkDbUsage()) {
             $this->getStorageDatabaseModel()->saveFile($this->_removeAbsPathFromFileName($filename));
         }
     }

◆ saveUploadedFile()

saveUploadedFile ( $result )

Saves uploaded by \Magento\MediaStorage\Model\File\Uploader file to DB with existence tests

param $result should be result from \Magento\MediaStorage\Model\File\Uploader::save() method Checks in DB, whether uploaded file exists ($result['file']) If yes, renames file on FS (!!!!!) Saves file with unique name into DB If passed file exists returns new name, file was renamed to (in the same context) Otherwise returns $result['file']

Parameters

array $result

Returns: string

Definition at line 291 of file Database.php.

     {
         if ($this->checkDbUsage()) {
             $path = rtrim(str_replace(['\\', '/'], '/', $result['path']), '/');
             $file = '/' . ltrim($result['file'], '\\/');
 
             $uniqueResultFile = $this->getUniqueFilename($path, $file);
 
             if ($uniqueResultFile !== $file) {
                 $dirWrite = $this->_filesystem->getDirectoryWrite(DirectoryList::ROOT);
                 $dirWrite->renameFile($path . $file, $path . $uniqueResultFile);
             }
             $this->saveFile($path . $uniqueResultFile);
 
             return $uniqueResultFile;
         } else {
             return $result['file'];
         }
     }

Field Documentation

◆ $_databaseModel

$_databaseModel = null

protected

Definition at line 24 of file Database.php.

◆ $_dbStorageFactory

$_dbStorageFactory

protected

Definition at line 54 of file Database.php.

◆ $_fileStorage

$_fileStorage

protected

Definition at line 59 of file Database.php.

◆ $_filesystem

$_filesystem

protected

Definition at line 49 of file Database.php.

◆ $_mediaBaseDirectory

$_mediaBaseDirectory

protected

Definition at line 44 of file Database.php.

◆ $_resourceModel

$_resourceModel = null

protected

Definition at line 30 of file Database.php.

◆ $_useDb

$_useDb = null

protected

Definition at line 37 of file Database.php.

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

vendor/magento/module-media-storage/Helper/File/Storage/Database.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _removeAbsPathFromFileName()

◆ checkDbUsage()

◆ copyFile()

◆ deleteFile()

◆ deleteFolder()

◆ fileExists()

◆ getMediaBaseDir()

◆ getMediaRelativePath()

◆ getResourceStorageModel()

◆ getStorageDatabaseModel()

◆ getStorageFileModel()

◆ getUniqueFilename()

◆ renameFile()

◆ saveFile()

◆ saveUploadedFile()

Field Documentation

◆ $_databaseModel

◆ $_dbStorageFactory

◆ $_fileStorage

◆ $_filesystem

◆ $_mediaBaseDirectory

◆ $_resourceModel

◆ $_useDb