PackageFile Class Reference

Inheritance diagram for PackageFile:

Public Member Functions
	setPackage (Package $package)
	getPackage ()
	getOrigPackage ()
	setDeployedFileName ($name)
	getDeployedFileName ()
	setDeployedFilePath ($name)
	getDeployedFilePath ()
	getDeployedFileId ()
	getContent ()
	setContent ($content)
	setArea ($area)
	setTheme ($theme)
	setLocale ($locale)
	setModule ($module)
Public Member Functions inherited from Asset
	__construct ( $fileName, $sourcePath=null, $area=null, $theme=null, $locale=null, $module=null)
	getFileName ()
	getFileId ()
	getFilePath ()
	getSourcePath ()
	getModule ()
	getArea ()
	getTheme ()
	getLocale ()
	getExtension ()

Additional Inherited Members
Protected Attributes inherited from Asset
	$module
	$area
	$theme
	$locale

Detailed Description

Deployment Package File class

Definition at line 14 of file PackageFile.php.

Member Function Documentation

getContent()

getContent

(

)

Returns

string

Definition at line 124 of file PackageFile.php.

    {
        return $this->content;
    }

getDeployedFileId()

getDeployedFileId

(

)

Returns

string

Definition at line 113 of file PackageFile.php.

    {
        if ($this->getModule()) {
            return $this->getModule() . Repository::FILE_ID_SEPARATOR . $this->getDeployedFileName();
        }
        return $this->getDeployedFileName();
    }

getDeployedFileName()

getDeployedFileName

(

)

Returns

string

Definition at line 87 of file PackageFile.php.

    {
        return $this->deployedFileName;
    }

getDeployedFilePath()

getDeployedFilePath

(

)

Returns

string

Definition at line 105 of file PackageFile.php.

    {
        return $this->deployedFilePath;
    }

getOrigPackage()

getOrigPackage

(

)

Returns

Package

Definition at line 69 of file PackageFile.php.

    {
        return $this->origPackage;
    }

getPackage()

getPackage

(

)

Returns

Package

Definition at line 61 of file PackageFile.php.

    {
        return $this->package;
    }

setArea()

setArea

(

$area

)

Parameters

string

$area

Returns

bool

Definition at line 143 of file PackageFile.php.

    {
        $this->area = $area;
        return true;
    }

setContent()

setContent

(

$content

)

Parameters

string

$content

Returns

bool

Definition at line 133 of file PackageFile.php.

    {
        $this->content = $content;
        return true;
    }

setDeployedFileName()

setDeployedFileName

(

$name

)

Parameters

string

$name

Returns

bool

Definition at line 78 of file PackageFile.php.

    {
        $this->deployedFileName = $name;
        return true;
    }

setDeployedFilePath()

setDeployedFilePath

(

$name

)

Parameters

string

$name

Returns

bool

Definition at line 96 of file PackageFile.php.

    {
        $this->deployedFilePath = $name;
        return true;
    }

setLocale()

setLocale

(

$locale

)

Parameters

string

$locale

Returns

bool

Definition at line 163 of file PackageFile.php.

    {
        $this->locale = $locale;
        return true;
    }

setModule()

setModule

(

$module

)

Parameters

string

$module

Returns

bool

Definition at line 173 of file PackageFile.php.

    {
        $this->module = $module;
        return true;
    }

setPackage()

setPackage

(

Package

$package

)

Parameters

Package

$package

Returns

bool

Definition at line 45 of file PackageFile.php.

    {
        $this->package = $package;
        if ($this->origPackage === null) {
            $this->origPackage = $package;
        }

        $package->addFile($this);
        $package->addFileToMap($this);

        return true;
    }

setTheme()

setTheme

(

$theme

)

Parameters

string

$theme

Returns

bool

Definition at line 153 of file PackageFile.php.

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

---

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

• vendor/magento/module-deploy/Package/PackageFile.php