Filesystem best practices

Question

I'm working on some Magento 2 extension that requires reading files from the file system.
When running the php sniffer using the ECGM2 standards, it complains about the fact that I'm using functions like basename or dirname.

The use of function dirname() is forbidden

or

The use of function basename() is forbidden

What wrapper should I use instead of those to get the the same effect?

[EDIT]
Here is some code, but it's not that relevant to the question.
I have a collection class that extends the \Magento\Framework\Data\Collection\Filesystem class and I want to list this collection in a grid (ui-components) and one of the actions in the grid is a download action.
For this, I need to get the actual name of the file so I can send it to the download action.

    // here $file is dynamic and it can be
    // folder/filename.xml or folder/subfolder/file.tar.gz
    //so there is no strict number of folders and subfolders.
    $file = $downloader->getRelativePath($packageName);
    $relativeFile = UmcFilesystem::VAR_DIR_NAME . '/' .$file;
    $absoluteFile = $rootDir->getAbsolutePath($relativeFile);
    if ($rootDir->isFile($relativeFile) && $rootDir->isReadable($relativeFile)){
        //I don't want to use `explode` just for the sake of avoiding basename
        $fileName = basename($absoluteFile);
        $this->fileFactory->create(
            $fileName,
            null,
            DirectoryList::VAR_DIR,
            'application/octet-stream',
            $rootDir->stat($relativeFile)['size']
        );

        $resultRaw = $this->resultRawFactory->create();
        $resultRaw->setContents($rootDir->readFile($relativeFile));
        return $resultRaw;
    } else {
       ...
    }

Answer 1

I also needed something like that recently. The only solution I found to get basename and dirname was using:

\Magento\Framework\Filesystem\Io\File

protected function someFunction()
{
    /** @var \Magento\Framework\Filesystem\Io\File $fileSystemIo **/
    $fileInfo = $this->fileSystemIo->getPathInfo('<absolutePath>');
    $basename = $fileInfo['basename']; 
    $dirname = $fileInfo['dirname'];
}
    

Before that, I tried using Magento\Framework\Filesystem\Directory\Write and getDriver() with no success. With them, you can get pretty much everything but not the basename.

Answer 2

Luckily git lets us see when dirname and basename were forbidden, the reason is clearly, "Added files"

Looking at the issue for the ECG project you can see closed issues such as something bad in file_exists? #33, Error Functions #26, something bad in this functions? #17, Context / Explanation for the Rules #12, The use of function iconv() is forbidden #14 which would make me think that the initial list of forbidden functions wasn't given too much consideration, and magento are probably amenable to changing the forbidden list.

Searching the m2 codebase shows ~= 78 results for basename, a mix of variables and the code actually calling basename, including my favourite.

I think if I were you I'd post an issue on github and ask zlik if he still thinks they belong there or if M2 provides a wrapper

Answer 3

You can use object of SplFileInfo() class may be it will work.

$info = new SplFileInfo('/path/to/foo.txt');
var_dump($info->getFilename())

may be it will work.

you can also refer this url.

Answer 4

My suggestion would be to use the Magento/Backup module as an example.

The way the download action class is written would be interesting to look at because it also deals with real files to download:

public function execute()
{
    /* @var $backup \Magento\Backup\Model\Backup */
    $backup = $this->_backupModelFactory->create(
        $this->getRequest()->getParam('time'),
        $this->getRequest()->getParam('type')
    );

    if (!$backup->getTime() || !$backup->exists()) {
        /** @var \Magento\Backend\Model\View\Result\Redirect $resultRedirect */
        $resultRedirect = $this->resultRedirectFactory->create();
        $resultRedirect->setPath('backup/*');
        return $resultRedirect;
    }

    $fileName = $this->_objectManager->get('Magento\Backup\Helper\Data')->generateBackupDownloadName($backup);

    $this->_fileFactory->create(
        $fileName,
        null,
        DirectoryList::VAR_DIR,
        'application/octet-stream',
        $backup->getSize()
    );

    /** @var \Magento\Framework\Controller\Result\Raw $resultRaw */
    $resultRaw = $this->resultRawFactory->create();
    $resultRaw->setContents($backup->output());
    return $resultRaw;
}

To me you should look at the way this method generates the file to download using \Magento\Framework\App\Response\Http\FileFactory and generateBackupDownloadName from Magento\Backup\Helper\Data (notice the recommended use of the OM ;) )

Another interesting bit

Another interesting thing you should look at is the getStorageData method from Magento\MediaStorage\Model\ResourceModel\File\Storage\File which itself calls directly dirname and basename but if you call that core method in your module, you won't get the forbidden errors ;)

public function getStorageData($dir = '/')
{
    $files = [];
    $directories = [];
    $directoryInstance = $this->_filesystem->getDirectoryRead(DirectoryList::MEDIA);
    if ($directoryInstance->isDirectory($dir)) {
        foreach ($directoryInstance->readRecursively($dir) as $path) {
            $itemName = basename($path);
            if ($itemName == '.svn' || $itemName == '.htaccess') {
                continue;
            }
            if ($directoryInstance->isDirectory($path)) {
                $directories[] = [
                    'name' => $itemName,
                    'path' => dirname($path) == '.' ? '/' : dirname($path),
                ];
            } else {
                $files[] = $path;
            }
        }
    }

    return ['files' => $files, 'directories' => $directories];
}

In a similar idea, there's also the collectFileInfo from Magento\MediaStorage\Helper\File\Media