Bundle Class Reference

Public Member Functions
	__construct (Filesystem $filesystem, BundleInterfaceFactory $bundleFactory, BundleConfig $bundleConfig, Files $files)
	deploy ($area, $theme, $locale)

Data Fields
const	BUNDLE_JS_DIR = 'js/bundle'
const	ASSET_TYPE_JS = 'js'
const	ASSET_TYPE_HTML = 'html'

Static Public Attributes
static	$availableTypes

Detailed Description

Deploy bundled static files service

Read all static files from deployed packages and generate bundles. Bundle Factory can be configured to use bundle format different from RequireJS used out of the box

Definition at line 23 of file Bundle.php.

Constructor & Destructor Documentation

__construct()

__construct	(	Filesystem	$filesystem,
		BundleInterfaceFactory	$bundleFactory,
		BundleConfig	$bundleConfig,
		Files	$files
	)

Bundle constructor

Parameters

Filesystem	$filesystem
BundleInterfaceFactory	$bundleFactory
BundleConfig	$bundleConfig
Files	$files

Definition at line 87 of file Bundle.php.

      {
        $this->pubStaticDir = $filesystem->getDirectoryWrite(DirectoryList::STATIC_VIEW);
        $this->bundleFactory = $bundleFactory;
        $this->bundleConfig = $bundleConfig;
        $this->utilityFiles = $files;
    }

Member Function Documentation

deploy()

deploy	(		$area,
			$theme,
			$locale
	)

Deploy bundles for the given area, theme and locale

Parameters

string	$area
string	$theme
string	$locale

Returns

void

Definition at line 107 of file Bundle.php.

    {
        $bundle = $this->bundleFactory->create([
            'area' => $area,
            'theme' => $theme,
            'locale' => $locale
        ]);

        // delete all previously created bundle files
        $bundle->clear();
        $files = [];
        $mapFilePath = $area . '/' . $theme . '/' . $locale . '/' . RepositoryMap::RESULT_MAP_NAME;
        if ($this->pubStaticDir->isFile($mapFilePath)) {
            // map file is available in compact mode, so no need to scan filesystem one more time
            $resultMap = $this->pubStaticDir->readFile($mapFilePath);
            if ($resultMap) {
                $files = json_decode($resultMap, true);
            }
        } else {
            $packageDir = $this->pubStaticDir->getAbsolutePath($area . '/' . $theme . '/' . $locale);
            $files = $this->utilityFiles->getFiles([$packageDir], '*.*');
        }

        foreach ($files as $filePath => $sourcePath) {
            if (is_array($sourcePath)) {
                $filePath = str_replace(Repository::FILE_ID_SEPARATOR, '/', $filePath);
                $sourcePath = $sourcePath['area']
                    . '/' . $sourcePath['theme']
                    . '/' . $sourcePath['locale']
                    . '/' . $filePath;
            } else {
                $sourcePath = str_replace('\\', '/', $sourcePath);
                $sourcePath = $this->pubStaticDir->getRelativePath($sourcePath);
                $filePath = substr($sourcePath, strlen($area . '/' . $theme . '/' . $locale) + 1);
            }

            $contentType = pathinfo($filePath, PATHINFO_EXTENSION);
            if (!in_array($contentType, self::$availableTypes)) {
                continue;
            }

            if ($this->hasMinVersion($filePath) || $this->isExcluded($filePath, $area, $theme)) {
                continue;
            }

            $bundle->addFile($filePath, $sourcePath, $contentType);
        }
        $bundle->flush();
    }

Field Documentation

$availableTypes

$availableTypes

static

Initial value:

= [
        self::ASSET_TYPE_JS,
        self::ASSET_TYPE_HTML
    ]

Definition at line 74 of file Bundle.php.

ASSET_TYPE_HTML

const ASSET_TYPE_HTML = 'html'

Matched file extension name for template files

Definition at line 38 of file Bundle.php.

ASSET_TYPE_JS

const ASSET_TYPE_JS = 'js'

Matched file extension name for JavaScript files

Definition at line 33 of file Bundle.php.

BUNDLE_JS_DIR

const BUNDLE_JS_DIR = 'js/bundle'

Path to package subdirectory where bundle files are located

Definition at line 28 of file Bundle.php.

---

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

• vendor/magento/module-deploy/Service/Bundle.php