Package Class Reference

Public Member Functions
	__construct (PackagePool $packagePool, FileNameResolver $fileNameResolver, $area, $theme, $locale, $isVirtual=false, array $preProcessors=[], array $postProcessors=[])
	getArea ()
	getParent ()
	getTheme ()
	getLocale ()
	getPath ()
	isVirtual ()
	getParam ($name)
	setParam ($name, $value)
	getThemeModel ()
	getFile ($fileId)
	addFile (PackageFile $file)
	addFileToMap (PackageFile $file)
	getFiles ()
	deleteFile ($fileId)
	setParent ($parent)
	getMap ()
	getState ()
	setState ($state)
	getInheritanceLevel ()
	getResultMap ()
	getParentMap ()
	getParentFiles ($type=null)
	getParentPackages ()
	getPreProcessors ()
	getPostProcessors ()

Data Fields
const	STATE_PROGRESS = 0
const	STATE_COMPLETED = 1
const	BASE_AREA = 'base'
const	BASE_THEME = 'Magento/base'
const	BASE_LOCALE = 'default'

Detailed Description

Deployment Package

Definition at line 15 of file Package.php.

Constructor & Destructor Documentation

__construct()

__construct	(	PackagePool	$packagePool,
		FileNameResolver	$fileNameResolver,
			$area,
			$theme,
			$locale,
			$isVirtual = false,
		array	$preProcessors = [],
		array	$postProcessors = []
	)

Parameters

PackagePool	$packagePool
FileNameResolver	$fileNameResolver
string	$area
string	$theme
string	$locale
bool	$isVirtual
	ProcessorInterface[]	$preProcessors
	ProcessorInterface[]	$postProcessors

Definition at line 132 of file Package.php.

      {
        $this->packagePool = $packagePool;
        $this->fileNameResolver = $fileNameResolver;
        $this->area = $area;
        $this->theme = $theme;
        $this->locale = $locale;
        $this->isVirtual = $isVirtual;
        $this->preProcessors = $preProcessors;
        $this->postProcessors = $postProcessors;
    }

Member Function Documentation

addFile()

addFile

(

PackageFile

$file

)

Add file to package

Parameters

PackageFile

$file

Returns

string

Definition at line 253 of file Package.php.

    {
        if (!$file->getLocale()) {
            $file->setLocale($this->getLocale());
        }
        $this->files[$file->getFileId()] = $file;

        $deployedFilePath = $this->getPath() . '/'
            . ($file->getModule() ? ($file->getModule() . '/') : '')
            . $file->getDeployedFileName();
        $file->setDeployedFilePath($deployedFilePath);

        return $file->getFileId();
    }

addFileToMap()

addFileToMap

(

PackageFile

$file

)

Add file to the package map

Parameters

PackageFile

$file

Returns

void

Definition at line 274 of file Package.php.

    {
        $fileId = $file->getDeployedFileId();
        $this->map[$fileId] = [
            'area' => $this->getArea(),
            'theme' => $this->getTheme(),
            'locale' => $this->getLocale()
        ];
    }

deleteFile()

deleteFile

(

$fileId

)

Delete file from package by file id

Parameters

string

$fileId

Returns

void

Definition at line 321 of file Package.php.

    {
        unset($this->files[$fileId]);
    }

getArea()

getArea

(

)

Returns

string

Definition at line 155 of file Package.php.

    {
        return $this->area;
    }

getFile()

getFile

(

$fileId

)

Retrieve file by file id

Parameters

string

$fileId

Returns

bool|PackageFile

Definition at line 242 of file Package.php.

    {
        return isset($this->files[$fileId]) ? $this->files[$fileId] : false;
    }

getFiles()

getFiles

(

)

Retrieve all files

Returns

PackageFile[]

Definition at line 289 of file Package.php.

    {
        return $this->files;
    }

getInheritanceLevel()

getInheritanceLevel

(

)

Returns

int

Definition at line 391 of file Package.php.

    {
        $level = 0;
        $theme = $this->getThemeModel();
        if ($theme) {
            ++$level;
            while ($theme = $theme->getParentTheme()) {
                ++$level;
            }
        }
        return $level;
    }

getLocale()

getLocale

(

)

Returns

string

Definition at line 179 of file Package.php.

    {
        return $this->locale;
    }

getMap()

getMap

(

)

Retrieve map

Returns

array

Definition at line 365 of file Package.php.

    {
        return $this->map;
    }

getParam()

getParam

(

$name

)

Parameters

string

$name

Returns

