ComponentInstaller\Process\RequireCssProcess Class Reference

Builds the require.css file from all Component stylesheets. More...

Inheritance diagram for ComponentInstaller\Process\RequireCssProcess:

Collaboration diagram for ComponentInstaller\Process\RequireCssProcess:

Public Member Functions
	process ()
	{{Called when running through the process. Returns boolean True or false depending on whether the process was successful. }} More...
	packageStyles (array $packages)
	Retrieves an array of styles from a collection of packages. 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

Builds the require.css file from all Component stylesheets.

Definition at line 23 of file RequireCssProcess.php.

Member Function Documentation

packageStyles()

ComponentInstaller\Process\RequireCssProcess::packageStyles

(

array

$packages

)

Retrieves an array of styles from a collection of packages.

Parameters

array

$packages

An array of packages from the composer.lock file.

Returns

array A set of package styles.

Definition at line 98 of file RequireCssProcess.php.

    {
        $output = array();
 
        // Construct the packages configuration.
        foreach ($packages as $package) {
            // Retrieve information from the extra options.
            $extra = isset($package['extra']) ? $package['extra'] : array();
            $name = $this->getComponentName($package['name'], $extra);
            $component = isset($extra['component']) ? $extra['component'] : array();
            $styles = isset($component['styles']) ? $component['styles'] : array();
            $vendorDir = $this->getVendorDir($package);
 
            // Loop through each style.
            foreach ($styles as $style) {
                // Find the style path from the vendor directory.
                $path = strtr($vendorDir.'/'.$style, '/', DIRECTORY_SEPARATOR);
 
                // Search for the candidate with a glob recursive file search.
                $files = $this->fs->recursiveGlobFiles($path);
                foreach ($files as $file) {
                    // Provide the package name, style and full path.
                    $output[$name][$style][] = $file;
                }
            }
        }
 
        return $output;
    }

References $file, $files, $output, ComponentInstaller\Process\Process\$packages, $path, $style, $styles, $vendorDir, ComponentInstaller\Process\Process\getComponentName(), and ComponentInstaller\Process\Process\getVendorDir().

Referenced by ComponentInstaller\Process\RequireCssProcess\process().

Here is the call graph for this function:

Here is the caller graph for this function:

process()

ComponentInstaller\Process\RequireCssProcess::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 28 of file RequireCssProcess.php.

    {
        $filters = array(new CssRewriteFilter());
        if ($this->config->has('component-styleFilters')) {
            $customFilters = $this->config->get('component-styleFilters');
            if (isset($customFilters) && is_array($customFilters)) {
                foreach ($customFilters as $filter => $filterParams) {
                    $reflection = new \ReflectionClass($filter);
                    $filters[] = $reflection->newInstanceArgs($filterParams);
                }
            }
        }
 
        $filterCollection = new FilterCollection($filters);
 
        $assets = new AssetCollection();
        $styles = $this->packageStyles($this->packages);
        foreach ($styles as $package => $packageStyles) {
            $packageAssets = new AssetCollection();
            $packagePath = $this->componentDir.'/'.$package;
 
            foreach ($packageStyles as $style => $paths) {
                foreach ($paths as $path) {
                    // The full path to the CSS file.
                    $assetPath = realpath($path);
                    // The root of the CSS file.
                    $sourceRoot = dirname($path);
                    // The style path to the CSS file when external.
                    $sourcePath = $package . '/' . $style;
                    //Replace glob patterns with filenames.
                    $filename = basename($style);
                    if(preg_match('~^\*(\.[^\.]+)$~', $filename, $matches)){
                        $sourcePath = str_replace($filename, basename($assetPath), $sourcePath);
                    }
                    // Where the final CSS will be generated.
                    $targetPath = $this->componentDir;
                    // Build the asset and add it to the collection.
                    $asset = new FileAsset($assetPath, $filterCollection, $sourceRoot, $sourcePath);
                    $asset->setTargetPath($targetPath);
                    $assets->add($asset);
                    // Add asset to package collection.
                    $sourcePath = preg_replace('{^.*'.preg_quote($package).'/}', '', $sourcePath);
                    $asset = new FileAsset($assetPath, $filterCollection, $sourceRoot, $sourcePath);
                    $asset->setTargetPath($packagePath);
                    $packageAssets->add($asset);
                }
            }
 
            if (file_put_contents($packagePath.'/'.$package.'-built.css', $packageAssets->dump()) === FALSE) {
                $this->io->write("<error>Error writing $package-built.css to destination</error>");
            }
        }
 
        if (file_put_contents($this->componentDir . '/require.css', $assets->dump()) === FALSE) {
            $this->io->write('<error>Error writing require.css to destination</error>');
            return false;
        }
 
        return null;
    }

References ComponentInstaller\Process\Process\$componentDir, $filename, $path, $style, $styles, and ComponentInstaller\Process\RequireCssProcess\packageStyles().

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/RequireCssProcess.php