ComponentInstaller\Process\CopyProcess Class Reference

Process which copies components from their source to the components folder. More...

Inheritance diagram for ComponentInstaller\Process\CopyProcess:

Collaboration diagram for ComponentInstaller\Process\CopyProcess:

Public Member Functions
	process ()
	{{Called when running through the process. Returns boolean True or false depending on whether the process was successful. }} More...
	copy ($packages)
	Copy file assets from the given packages to the component directory. More...
Public Member Functions inherited from ComponentInstaller\Process\Process
	__construct (Composer $composer=null, IOInterface $io=null)
	{Create a new Process. Parameters Composer $composer The Composer object to act on. IOInterface $io Input/Output object to act on. } More...
	process ()
	{Called when running through the process. Returns boolean True or false depending on whether the process was successful. } More...
	getComponentName ($prettyName, array $extra=array())
	Retrieves the component name for the component. More...
	getComponentDir ()
	Retrieves the component directory. More...
	setComponentDir ($dir)
	Sets the component directory. More...
	getVendorDir (array $package)
	Retrieves the given package's vendor directory, where it's installed. More...
Public Member Functions inherited from ComponentInstaller\Process\ProcessInterface
	__construct (Composer $composer, IOInterface $io)
	Create a new Process. More...
	init ()
	Initialize the process before its run. More...
	process ()
	Called when running through the process. More...

Additional Inherited Members
Protected Attributes inherited from ComponentInstaller\Process\Process
	$composer
	$io
	$config
	$packages = array()
	$componentDir = 'components'
	$fs
	$installationManager

Detailed Description

Process which copies components from their source to the components folder.

Definition at line 17 of file CopyProcess.php.

Member Function Documentation

copy()

ComponentInstaller\Process\CopyProcess::copy

(

$packages

)

Copy file assets from the given packages to the component directory.

Parameters

array

$packages

An array of packages.

Returns

bool

Definition at line 34 of file CopyProcess.php.

    {
        // Iterate over each package that should be processed.
        foreach ($packages as $package) {
            // Retrieve some information about the package.
            $packageDir = $this->getVendorDir($package);
            $name = isset($package['name']) ? $package['name'] : '__component__';
            $extra = isset($package['extra']) ? $package['extra'] : array();
            $componentName = $this->getComponentName($name, $extra);
 
            // Cycle through each asset type.
            $fileType = array('scripts', 'styles', 'files');
            foreach ($fileType as $type) {
                // Only act on the files if they're available.
                if (isset($extra['component'][$type]) && is_array($extra['component'][$type])) {
                    foreach ($extra['component'][$type] as $file) {
                        // Make sure the file itself is available.
                        $source = $packageDir.DIRECTORY_SEPARATOR.$file;
 
                        // Perform a recursive glob file search on the pattern.
                        foreach ($this->fs->recursiveGlobFiles($source) as $filesource) {
                            // Find the final destination without the package directory.
                            $withoutPackageDir = str_replace($packageDir.DIRECTORY_SEPARATOR, '', $filesource);
 
                            // Construct the final file destination.
                            $destination = $this->componentDir.DIRECTORY_SEPARATOR.$componentName.DIRECTORY_SEPARATOR.$withoutPackageDir;
 
                            // Ensure the directory is available.
                            $this->fs->ensureDirectoryExists(dirname($destination));
 
                            // Copy the file to its destination.
                            copy($filesource, $destination);
                        }
                    }
                }
            }
        }
 
        return true;
    }

References $file, ComponentInstaller\Process\Process\$packages, ComponentInstaller\Process\CopyProcess\copy(), ComponentInstaller\Process\Process\getComponentName(), and ComponentInstaller\Process\Process\getVendorDir().

Referenced by ComponentInstaller\Process\CopyProcess\copy(), and ComponentInstaller\Process\CopyProcess\process().

Here is the call graph for this function:

Here is the caller graph for this function:

process()

ComponentInstaller\Process\CopyProcess::process

(

)

{{Called when running through the process.

Returns

boolean True or false depending on whether the process was successful.

}}

Reimplemented from ComponentInstaller\Process\Process.

Definition at line 22 of file CopyProcess.php.

    {
        return $this->copy($this->packages);
    }

References ComponentInstaller\Process\CopyProcess\copy().

Here is the call graph for this function:

---

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

• libs/composer/vendor/robloach/component-installer/src/ComponentInstaller/Process/CopyProcess.php