mixed|null

Definition at line 210 of file Package.php.

    {
        return isset($this->params[$name]) ? $this->params[$name] : null;
    }

getParent()

getParent

(

)

Returns

Package

Definition at line 163 of file Package.php.

    {
        return $this->parent;
    }

getParentFiles()

getParentFiles

(

$type = null

)

Retrieve parent files

Parameters

string | null

$type

Returns

PackageFile[]

Definition at line 436 of file Package.php.

    {
        $files = [];
        foreach ($this->getParentPackages() as $parentPackage) {
            if ($type === null) {
                $files = array_merge($files, $parentPackage->getFiles());
            } else {
                $files = array_merge($files, $parentPackage->getFilesByType($type));
            }
        }
        return $files;
    }

getParentMap()

getParentMap

(

)

Retrieve parent map

Returns

array

Definition at line 421 of file Package.php.

    {
        $map = [];
        foreach ($this->getParentPackages() as $parentPackage) {
            $map = array_merge($map, $parentPackage->getMap());
        }
        return $map;
    }

getParentPackages()

getParentPackages

(

)

Retrieve parent packages list

Returns

Package[]

Definition at line 454 of file Package.php.

    {
        if ($this->parentPackages === null) {
            $this->parentPackages = [];
            $parentPaths = [];
            $this->collectParentPaths(
                $this,
                $this->getArea(),
                $this->getTheme(),
                $this->getLocale(),
                $parentPaths,
                $this->getThemeModel()
            );

            // collect packages in reverse order to have closer ancestor goes later
            foreach (array_reverse($parentPaths) as $path) {
                if ($package = $this->packagePool->getPackage($path)) {
                    $this->parentPackages[$path] = $package;
                }
            }
        }

        return $this->parentPackages;
    }

getPath()

getPath

(

)

Retrieve package path

Returns

string

Definition at line 189 of file Package.php.

    {
        return $this->getArea() . '/' . $this->getTheme() . '/' . $this->getLocale();
    }

getPostProcessors()

getPostProcessors

(

)

Returns

Processor\ProcessorInterface[]

Definition at line 490 of file Package.php.

    {
        return $this->postProcessors;
    }

getPreProcessors()

getPreProcessors

(

)

Returns

Processor\ProcessorInterface[]

Definition at line 482 of file Package.php.

    {
        return $this->preProcessors;
    }

getResultMap()

getResultMap

(

)

Retrieve inherited package map

Returns

array

Definition at line 409 of file Package.php.

    {
        $map = $this->getMap();
        $parentMap = $this->getParentMap();
        return array_merge($parentMap, $map);
    }

getState()

getState

(

)

Returns

int

Definition at line 373 of file Package.php.

    {
        return $this->state;
    }

getTheme()

getTheme

(

)

Returns

string

Definition at line 171 of file Package.php.

    {
        return $this->theme;
    }

getThemeModel()

getThemeModel

(

)

Retrieve theme model

Returns

ThemeInterface|null

Definition at line 231 of file Package.php.

    {
        return $this->packagePool->getThemeModel($this->getArea(), $this->getTheme());
    }

isVirtual()

isVirtual

(

)

Is package virtual and can not be referenced directly

Package considered as "virtual" when not all of the scope identifiers defined (area, theme, locale)

Returns

string

Definition at line 201 of file Package.php.

    {
        return $this->isVirtual;
    }

setParam()

setParam	(		$name,
			$value
	)

Parameters

string	$name
mixed	$value

Returns

bool

Definition at line 220 of file Package.php.

    {
        $this->params[$name] = $value;
        return true;
    }

setParent()

setParent

(

$parent

)

Parameters

Package

$parent

Returns

bool

Definition at line 354 of file Package.php.

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

setState()

setState

(

$state

)

Parameters

int

$state

Returns

bool

Definition at line 382 of file Package.php.

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

Field Documentation

BASE_AREA

const BASE_AREA = 'base'

Base area code

Definition at line 100 of file Package.php.

BASE_LOCALE

const BASE_LOCALE = 'default'

Base locale code

Definition at line 110 of file Package.php.

BASE_THEME

const BASE_THEME = 'Magento/base'

Base theme code

Definition at line 105 of file Package.php.

STATE_COMPLETED

const STATE_COMPLETED = 1

Deployment state identifier for "completed" state

Definition at line 95 of file Package.php.

STATE_PROGRESS

const STATE_PROGRESS = 0

Deployment state identifier for "in progress" state

Definition at line 90 of file Package.php.

---

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

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