DeployStaticFile Class Reference

Public Member Functions
	__construct (Filesystem $filesystem, Repository $assetRepo, Publisher $assetPublisher, FileNameResolver $fileNameResolver, Minification $minification)
	deployFile ($fileName, array $params=[])
	deleteFile ($path)
	readFile ($fileName, $filePath)
	openFile ($fileName, $filePath)
	writeFile ($fileName, $filePath, $content)
	copyFile ($fileName, $sourcePath, $targetPath)
	readTmpFile ($fileName, $filePath)
	writeTmpFile ($fileName, $filePath, $content)

Detailed Description

Deploy static file service

Definition at line 20 of file DeployStaticFile.php.

Constructor & Destructor Documentation

__construct()

__construct	(	Filesystem	$filesystem,
		Repository	$assetRepo,
		Publisher	$assetPublisher,
		FileNameResolver	$fileNameResolver,
		Minification	$minification
	)

DeployStaticFile constructor

Parameters

Filesystem	$filesystem
Repository	$assetRepo
Publisher	$assetPublisher
FileNameResolver	$fileNameResolver
Minification	$minification

Definition at line 63 of file DeployStaticFile.php.

      {
        $this->filesystem = $filesystem;
        $this->assetRepo = $assetRepo;
        $this->assetPublisher = $assetPublisher;
        $this->fileNameResolver = $fileNameResolver;
        $this->pubStaticDir = $this->filesystem->getDirectoryWrite(DirectoryList::STATIC_VIEW);
        $this->minification = $minification;
        $this->tmpDir = $filesystem->getDirectoryWrite(DirectoryList::TMP_MATERIALIZATION_DIR);
    }

Member Function Documentation

copyFile()

copyFile	(		$fileName,
			$sourcePath,
			$targetPath
	)

Copy resolved $fileName from $targetPath to $destinationPath

Parameters

string	$fileName
string	$sourcePath
string	$targetPath

Returns

bool

Definition at line 165 of file DeployStaticFile.php.

    {
        $fileName = $this->minification->addMinifiedSign($fileName);
        return $this->pubStaticDir->copyFile(
            $sourcePath . DIRECTORY_SEPARATOR . $this->resolveFile($fileName),
            $targetPath . DIRECTORY_SEPARATOR . $this->resolveFile($fileName)
        );
    }

deleteFile()

deleteFile

(

$path

)

Parameters

string

$path

Returns

void

Definition at line 98 of file DeployStaticFile.php.

    {
        if ($this->pubStaticDir->isExist($path)) {
            $absolutePath = $this->pubStaticDir->getAbsolutePath($path);
            if (is_link($absolutePath)) {
                $this->pubStaticDir->getDriver()->deleteFile($absolutePath);
            } else {
                if ($this->pubStaticDir->getDriver()->isFile($absolutePath)) {
                    $this->pubStaticDir->getDriver()->deleteFile($absolutePath);
                } else {
                    $this->pubStaticDir->getDriver()->deleteDirectory($absolutePath);
                }
            }
        }
    }

deployFile()

deployFile	(		$fileName,
		array	$params = []
	)

Parameters

string	$fileName
array	$params	['area' =>, 'theme' =>, 'locale' =>, 'module' =>]

Returns

string

Definition at line 84 of file DeployStaticFile.php.

    {
        $params['publish'] = true;
        $asset = $this->assetRepo->createAsset($this->resolveFile($fileName), $params);

        $this->assetPublisher->publish($asset);

        return $asset->getPath();
    }

openFile()

openFile	(		$fileName,
			$filePath
	)

Parameters

string	$fileName
string	$filePath

Returns

WriteInterface

Definition at line 137 of file DeployStaticFile.php.

    {
        $relativePath = $filePath . DIRECTORY_SEPARATOR . $this->resolveFile($fileName);
        return $this->pubStaticDir->openFile($relativePath, 'w+');
    }

readFile()

readFile	(		$fileName,
			$filePath
	)

Read resolved file from pub static directory

Parameters

string	$fileName
string	$filePath

Returns

string|false

Definition at line 121 of file DeployStaticFile.php.

    {
        $fileName = $this->minification->addMinifiedSign($fileName);
        $relativePath = $filePath . DIRECTORY_SEPARATOR . $this->resolveFile($fileName);
        if ($this->pubStaticDir->isFile($relativePath)) {
            return $this->pubStaticDir->readFile($relativePath);
        } else {
            return false;
        }
    }

readTmpFile()

readTmpFile	(		$fileName,
			$filePath
	)

Read file from tmp directory

Parameters

string	$fileName
string	$filePath

Returns

string

Definition at line 181 of file DeployStaticFile.php.

    {
        $relativePath = $filePath . DIRECTORY_SEPARATOR . $fileName;
        return $this->tmpDir->isFile($relativePath) ? $this->tmpDir->readFile($relativePath) : false;
    }

writeFile()

writeFile	(		$fileName,
			$filePath,
			$content
	)

Write resolved file to pub static directory

Parameters

string	$fileName
string	$filePath
string	$content

Returns

int The number of bytes that were written.

Definition at line 151 of file DeployStaticFile.php.

    {
        $relativePath = $filePath . DIRECTORY_SEPARATOR . $this->resolveFile($fileName);
        return $this->pubStaticDir->writeFile($relativePath, $content);
    }

writeTmpFile()

writeTmpFile	(		$fileName,
			$filePath,
			$content
	)

Write file to tmp directory

Parameters

string	$fileName
string	$filePath
string	$content

Returns

int The number of bytes that were written.

Definition at line 195 of file DeployStaticFile.php.

    {
        $relativePath = $filePath . DIRECTORY_SEPARATOR . $this->resolveFile($fileName);
        return $this->tmpDir->writeFile($relativePath, $content);
    }

---

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

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