Inheritance diagram for DirectoryList:

Public Member Functions
	__construct ($root, array $config=[])

Public Member Functions inherited from DirectoryList
	__construct ($root, array $config=[])

	getRoot ()

	getPath ($code)

	getUrlPath ($code)

Static Public Member Functions
static	getDefaultConfig ()

Static Public Member Functions inherited from DirectoryList
static	getDefaultConfig ()

static	validate ($config)

Data Fields
const	ROOT = 'base'

const	APP = 'app'

const	CONFIG = 'etc'

const	LIB_INTERNAL = 'lib_internal'

const	LIB_WEB = 'lib_web'

const	PUB = 'pub'

const	MEDIA = 'media'

const	STATIC_VIEW = 'static'

const	VAR_DIR = 'var'

const	TMP = 'tmp'

const	CACHE = 'cache'

const	LOG = 'log'

const	SESSION = 'session'

const	SETUP = 'setup'

const	DI = 'di'

const	GENERATION = 'generation'

const	UPLOAD = 'upload'

const	COMPOSER_HOME = 'composer_home'

const	TMP_MATERIALIZATION_DIR = 'view_preprocessed'

const	TEMPLATE_MINIFICATION_DIR = 'html'

const	GENERATED = 'generated'

const	GENERATED_CODE = 'code'

const	GENERATED_METADATA = 'metadata'

Data Fields inherited from DirectoryList
const	PATH = 'path'

const	URL_PATH = 'uri'

const	SYS_TMP = 'sys_tmp'

Additional Inherited Members
Protected Member Functions inherited from DirectoryList
	prependRoot ($path)

	isAbsolute ($path)

Detailed Description

A Magento application specific list of directories

Definition at line 13 of file DirectoryList.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(		$root,
		array	$config = `[]`
	)

{}

Definition at line 174 of file DirectoryList.php.

     {
         parent::__construct($root, [self::ROOT => [self::PATH => $root]] + $config);
     }

Member Function Documentation

◆ getDefaultConfig()

static getDefaultConfig ( )

static

{}

Definition at line 141 of file DirectoryList.php.

     {
         $result = [
             self::ROOT => [parent::PATH => ''],
             self::APP => [parent::PATH => 'app'],
             self::CONFIG => [parent::PATH => 'app/etc'],
             self::LIB_INTERNAL => [parent::PATH => 'lib/internal'],
             self::VAR_DIR => [parent::PATH => 'var'],
             self::CACHE => [parent::PATH => 'var/cache'],
             self::LOG => [parent::PATH => 'var/log'],
             self::DI => [parent::PATH => 'generated/metadata'],
             self::GENERATION => [parent::PATH => Io::DEFAULT_DIRECTORY],
             self::SESSION => [parent::PATH => 'var/session'],
             self::MEDIA => [parent::PATH => 'pub/media', parent::URL_PATH => 'pub/media'],
             self::STATIC_VIEW => [parent::PATH => 'pub/static', parent::URL_PATH => 'pub/static'],
             self::PUB => [parent::PATH => 'pub', parent::URL_PATH => 'pub'],
             self::LIB_WEB => [parent::PATH => 'lib/web'],
             self::TMP => [parent::PATH => 'var/tmp'],
             self::UPLOAD => [parent::PATH => 'pub/media/upload', parent::URL_PATH => 'pub/media/upload'],
             self::TMP_MATERIALIZATION_DIR => [parent::PATH => 'var/view_preprocessed/pub/static'],
             self::TEMPLATE_MINIFICATION_DIR => [parent::PATH => 'var/view_preprocessed'],
             self::SETUP => [parent::PATH => 'setup/src'],
             self::COMPOSER_HOME => [parent::PATH => 'var/composer_home'],
             self::GENERATED => [parent::PATH => 'generated'],
             self::GENERATED_CODE => [parent::PATH => Io::DEFAULT_DIRECTORY],
             self::GENERATED_METADATA => [parent::PATH => 'generated/metadata'],
         ];
         return parent::getDefaultConfig() + $result;
     }

