Collector Class Reference

Inheritance diagram for Collector:

Public Member Functions
	__construct (SourcePool $sourcePool, FileNameResolver $fileNameResolver, PackageFactory $packageFactory)
	collect ()

Detailed Description

Deployable files collector

Default implementation uses Source Pool object (

See also

SourcePool)

Definition at line 18 of file Collector.php.

Constructor & Destructor Documentation

__construct()

__construct	(	SourcePool	$sourcePool,
		FileNameResolver	$fileNameResolver,
		PackageFactory	$packageFactory
	)

Collector constructor

Parameters

SourcePool	$sourcePool
FileNameResolver	$fileNameResolver
PackageFactory	$packageFactory

Definition at line 65 of file Collector.php.

      {
        $this->sourcePool = $sourcePool;
        $this->fileNameResolver = $fileNameResolver;
        $this->packageFactory = $packageFactory;
    }

Member Function Documentation

collect()

collect

(

)

Retrieve all static files from registered locations split to packages. Unique package is identified for each combination of three key scope identifiers:

• area
• theme
• locale

Returns

Package[]

Implements CollectorInterface.

Definition at line 78 of file Collector.php.

    {
        $packages = [];
        foreach ($this->sourcePool->getAll() as $source) {
            $files = $source->get();
            foreach ($files as $file) {
                $file->setDeployedFileName($this->fileNameResolver->resolve($file->getFileName()));
                $params = [
                    'area' => $file->getArea(),
                    'theme' => $file->getTheme(),
                    'locale' => $file->getLocale(),
                    'module' => $file->getModule(),
                    'isVirtual' => (!$file->getLocale() || !$file->getTheme() || !$file->getArea())
                ];
                foreach ($this->packageDefaultValues as $name => $value) {
                    if (!isset($params[$name])) {
                        $params[$name] = $value;
                    }
                }
                $packagePath = "{$params['area']}/{$params['theme']}/{$params['locale']}";
                if (!isset($packages[$packagePath])) {
                    $packages[$packagePath] = $this->packageFactory->create($params);
                }
                if ($file->getFilePath()) {
                    $file->setPackage($packages[$packagePath]);
                }
            }
        }
        return $packages;
    }

---

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

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