Studip\Squeeze Namespace Reference

Data Structures
class	Compressor
class	Configuration
class	Exception
class	Packager

Functions
	packageAll ($configFile=NULL, $outputDir=NULL)
	includePackages ($packager, $packages)
	shouldPackage ()
	packageAsIndividualURLs ($packager, $package)
	packageAsCompressedURL ($packager, $package)

Function Documentation

includePackages()

includePackages	(		$packager,
			$packages
	)

Include a single squeeze package depending on \Studip\ENV as individual script elements or as a single one containing the squeezed source code of all files comprising the package.

Parameters

Packager	$packager	the packager instance to use
array	$packages	an array containing the names of packages

Returns

an array containing PageLayout style HTML elements

Here is the call graph for this function:

packageAll()

packageAll	(		$configFile = NULL,
			$outputDir = NULL
	)

Write all packages specified in $configFile to $outputDir. The default $configFile is "$STUDIP_BASE_PATH/config/assets.yml"

Parameters

string	$configFile	path to the config file
string	$outputDir	path to the output directory

Here is the call graph for this function:

Here is the caller graph for this function:

packageAsCompressedURL()

packageAsCompressedURL	(		$packager,
			$package
	)

Include a single squeeze package as a single one containing the squeezed source code of all files comprising the package.

Parameters

Packager	$packager	the packager instance to use
string	$package	the name of a package

Returns

an array containing PageLayout style HTML elements

Here is the caller graph for this function:

packageAsIndividualURLs()

packageAsIndividualURLs	(		$packager,
			$package
	)

Include a single squeeze package as individual script elements.

Parameters

Packager	$packager	the packager instance to use
string	$package	the name of a package

Returns

an array containing PageLayout style HTML elements

Here is the caller graph for this function:

shouldPackage()

shouldPackage

(

)

Returns

bool TRUE in production mode, FALSE in development or while debugging (= GET request contains a 'debug_assets' param)

Here is the call graph for this function:

Here is the caller graph for this function: