FilePermissions Class Reference

Public Member Functions
	__construct (Filesystem $filesystem, DirectoryList $directoryList, State $state=null)
	getInstallationWritableDirectories ()
	getApplicationNonWritableDirectories ()
	getInstallationCurrentWritableDirectories ()
	getApplicationCurrentNonWritableDirectories ()
	getMissingWritablePathsForInstallation ($associative=false)
	getMissingWritableDirectoriesForDbUpgrade ()
	getMissingWritableDirectoriesForInstallation ()
	getUnnecessaryWritableDirectoriesForApplication ()

Protected Member Functions
	isWritable ($code)
	isNonWritable ($code)
	isReadableDirectory ($directory)

Protected Attributes
	$filesystem
	$directoryList
	$installationWritableDirectories = []
	$applicationNonWritableDirectories = []
	$installationCurrentWritableDirectories = []
	$applicationCurrentNonWritableDirectories = []
	$nonWritablePathsInDirectories = []

Detailed Description

Checks permissions to files and folders.

Definition at line 18 of file FilePermissions.php.

Constructor & Destructor Documentation

__construct()

__construct	(	Filesystem	$filesystem,
		DirectoryList	$directoryList,
		State	$state = null
	)

Parameters

Filesystem	$filesystem
DirectoryList	$directoryList
State	$state

Definition at line 75 of file FilePermissions.php.

      {
        $this->filesystem = $filesystem;
        $this->directoryList = $directoryList;
        $this->state = $state ?: ObjectManager::getInstance()->get(State::class);
    }

Member Function Documentation

getApplicationCurrentNonWritableDirectories()

getApplicationCurrentNonWritableDirectories

(

)

Retrieve list of currently non-writable directories for application

Returns

array

Definition at line 197 of file FilePermissions.php.

    {
        if (!$this->applicationCurrentNonWritableDirectories) {
            foreach ($this->applicationNonWritableDirectories as $code => $path) {
                if ($this->isNonWritable($code)) {
                    $this->applicationCurrentNonWritableDirectories[] = $path;
                }
            }
        }
        return $this->applicationCurrentNonWritableDirectories;
    }

getApplicationNonWritableDirectories()

getApplicationNonWritableDirectories

(

)

Retrieve list of recommended non-writable directories for application

Returns

array

Definition at line 114 of file FilePermissions.php.

    {
        if (!$this->applicationNonWritableDirectories) {
            $data = [
                DirectoryList::CONFIG,
            ];
            foreach ($data as $code) {
                $this->applicationNonWritableDirectories[$code] = $this->directoryList->getPath($code);
            }
        }
        return array_values($this->applicationNonWritableDirectories);
    }

getInstallationCurrentWritableDirectories()

getInstallationCurrentWritableDirectories

(

)

Retrieve list of currently writable directories for installation

Returns

array

Definition at line 132 of file FilePermissions.php.

    {
        if (!$this->installationCurrentWritableDirectories) {
            foreach ($this->installationWritableDirectories as $code => $path) {
                if ($this->isWritable($code)) {
                    if ($this->checkRecursiveDirectories($path)) {
                        $this->installationCurrentWritableDirectories[] = $path;
                    }
                } else {
                    $this->nonWritablePathsInDirectories[$path] = [$path];
                }
            }
        }
        return $this->installationCurrentWritableDirectories;
    }

getInstallationWritableDirectories()

getInstallationWritableDirectories

(

)

Retrieve list of required writable directories for installation

Returns

array

Definition at line 90 of file FilePermissions.php.

    {
        if (!$this->installationWritableDirectories) {
            $data = [
                DirectoryList::CONFIG,
                DirectoryList::VAR_DIR,
                DirectoryList::MEDIA,
                DirectoryList::STATIC_VIEW,
            ];
            if ($this->state->getMode() !== State::MODE_PRODUCTION) {
                $data[] = DirectoryList::GENERATED;
            }
            foreach ($data as $code) {
                $this->installationWritableDirectories[$code] = $this->directoryList->getPath($code);
            }
        }
        return array_values($this->installationWritableDirectories);
    }

getMissingWritableDirectoriesForDbUpgrade()

getMissingWritableDirectoriesForDbUpgrade

(

)

Checks writable paths for database upgrade, returns array of directory paths that requires write permission

Returns

array List of directories that requires write permission for database upgrade

Definition at line 282 of file FilePermissions.php.

    {
        $writableDirectories = [
            DirectoryList::CONFIG,
            DirectoryList::VAR_DIR
        ];

        $requireWritePermission = [];
        foreach ($writableDirectories as $code) {
            if (!$this->isWritable($code)) {
                $path = $this->directoryList->getPath($code);
                if (!$this->checkRecursiveDirectories($path)) {
                    $requireWritePermission[] = $path;
                }
            }
        }

        return $requireWritePermission;
    }

getMissingWritableDirectoriesForInstallation()

getMissingWritableDirectoriesForInstallation

(

)

Checks writable directories for installation

Deprecated:

100.1.0 Use getMissingWritablePathsForInstallation() to get all missing writable paths required for install.

Returns

array

Definition at line 309 of file FilePermissions.php.

    {
        $required = $this->getInstallationWritableDirectories();
        $current = $this->getInstallationCurrentWritableDirectories();
        return array_diff($required, $current);
    }

getMissingWritablePathsForInstallation()

getMissingWritablePathsForInstallation

(

$associative = false

)

Checks writable paths for installation, returns associative array if input is true, else returns simple array

Parameters

bool

$associative

Returns

array

Definition at line 253 of file FilePermissions.php.

    {
        $required = $this->getInstallationWritableDirectories();
        $current = $this->getInstallationCurrentWritableDirectories();
        $missingPaths = [];
        foreach (array_diff($required, $current) as $missingPath) {
            if (isset($this->nonWritablePathsInDirectories[$missingPath])) {
                if ($associative) {
                    $missingPaths[$missingPath] = $this->nonWritablePathsInDirectories[$missingPath];
                } else {
                    $missingPaths = array_merge(
                        $missingPaths,
                        $this->nonWritablePathsInDirectories[$missingPath]
                    );
                }
            }
        }
        if ($associative) {
            $required = array_flip($required);
            $missingPaths = array_merge($required, $missingPaths);
        }
        return $missingPaths;
    }

getUnnecessaryWritableDirectoriesForApplication()

getUnnecessaryWritableDirectoriesForApplication

(

)

Checks non-writable directories for application

Returns

array

Definition at line 321 of file FilePermissions.php.

    {
        $required = $this->getApplicationNonWritableDirectories();
        $current = $this->getApplicationCurrentNonWritableDirectories();
        return array_diff($required, $current);
    }

isNonWritable()

isNonWritable (   $code )

protected

Checks if directory is non-writable by given directory code

Parameters

string

$code

Returns

bool

Definition at line 227 of file FilePermissions.php.

    {
        $directory = $this->filesystem->getDirectoryWrite($code);
        return $this->isReadableDirectory($directory) && !$directory->isWritable();
    }

isReadableDirectory()

isReadableDirectory (   $directory )

protected

Checks if directory exists and is readable

Parameters

\Magento\Framework\Filesystem\Directory\WriteInterface

$directory

Returns

bool

Definition at line 239 of file FilePermissions.php.

    {
        if (!$directory->isExist() || !$directory->isDirectory() || !$directory->isReadable()) {
            return false;
        }
        return true;
    }

isWritable()

isWritable (   $code )

protected

Checks if directory is writable by given directory code

Parameters

string

$code

Returns

bool

Definition at line 215 of file FilePermissions.php.

    {
        $directory = $this->filesystem->getDirectoryWrite($code);
        return $this->isReadableDirectory($directory) && $directory->isWritable();
    }

Field Documentation

$applicationCurrentNonWritableDirectories

$applicationCurrentNonWritableDirectories = []

protected

Definition at line 61 of file FilePermissions.php.

$applicationNonWritableDirectories

$applicationNonWritableDirectories = []

protected

Definition at line 47 of file FilePermissions.php.

$directoryList

$directoryList

protected

Definition at line 28 of file FilePermissions.php.

$filesystem

$filesystem

protected

Definition at line 23 of file FilePermissions.php.

$installationCurrentWritableDirectories

$installationCurrentWritableDirectories = []

protected

Definition at line 54 of file FilePermissions.php.

$installationWritableDirectories

$installationWritableDirectories = []

protected

Definition at line 40 of file FilePermissions.php.

$nonWritablePathsInDirectories

$nonWritablePathsInDirectories = []

protected

Definition at line 68 of file FilePermissions.php.

---

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

• vendor/magento/framework/Setup/FilePermissions.php