CopyService Class Reference

Public Member Functions
	__construct (\Magento\Framework\Filesystem $filesystem, \Magento\Framework\View\Design\Theme\FileFactory $fileFactory, \Magento\Widget\Model\Layout\Link $link, \Magento\Widget\Model\Layout\UpdateFactory $updateFactory, \Magento\Framework\Event\ManagerInterface $eventManager, \Magento\Framework\View\Design\Theme\Customization\Path $customization)
	copy (ThemeInterface $source, ThemeInterface $target)

Protected Member Functions
	_copyFilesystemCustomization (ThemeInterface $source, ThemeInterface $target)
	_copyFilesRecursively ($baseDir, $sourceDir, $targetDir)
	_deleteFilesRecursively ($targetDir)

Protected Attributes
	$_directory
	$_fileFactory
	$_link
	$_updateFactory
	$_eventManager
	$_customizationPath

Detailed Description

Definition at line 15 of file CopyService.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\Filesystem	$filesystem,
		\Magento\Framework\View\Design\Theme\FileFactory	$fileFactory,
		\Magento\Widget\Model\Layout\Link	$link,
		\Magento\Widget\Model\Layout\UpdateFactory	$updateFactory,
		\Magento\Framework\Event\ManagerInterface	$eventManager,
		\Magento\Framework\View\Design\Theme\Customization\Path	$customization
	)

Parameters

\Magento\Framework\Filesystem	$filesystem
\Magento\Framework\View\Design\Theme\FileFactory	$fileFactory
\Magento\Widget\Model\Layout\Link	$link
\Magento\Widget\Model\Layout\UpdateFactory	$updateFactory
\Magento\Framework\Event\ManagerInterface	$eventManager
\Magento\Framework\View\Design\Theme\Customization\Path	$customization

Definition at line 55 of file CopyService.php.

      {
        $this->_directory = $filesystem->getDirectoryWrite(DirectoryList::MEDIA);
        $this->_fileFactory = $fileFactory;
        $this->_link = $link;
        $this->_updateFactory = $updateFactory;
        $this->_eventManager = $eventManager;
        $this->_customizationPath = $customization;
    }

Member Function Documentation

_copyFilesRecursively()

_copyFilesRecursively (   $baseDir,   $sourceDir,   $targetDir  )

protected

Copies all files in a directory recursively

Parameters

string	$baseDir
string	$sourceDir
string	$targetDir

Returns

void

Definition at line 180 of file CopyService.php.

    {
        foreach ($this->_directory->read($sourceDir) as $path) {
            if ($this->_directory->isDirectory($path)) {
                $this->_copyFilesRecursively($baseDir, $path, $targetDir);
            } else {
                $filePath = substr($path, strlen($baseDir) + 1);
                $this->_directory->copyFile($path, $targetDir . '/' . $filePath);
            }
        }
    }

_copyFilesystemCustomization()

_copyFilesystemCustomization ( ThemeInterface  $source, ThemeInterface  $target  )

protected

Copy customizations stored in a file system from one theme to another, overriding existing data

Parameters

ThemeInterface	$source
ThemeInterface	$target

Returns

void

Definition at line 156 of file CopyService.php.

    {
        $sourcePath = $this->_customizationPath->getCustomizationPath($source);
        $targetPath = $this->_customizationPath->getCustomizationPath($target);

        if (!$sourcePath || !$targetPath) {
            return;
        }

        $this->_deleteFilesRecursively($targetPath);

        if ($this->_directory->isDirectory($sourcePath)) {
            $this->_copyFilesRecursively($sourcePath, $sourcePath, $targetPath);
        }
    }

_deleteFilesRecursively()

_deleteFilesRecursively (   $targetDir )

protected

Delete all files in a directory recursively

Parameters

string

$targetDir

Returns

void

Definition at line 198 of file CopyService.php.

    {
        if ($this->_directory->isExist($targetDir)) {
            foreach ($this->_directory->read($targetDir) as $path) {
                $this->_directory->delete($path);
            }
        }
    }

copy()

copy	(	ThemeInterface	$source,
		ThemeInterface	$target
	)

Copy customizations from one theme to another

Parameters

ThemeInterface	$source
ThemeInterface	$target

Returns

void

Definition at line 78 of file CopyService.php.

    {
        $this->_copyDatabaseCustomization($source, $target);
        $this->_copyLayoutCustomization($source, $target);
        $this->_copyFilesystemCustomization($source, $target);
    }

Field Documentation

$_customizationPath

$_customizationPath

protected

Definition at line 45 of file CopyService.php.

$_directory

$_directory

protected

Definition at line 20 of file CopyService.php.

$_eventManager

$_eventManager

protected

Definition at line 40 of file CopyService.php.

$_fileFactory

$_fileFactory

protected

Definition at line 25 of file CopyService.php.

$_link

$_link

protected

Definition at line 30 of file CopyService.php.

$_updateFactory

$_updateFactory

protected

Definition at line 35 of file CopyService.php.

---

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

• vendor/magento/module-theme/Model/CopyService.php