Inheritance diagram for ComponentInstaller\Process\Process:

Collaboration diagram for ComponentInstaller\Process\Process:

Public Member Functions

__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

init ()

Initialize the process before its run. More...

Protected Attributes
	$composer

	$io

	$config

	$packages = array()

	$componentDir = 'components'

	$fs

	$installationManager

Detailed Description

The base Process type.

Processes are initialized, and then run during installation.

Definition at line 26 of file Process.php.

Constructor & Destructor Documentation

◆ __construct()

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.

}

Implements ComponentInstaller\Process\ProcessInterface.

Definition at line 67 of file Process.php.

References ComponentInstaller\Process\Process\$composer, ComponentInstaller\Process\Process\$io, array, and ComponentInstaller\Process\ProcessInterface\init().

     {
         $this->composer = isset($composer) ? $composer : new Composer();
         $this->io = isset($io) ? $io : new NullIO();
         $this->fs = new Filesystem();
         $this->installationManager = $this->composer->getInstallationManager();
     }

Here is the call graph for this function:

Member Function Documentation

◆ getComponentDir()

ComponentInstaller\Process\Process::getComponentDir ( )

Retrieves the component directory.

Definition at line 177 of file Process.php.

References ComponentInstaller\Process\Process\$componentDir.

     {
         return $this->componentDir;
     }

◆ getComponentName()

ComponentInstaller\Process\Process::getComponentName	(		$prettyName,
		array	$extra = `array()`
	)

Retrieves the component name for the component.

Parameters

string	$prettyName	The Composer package name.
array	$extra	The extra config options sent from Composer.

Returns: string The name of the component, without its vendor name.

Definition at line 154 of file Process.php.

References array.

Referenced by ComponentInstaller\Process\BuildJsProcess\compile(), ComponentInstaller\Process\CopyProcess\copy(), ComponentInstaller\Process\RequireCssProcess\packageStyles(), and ComponentInstaller\Process\RequireJsProcess\requireJson().

     {
         // Parse the pretty name for the vendor and name.
         if (strpos($prettyName, '/') !== false) {
             list($vendor, $name) = explode('/', $prettyName);
             unset($vendor);
         } else {
             // Vendor wasn't found, so default to the pretty name instead.
             $name = $prettyName;
         }
 
         // Allow the component to define its own name.
         $component = isset($extra['component']) ? $extra['component'] : array();
         if (isset($component['name'])) {
             $name = $component['name'];
         }
 
         return $name;
     }

Here is the caller graph for this function:

◆ getVendorDir()

ComponentInstaller\Process\Process::getVendorDir ( array $package )

Retrieves the given package's vendor directory, where it's installed.

Parameters

array $package The package to retrieve the vendor directory for.

Returns: string

Definition at line 199 of file Process.php.

References $loader, and $path.

Referenced by ComponentInstaller\Process\RequireJsProcess\aggregateScripts(), ComponentInstaller\Process\CopyProcess\copy(), and ComponentInstaller\Process\RequireCssProcess\packageStyles().

     {
         // The root package vendor directory is not handled by getInstallPath().
         if (isset($package['is-root']) && $package['is-root'] === true) {
             $path = getcwd();
 
             if (!file_exists($path.DIRECTORY_SEPARATOR.'composer.json')) {
                 for ($temp = __DIR__; strlen($temp) > 3; $temp = dirname($temp)) {
                     if (file_exists($temp.DIRECTORY_SEPARATOR.'composer.json')) {
                         $path = $temp;
                     }
                 }
             }
 
             return $path;
         }
 
         if (!isset($package['version'])) {
             $package['version'] = '1.0.0';
         }
         $loader = new ArrayLoader();
         $completePackage = $loader->load($package);
 
         return $this->installationManager->getInstallPath($completePackage);
     }

Here is the caller graph for this function:

◆ process()

ComponentInstaller\Process\Process::process ( )

{Called when running through the process.

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

}

Implements ComponentInstaller\Process\ProcessInterface.

Definition at line 138 of file Process.php.

     {
         return false;
     }

◆ setComponentDir()

ComponentInstaller\Process\Process::setComponentDir ( $dir )

Sets the component directory.

Parameters

string $dir

Returns: string

Definition at line 187 of file Process.php.

     {
         return $this->componentDir = $dir;
     }

Field Documentation

◆ $componentDir

ComponentInstaller\Process\Process::$componentDir = 'components'

protected

Definition at line 51 of file Process.php.

Referenced by ComponentInstaller\Process\Process\getComponentDir(), and ComponentInstaller\Process\RequireCssProcess\process().

◆ $composer

ComponentInstaller\Process\Process::$composer

protected

Definition at line 31 of file Process.php.

Referenced by ComponentInstaller\Process\Process\__construct().

◆ $config

ComponentInstaller\Process\Process::$config

protected

Definition at line 41 of file Process.php.

Referenced by ComponentInstaller\Process\RequireJsProcess\requireJson().

◆ $fs

ComponentInstaller\Process\Process::$fs

protected

Definition at line 56 of file Process.php.

◆ $installationManager

ComponentInstaller\Process\Process::$installationManager

protected

Definition at line 62 of file Process.php.

◆ $io

ComponentInstaller\Process\Process::$io

protected

Definition at line 36 of file Process.php.

Referenced by ComponentInstaller\Process\Process\__construct().

◆ $packages

ComponentInstaller\Process\Process::$packages = array()

protected

Definition at line 46 of file Process.php.

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

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

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

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getComponentDir()

◆ getComponentName()

◆ getVendorDir()

◆ process()

◆ setComponentDir()

Field Documentation

◆ $componentDir

◆ $composer

◆ $config

◆ $fs

◆ $installationManager

◆ $io

◆ $packages