Field Documentation

◆ APP

const APP = 'app'

Most of entire application

Definition at line 23 of file DirectoryList.php.

◆ CACHE

const CACHE = 'cache'

File system caching directory (if file system caching is used)

Definition at line 68 of file DirectoryList.php.

◆ COMPOSER_HOME

const COMPOSER_HOME = 'composer_home'

Directory to store composer related files (config, cache etc.) in case if composer runs by Magento Application

Definition at line 110 of file DirectoryList.php.

◆ CONFIG

const CONFIG = 'etc'

Initial configuration of the application

Definition at line 28 of file DirectoryList.php.

◆ DI

const DI = 'di'

Dependency injection related file directory

Deprecated:: this constant become unused after moving folder for generated DI configuration files to generated/metadata

See also: self::GENERATED_METADATA

Definition at line 92 of file DirectoryList.php.

◆ GENERATED

const GENERATED = 'generated'

Directory name for generated data.

Definition at line 126 of file DirectoryList.php.

◆ GENERATED_CODE

const GENERATED_CODE = 'code'

Relative directory key for generated code

Definition at line 131 of file DirectoryList.php.

◆ GENERATED_METADATA

const GENERATED_METADATA = 'metadata'

Relative directory key for generated metadata

Definition at line 136 of file DirectoryList.php.

◆ GENERATION

const GENERATION = 'generation'

Relative directory key for generated code

Deprecated:: this constant become unused after moving folder for generated files to generated/code

See also: self::GENERATED_CODE

Definition at line 100 of file DirectoryList.php.

◆ LIB_INTERNAL

const LIB_INTERNAL = 'lib_internal'

Libraries or third-party components

Definition at line 33 of file DirectoryList.php.

◆ LIB_WEB

const LIB_WEB = 'lib_web'

Libraries/components that need to be accessible publicly through web-server (such as various DHTML components)

Definition at line 38 of file DirectoryList.php.

◆ LOG

const LOG = 'log'

Logs of system messages and errors

Definition at line 73 of file DirectoryList.php.

◆ MEDIA

const MEDIA = 'media'

Storage of files entered or generated by the end-user

Definition at line 48 of file DirectoryList.php.

◆ PUB

const PUB = 'pub'

\Directory within document root of a web-server to access static view files publicly

Definition at line 43 of file DirectoryList.php.

◆ ROOT

const ROOT = 'base'

Code base root

Definition at line 18 of file DirectoryList.php.

◆ SESSION

const SESSION = 'session'

File system session directory (if file system session storage is used)

Definition at line 78 of file DirectoryList.php.

◆ SETUP

const SETUP = 'setup'

Directory for Setup application

Definition at line 83 of file DirectoryList.php.

◆ STATIC_VIEW

const STATIC_VIEW = 'static'

Storage of static view files that are needed on HTML-pages, emails or similar content

Definition at line 53 of file DirectoryList.php.

◆ TEMPLATE_MINIFICATION_DIR

const TEMPLATE_MINIFICATION_DIR = 'html'

A suffix for temporary materialization directory where minified templates will be written (if necessary)

Deprecated:: since 2.2.0

Definition at line 121 of file DirectoryList.php.

◆ TMP

const TMP = 'tmp'

Temporary files

Definition at line 63 of file DirectoryList.php.

◆ TMP_MATERIALIZATION_DIR

const TMP_MATERIALIZATION_DIR = 'view_preprocessed'

A suffix for temporary materialization directory where pre-processed files will be written (if necessary)

Definition at line 115 of file DirectoryList.php.

◆ UPLOAD

const UPLOAD = 'upload'

Temporary directory for uploading files by end-user

Definition at line 105 of file DirectoryList.php.

◆ VAR_DIR

const VAR_DIR = 'var'

Various files generated by the system in runtime

Definition at line 58 of file DirectoryList.php.

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

vendor/magento/framework/App/Filesystem/DirectoryList.php

Public Member Functions

Static Public Member Functions

Data Fields

Additional Inherited Members