CleanupFiles.php 2.7 KB
Newer Older
Ketan's avatar
Ketan committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117
<?php
/**
 * Copyright © Magento, Inc. All rights reserved.
 * See COPYING.txt for license details.
 */

namespace Magento\Framework\App\State;

use Magento\Framework\Filesystem;
use Magento\Framework\Exception\FileSystemException;
use Magento\Framework\App\Filesystem\DirectoryList;

/**
 * A service for cleaning up application state
 */
class CleanupFiles
{
    /**
     * File system
     *
     * @var Filesystem
     */
    private $filesystem;

    /**
     * Constructor
     *
     * @param Filesystem $filesystem
     */
    public function __construct(Filesystem $filesystem)
    {
        $this->filesystem = $filesystem;
    }

    /**
     * Clears all files that are subject of code generation
     *
     * @return string[]
     */
    public function clearCodeGeneratedFiles()
    {
        return array_merge(
            $this->clearCodeGeneratedClasses(),
            $this->clearMaterializedViewFiles()
        );
    }

    /**
     * Clears code-generated classes
     *
     * @return string[]
     */
    public function clearCodeGeneratedClasses()
    {
        return array_merge(
            $this->emptyDir(DirectoryList::GENERATED_CODE),
            $this->emptyDir(DirectoryList::GENERATED_METADATA)
        );
    }

    /**
     * Clears materialized static view files
     *
     * @return string[]
     */
    public function clearMaterializedViewFiles()
    {
        return array_merge(
            $this->emptyDir(DirectoryList::STATIC_VIEW),
            $this->emptyDir(DirectoryList::VAR_DIR, DirectoryList::TMP_MATERIALIZATION_DIR)
        );
    }

    /**
     * Clears all files
     *
     * @return string[]
     */
    public function clearAllFiles()
    {
        return array_merge(
            $this->emptyDir(DirectoryList::STATIC_VIEW),
            $this->emptyDir(DirectoryList::VAR_DIR)
        );
    }

    /**
     * Deletes contents of specified directory
     *
     * @param string $code
     * @param string|null $subPath
     * @return string[]
     */
    private function emptyDir($code, $subPath = null)
    {
        $messages = [];

        $dir = $this->filesystem->getDirectoryWrite($code);
        $dirPath = $dir->getAbsolutePath();
        if (!$dir->isExist()) {
            $messages[] = "The directory '{$dirPath}' doesn't exist - skipping cleanup";
            return $messages;
        }
        foreach ($dir->search('*', $subPath) as $path) {
            if ($path !== '.' && $path !== '..') {
                $messages[] = $dirPath . $path;
                try {
                    $dir->delete($path);
                } catch (FileSystemException $e) {
                    $messages[] = $e->getMessage();
                }
            }
        }

        return $messages;
    }
}