Best Practices für Dateisysteme

Ich arbeite an einer Magento 2-Erweiterung, die das Lesen von Dateien aus dem Dateisystem erfordert.
Wenn der PHP-Sniffer unter Verwendung der ECGM2-Standards ausgeführt wird, beschwert er sich über die Tatsache, dass ich Funktionen wie basenameoder verwende dirname.

Die Verwendung der Funktion dirname () ist verboten

oder

Die Verwendung der Funktion basename () ist verboten

Welchen Wrapper sollte ich anstelle dieser verwenden, um den gleichen Effekt zu erzielen?

[BEARBEITEN]
Hier ist ein Code, der jedoch für die Frage nicht so relevant ist.
Ich habe eine Sammlungsklasse, die die \Magento\Framework\Data\Collection\FilesystemKlasse erweitert, und ich möchte diese Sammlung in einem Raster (UI-Komponenten) auflisten. Eine der Aktionen im Raster ist eine Download-Aktion.
Dazu muss ich den tatsächlichen Namen der Datei erhalten, damit ich sie an die Download-Aktion senden kann.

    // 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 {
       ...
    }

Ich brauchte in letzter Zeit auch so etwas. Einzige Lösung, die ich gefunden habe basenameund die ich dirnameverwendet habe:

\ Magento \ Framework \ Dateisystem \ Io \ Datei

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

Vorher habe ich versucht Magento\Framework\Filesystem\Directory\Writeund getDriver()ohne Erfolg. Mit ihnen kann man so ziemlich alles bekommen, aber nicht das basename.

Zum Glück können wir mit git sehen, wann dirname und basename verboten waren. Der Grund dafür ist eindeutig "Hinzugefügte Dateien".

Wenn Sie sich das Problem für das EKG-Projekt ansehen, sehen Sie geschlossene Probleme, z. B. etwas Schlechtes in file_exists? # 33 , Fehlerfunktionen # 26 , etwas Schlechtes an diesen Funktionen? # 17 , Kontext / Erklärung für die Regeln # 12 , Die Verwendung der Funktion iconv () ist verboten # 14, was mich denken lassen würde, dass die anfängliche Liste der verbotenen Funktionen nicht zu sehr berücksichtigt wurde und Magento wahrscheinlich geändert werden kann die verbotene Liste.

Das Durchsuchen der m2-Codebasis zeigt ~ = 78 Ergebnisse für den Basisnamen, eine Mischung aus Variablen und den Code, der tatsächlich den Basisnamen aufruft, einschließlich meines Favoriten .

Ich denke, wenn ich du wäre, würde ich ein Problem auf Github posten und zlik fragen, ob er immer noch glaubt, dass sie dorthin gehören oder ob M2 einen Wrapper bereitstellt

Sie können ein Objekt der SplFileInfo()Klasse verwenden, möglicherweise funktioniert es.

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

Vielleicht wird es funktionieren.

Sie können auch auf diese URL verweisen .

Mein Vorschlag wäre, das Magento/BackupModul als Beispiel zu verwenden.

Es wäre interessant zu sehen, wie die Download-Aktionsklasse geschrieben ist, da sie sich auch mit realen Dateien zum Herunterladen befasst:

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;
}

Für mich sollten Sie sich ansehen, wie diese Methode die Datei generiert, die mit \Magento\Framework\App\Response\Http\FileFactoryund generateBackupDownloadNamevon heruntergeladen werden soll Magento\Backup\Helper\Data(beachten Sie die empfohlene Verwendung des OM;))

Ein weiteres interessantes Stück

Eine weitere interessante Sache , die Sie betrachten sollten , ist die getStorageDataMethode aus Magento\MediaStorage\Model\ResourceModel\File\Storage\Filedem sich Anrufe direkt dirnameund basenameaber , wenn Sie diese Kernmethode in Ihrem Modul aufrufen, werden Sie nicht die verbotenen Fehler bekommen;)

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 einer ähnlichen Idee gibt es auch die collectFileInfovonMagento\MediaStorage\Helper\File\Media