File Class Reference

Public Member Functions
	__construct ($filename, $module, ThemeInterface $theme=null, $isBase=false)
	getFilename ()
	getName ()
	getModule ()
	getTheme ()
	isBase ()
	getFileIdentifier ()

Protected Attributes
	$filename
	$module
	$theme
	$isBase
	$identifier

Detailed Description

View file in the file system with context of its identity

Definition at line 14 of file File.php.

Constructor & Destructor Documentation

__construct()

__construct	(		$filename,
			$module,
		ThemeInterface	$theme = null,
			$isBase = false
	)

Constructor

Parameters

string	$filename
string	$module
ThemeInterface	$theme
bool	$isBase

Definition at line 59 of file File.php.

    {
        $this->filename = $filename;
        $this->module = $module;
        $this->theme = $theme;
        $this->isBase = $isBase;
    }

Member Function Documentation

getFileIdentifier()

getFileIdentifier

(

)

Calculate unique identifier for a view file

Returns

string

Definition at line 122 of file File.php.

    {
        if (null === $this->identifier) {
            $theme = $this->getTheme() ? ('|theme:' . $this->theme->getFullPath()) : '';
            $this->identifier = ($this->isBase ? 'base' : '')
                . $theme . '|module:' . $this->getModule() . '|file:' . $this->getName();
        }
        return $this->identifier;
    }

getFilename()

getFilename

(

)

Retrieve full filename

Returns

string

Definition at line 72 of file File.php.

    {
        return $this->filename;
    }

getModule()

getModule

(

)

Retrieve fully-qualified name of a module a file belongs to

Returns

string

Definition at line 92 of file File.php.

    {
        return $this->module;
    }

getName()

getName

(

)

Retrieve name of a file without a directory path

Returns

string

Definition at line 82 of file File.php.

    {
        return basename($this->filename);
    }

getTheme()

getTheme

(

)

Retrieve instance of a theme a file belongs to

Returns

ThemeInterface|null

Definition at line 102 of file File.php.

    {
        return $this->theme;
    }

isBase()

isBase

(

)

Whether file is a base one

Returns

bool

Definition at line 112 of file File.php.

    {
        return $this->theme === null;
    }

Field Documentation

$filename

$filename

protected

Definition at line 21 of file File.php.

$identifier

$identifier

protected

Definition at line 49 of file File.php.

$isBase

$isBase

protected

Definition at line 42 of file File.php.

$module

$module

protected

Definition at line 28 of file File.php.

$theme

$theme

protected

Definition at line 35 of file File.php.

---

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

• vendor/magento/framework/View/File.php