Helper Class Reference

Public Member Functions
	rm ($path, $skipPaths=[], $removeRoot=false)
	getInfo ($path, $infoOptions=self::INFO_ALL, $skipFiles=[])

Data Fields
const	INFO_WRITABLE = 1
const	INFO_READABLE = 2
const	INFO_SIZE = 4
const	INFO_ALL = 7

Detailed Description

Filesystem helper

Author

Magento Core Team core@.nosp@m.mage.nosp@m.ntoco.nosp@m.mmer.nosp@m.ce.co.nosp@m.m

Definition at line 17 of file Helper.php.

Member Function Documentation

getInfo()

getInfo	(		$path,
			$infoOptions = self::INFO_ALL,
			$skipFiles = []
	)

Get information (readable, writable, size) about $path

Parameters

string	$path
int	$infoOptions
array	$skipFiles

Returns

array @SuppressWarnings(PHPMD.CyclomaticComplexity) @SuppressWarnings(PHPMD.NPathComplexity)

Definition at line 89 of file Helper.php.

    {
        $info = [];
        if ($infoOptions & self::INFO_READABLE) {
            $info['readable'] = true;
            $info['readableMeta'] = [];
        }

        if ($infoOptions & self::INFO_WRITABLE) {
            $info['writable'] = true;
            $info['writableMeta'] = [];
        }

        if ($infoOptions & self::INFO_SIZE) {
            $info['size'] = 0;
        }

        $filesystemIterator = new RecursiveIteratorIterator(
            new RecursiveDirectoryIterator($path),
            RecursiveIteratorIterator::CHILD_FIRST
        );

        $iterator = new Filter($filesystemIterator, $skipFiles);

        foreach ($iterator as $item) {
            if ($item->isLink()) {
                continue;
            }

            if ($infoOptions & self::INFO_WRITABLE && !$item->isWritable()) {
                $info['writable'] = false;
                $info['writableMeta'][] = $item->getPathname();
            }

            if ($infoOptions & self::INFO_READABLE && !$item->isReadable()) {
                $info['readable'] = false;
                $info['readableMeta'][] = $item->getPathname();
            }

            if ($infoOptions & self::INFO_SIZE && !$item->isDir()) {
                $info['size'] += $item->getSize();
            }
        }

        return $info;
    }

rm()

rm	(		$path,
			$skipPaths = [],
			$removeRoot = false
	)

Recursively delete $path

Parameters

string	$path
array	$skipPaths
bool	$removeRoot

Returns

void

Exceptions

Definition at line 61 of file Helper.php.

    {
        $filesystemIterator = new RecursiveIteratorIterator(
            new RecursiveDirectoryIterator($path),
            RecursiveIteratorIterator::CHILD_FIRST
        );

        $iterator = new Filter($filesystemIterator, $skipPaths);

        foreach ($iterator as $item) {
            $item->isDir() ? @rmdir($item->__toString()) : @unlink($item->__toString());
        }

        if ($removeRoot && is_dir($path)) {
            @rmdir($path);
        }
    }

Field Documentation

INFO_ALL

const INFO_ALL = 7

Constant can be used in getInfo() function as second parameter. Combination of INFO_WRITABLE, INFO_READABLE, INFO_SIZE

@const int

Definition at line 49 of file Helper.php.

INFO_READABLE

const INFO_READABLE = 2

Constant can be used in getInfo() function as second parameter. Check whether directory and all files/sub directories are readable

@const int

Definition at line 33 of file Helper.php.

INFO_SIZE

const INFO_SIZE = 4

Constant can be used in getInfo() function as second parameter. Get directory size

@const int

Definition at line 41 of file Helper.php.

INFO_WRITABLE

const INFO_WRITABLE = 1

Constant can be used in getInfo() function as second parameter. Check whether directory and all files/sub directories are writable

@const int

Definition at line 25 of file Helper.php.

---

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

• vendor/magento/framework/Backup/Filesystem/Helper.php