ComponentInstaller\Process\RequireJsProcess Class Reference

Builds the require.js configuration. More...

Inheritance diagram for ComponentInstaller\Process\RequireJsProcess:

Collaboration diagram for ComponentInstaller\Process\RequireJsProcess:

Public Member Functions
	init ()
	{Initialize the process before its run. Returns boolean Whether or not the process should continue after initialization. } More...
	process ()
	{Called when running through the process. Returns boolean True or false depending on whether the process was successful. } More...
	requireJson (array $packages)
	Creates a require.js configuration from an array of packages. More...
	aggregateScripts ($package, array $scripts, $file)
	Concatenate all scripts together into one destination file. More...
	requireJs (array $json=array())
	Constructs the require.js file from the provided require.js JSON array. 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...

Protected Member Functions
	arrayMergeRecursiveDistinct (array &$array1, array &$array2)
	Merges two arrays without changing string array keys. More...

Protected Attributes
	$baseUrl = 'components'
	The base URL for the require.js configuration. More...
Protected Attributes inherited from ComponentInstaller\Process\Process
	$composer
	$io
	$config
	$packages = array()
	$componentDir = 'components'
	$fs
	$installationManager

Detailed Description

Builds the require.js configuration.

Definition at line 23 of file RequireJsProcess.php.

Member Function Documentation

aggregateScripts()

ComponentInstaller\Process\RequireJsProcess::aggregateScripts	(		$package,
		array	$scripts,
			$file
	)

Concatenate all scripts together into one destination file.

Parameters

array	$package
array	$scripts
string	$file

Returns

bool

Definition at line 158 of file RequireJsProcess.php.

