ComponentInstaller\Process\BuildJsProcess Class Reference

Builds all JavaScript Components into one require-built.js. More...

Inheritance diagram for ComponentInstaller\Process\BuildJsProcess:

Collaboration diagram for ComponentInstaller\Process\BuildJsProcess:

Public Member Functions
	process ()
	{{Called when running through the process. Returns boolean True or false depending on whether the process was successful. }} More...
	compile ($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...

Protected Member Functions
	definePrefix ($componentName)
	Provide the initial definition prefix. More...
	definePostfix ()
	Finish the module definition. More...

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

Detailed Description

Builds all JavaScript Components into one require-built.js.

Definition at line 17 of file BuildJsProcess.php.

Member Function Documentation

compile()

ComponentInstaller\Process\BuildJsProcess::compile

(

$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 BuildJsProcess.php.

    {
        // Set up the initial require-build.js file.
        $destination = $this->componentDir.DIRECTORY_SEPARATOR.'require-built.js';
        $require = $this->componentDir.DIRECTORY_SEPARATOR.'require.js';
        copy($require, $destination);
 
        // Cycle through each package and add it to the built require.js file.
        foreach ($packages as $package) {
            // Retrieve some information about the package
            $name = isset($package['name']) ? $package['name'] : '__component__';
            $extra = isset($package['extra']) ? $package['extra'] : array();
            $componentName = $this->getComponentName($name, $extra);
 
            // Find where the source file is located.
            $packageDir = $this->componentDir.DIRECTORY_SEPARATOR.$componentName;
            $source = $packageDir.DIRECTORY_SEPARATOR.$componentName.'-built.js';
 
            // Make sure the source script is available.
            if (file_exists($source)) {
                // Build the compiled script.
                $content = file_get_contents($source);
                $output = $this->definePrefix($componentName) . $content . $this->definePostfix();
 
                // Append the module definition to the destination file.
                file_put_contents($destination, $output, FILE_APPEND);
            }
        }
 
        return true;
    }

References $output, ComponentInstaller\Process\Process\$packages, ComponentInstaller\Process\BuildJsProcess\definePostfix(), ComponentInstaller\Process\BuildJsProcess\definePrefix(), and ComponentInstaller\Process\Process\getComponentName().

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

Here is the call graph for this function:

Here is the caller graph for this function:

definePostfix()

ComponentInstaller\Process\BuildJsProcess::definePostfix ( )

protected

Finish the module definition.

Returns

string Close brackets to finish the module.

Definition at line 83 of file BuildJsProcess.php.

    {
        return "\n});\n";
    }

Referenced by ComponentInstaller\Process\BuildJsProcess\compile().

Here is the caller graph for this function:

definePrefix()

ComponentInstaller\Process\BuildJsProcess::definePrefix (   $componentName )

protected

Provide the initial definition prefix.

Parameters

string

$componentName

Returns

string Begin the module definition.

Definition at line 72 of file BuildJsProcess.php.

    {
        // Define the module using the simplified CommonJS wrapper.
        return "\ndefine('$componentName', function (require, exports, module) {\n";
    }

Referenced by ComponentInstaller\Process\BuildJsProcess\compile().

Here is the caller graph for this function:

process()

ComponentInstaller\Process\BuildJsProcess::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 BuildJsProcess.php.

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

References ComponentInstaller\Process\BuildJsProcess\compile().

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