References $js, $path, and ComponentInstaller\Process\Process\getVendorDir().

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

    {
        $assets = $this->newAssetCollection();

        foreach ($scripts as $script) {
            // Collect each candidate from a glob file search.
            $path = $this->getVendorDir($package).DIRECTORY_SEPARATOR.$script;
            $matches = $this->fs->recursiveGlobFiles($path);
            foreach ($matches as $match) {
                $assets->add(new FileAsset($match));
            }
        }
        $js = $assets->dump();

        // Write the file if there are any JavaScript assets.
        if (!empty($js)) {
            $destination = $this->componentDir.DIRECTORY_SEPARATOR.$file;
            $this->fs->ensureDirectoryExists(dirname($destination));

            return file_put_contents($destination, $js);
        }

        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

arrayMergeRecursiveDistinct()

ComponentInstaller\Process\RequireJsProcess::arrayMergeRecursiveDistinct ( array &  $array1, array &  $array2  )

protected

Merges two arrays without changing string array keys.

Appends to array if keys are numeric.

See also

array_merge()

array_merge_recursive()

Parameters

array	$array1
array	$array2

Returns

array

Definition at line 223 of file RequireJsProcess.php.

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

    {
        $merged = $array1;

        foreach ($array2 as $key => &$value) {
            if(is_numeric($key)){
                $merged[] = $value;
            } else {
                if (is_array($value) && isset($merged[$key]) && is_array($merged[$key])) {
                    $merged[$key] = $this->arrayMergeRecursiveDistinct($merged[$key], $value);
                }
                else {
                    $merged[$key] = $value;
                }
            }
        }

        return $merged;
    }

Here is the caller graph for this function:

init()

ComponentInstaller\Process\RequireJsProcess::init

(

)

{Initialize the process before its run.

Returns

boolean Whether or not the process should continue after initialization.

}

Implements ComponentInstaller\Process\ProcessInterface.

Definition at line 33 of file RequireJsProcess.php.

References $output.

    {
        $output = parent::init();
        if ($this->config->has('component-baseurl')) {
            $this->baseUrl = $this->config->get('component-baseurl');
        }

        return $output;
    }

process()

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

References ComponentInstaller\Process\RequireJsProcess\requireJs(), and ComponentInstaller\Process\RequireJsProcess\requireJson().

    {
        // Construct the require.js and stick it in the destination.
        $json = $this->requireJson($this->packages, $this->config);
        $requireConfig = $this->requireJs($json);

        // Attempt to write the require.config.js file.
        $destination = $this->componentDir . '/require.config.js';
        $this->fs->ensureDirectoryExists(dirname($destination));
        if (file_put_contents($destination, $requireConfig) === FALSE) {
            $this->io->write('<error>Error writing require.config.js</error>');

            return false;
        }

        // Read in require.js to prepare the final require.js.
        if (!file_exists(dirname(__DIR__) . '/Resources/require.js')) {
            $this->io->write('<error>Error reading in require.js</error>');

            return false;
        }

        $assets = $this->newAssetCollection();
        $assets->add(new FileAsset(dirname(__DIR__) . '/Resources/require.js'));
        $assets->add(new StringAsset($requireConfig));

        // Append the config to the require.js and write it.
        if (file_put_contents($this->componentDir . '/require.js', $assets->dump()) === FALSE) {
            $this->io->write('<error>Error writing require.js to the components directory</error>');

            return false;
        }

        return null;
    }

Here is the call graph for this function:

requireJs()

ComponentInstaller\Process\RequireJsProcess::requireJs

(

array

$json = array()

)

Constructs the require.js file from the provided require.js JSON array.

Parameters

$json

The require.js JSON configuration.

Returns

string The RequireJS JavaScript configuration.

Definition at line 192 of file RequireJsProcess.php.

References $js, and $output.

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

    {
        // Encode the array to a JSON array.
        $js = JsonFile::encode($json);

        // Construct the JavaScript output.
        $output = <<<EOT
var components = $js;
if (typeof require !== "undefined" && require.config) {
    require.config(components);
} else {
    var require = components;
}
if (typeof exports !== "undefined" && typeof module !== "undefined") {
    module.exports = components;
}
EOT;

        return $output;
    }

Here is the caller graph for this function:

requireJson()

ComponentInstaller\Process\RequireJsProcess::requireJson

(

array

$packages

)

Creates a require.js configuration from an array of packages.

Parameters

$packages

An array of packages from the composer.lock file.

Returns

array The built JSON array.

Definition at line 91 of file RequireJsProcess.php.

References ComponentInstaller\Process\RequireJsProcess\$baseUrl, ComponentInstaller\Process\Process\$config, $options, $result, ComponentInstaller\Process\RequireJsProcess\aggregateScripts(), array, ComponentInstaller\Process\RequireJsProcess\arrayMergeRecursiveDistinct(), and ComponentInstaller\Process\Process\getComponentName().

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

    {
        $json = array();

        // Construct the packages configuration.
        foreach ($packages as $package) {
            // Retrieve information from the extra options.
            $extra = isset($package['extra']) ? $package['extra'] : array();
            $options = isset($extra['component']) ? $extra['component'] : array();

            // Construct the base details.
            $name = $this->getComponentName($package['name'], $extra);
            $component = array(
                'name' => $name,
            );

            // Build the "main" directive.
            $scripts = isset($options['scripts']) ? $options['scripts'] : array();
            if (!empty($scripts)) {
                // Put all scripts into a build.js file.
                $result = $this->aggregateScripts($package, $scripts, $name.DIRECTORY_SEPARATOR.$name.'-built.js');
                if ($result) {
                    // If the aggregation was successful, add the script to the
                    // packages array.
                    $component['main'] = $name.'-built.js';

                    // Add the component to the packages array.
                    $json['packages'][] = $component;
                }
            }

            // Add the shim definition for the package.
            $shim = isset($options['shim']) ? $options['shim'] : array();
            if (!empty($shim)) {
                $json['shim'][$name] = $shim;
            }

            // Add the config definition for the package.
            $packageConfig = isset($options['config']) ? $options['config'] : array();
            if (!empty($packageConfig)) {
                $json['config'][$name] = $packageConfig;
            }
        }

        // Provide the baseUrl.
        $json['baseUrl'] = $this->baseUrl;

        // Merge in configuration options from the root.
        if ($this->config->has('component')) {
            $config = $this->config->get('component');
            if (isset($config) && is_array($config)) {
                // Use a recursive, distict array merge.
                $json = $this->arrayMergeRecursiveDistinct($json, $config);
            }
        }

        return $json;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$baseUrl

ComponentInstaller\Process\RequireJsProcess::$baseUrl = 'components'

protected

The base URL for the require.js configuration.

Definition at line 28 of file RequireJsProcess.php.

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

---

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

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