Inheritance diagram for TYPO3\CMS\Core\Resource\ResourceCompressor:

Public Member Functions
	__construct ()

	setRootPath ($rootPath)

array	concatenateCssFiles (array $cssFiles)

array	concatenateJsFiles (array $jsFiles)

array	compressCssFiles (array $cssFiles)

string	compressCssFile ($filename)

array	compressJsFiles (array $jsFiles)

string	compressJsFile ($filename)

Protected Member Functions
mixed	createMergedCssFile (array $filesToInclude)

mixed	createMergedJsFile (array $filesToInclude)

mixed	createMergedFile (array $filesToInclude, $type='css')

string	getFilenameFromMainDir ($filename)

bool	checkBaseDirectory ($filename, array $baseDirectories)

string	cssFixRelativeUrlPaths (string $contents, string $filename)

string	cssFixStatements ($contents)

	writeFileAndCompressed ($filename, $contents)

string	returnFileReference ($filename)

string	retrieveExternalFile ($url)

string	compressCssString ($contents)

string	getJavaScriptFileType ()

	getPathFixer ()

Protected Attributes
string	$targetDirectory = 'typo3temp/assets/compressed/'

string	$rootPath = ''

bool	$createGzipped = false

int	$gzipCompressionLevel = -1

string	$htaccessTemplate

Detailed Description

Compressor This merges and compresses CSS and JavaScript files of the TYPO3 Backend.

Definition at line 28 of file ResourceCompressor.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Core\Resource\ResourceCompressor::__construct ( )

Constructor

Definition at line 61 of file ResourceCompressor.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\MathUtility\canBeInterpretedAsInteger(), TYPO3\CMS\Core\Core\Environment\getBackendPath(), TYPO3\CMS\Core\Core\Environment\getPublicPath(), TYPO3\CMS\Core\Utility\GeneralUtility\mkdir_deep(), TYPO3\CMS\Core\Resource\ResourceCompressor\setRootPath(), and TYPO3\CMS\Core\Utility\GeneralUtility\writeFile().

Member Function Documentation

◆ checkBaseDirectory()

bool TYPO3\CMS\Core\Resource\ResourceCompressor::checkBaseDirectory	(		$filename,
		array	$baseDirectories
	)

protected

Decides whether a file comes from one of the baseDirectories

Parameters

string	$filename	‪Filename
array	$baseDirectories	‪Base directories

Returns: ‪bool File belongs to a base directory or not

Definition at line 480 of file ResourceCompressor.php.

◆ compressCssFile()

string TYPO3\CMS\Core\Resource\ResourceCompressor::compressCssFile ( $filename )

Compresses a CSS file

Options: baseDirectories If set, only include files below one of the base directories

removes comments and whitespaces Adopted from https://github.com/drupal/drupal/blob/8.0.x/core/lib/Drupal/Core/Asset/CssOptimizer.php

Parameters

string $filename ‪Source filename, relative to requested page

Returns: ‪string Compressed filename, relative to requested page

Definition at line 334 of file ResourceCompressor.php.

References TYPO3\CMS\Core\Resource\ResourceCompressor\compressCssString(), TYPO3\CMS\Core\Resource\ResourceCompressor\cssFixRelativeUrlPaths(), TYPO3\CMS\Core\Resource\ResourceCompressor\getFilenameFromMainDir(), TYPO3\CMS\Core\Core\Environment\getPublicPath(), TYPO3\CMS\Core\Utility\PathUtility\pathinfo(), TYPO3\CMS\Core\Resource\ResourceCompressor\returnFileReference(), TYPO3\CMS\Core\Utility\PathUtility\stripPathSitePrefix(), and TYPO3\CMS\Core\Resource\ResourceCompressor\writeFileAndCompressed().

Referenced by TYPO3\CMS\Core\Resource\ResourceCompressor\compressCssFiles().

◆ compressCssFiles()

array TYPO3\CMS\Core\Resource\ResourceCompressor::compressCssFiles ( array $cssFiles )

Compress multiple css files

Parameters

array $cssFiles ‪The files to compress (array key = filename), relative to requested page

Returns: ‪array The CSS files after compression (array key = new filename), relative to requested page

Definition at line 305 of file ResourceCompressor.php.

References TYPO3\CMS\Core\Resource\ResourceCompressor\compressCssFile().

Referenced by TYPO3\CMS\Core\Page\PageRenderer\doCompressCss().

◆ compressCssString()

string TYPO3\CMS\Core\Resource\ResourceCompressor::compressCssString ( $contents )

protected

Compress a CSS string by removing comments and whitespace characters

Parameters

string $contents

Returns: ‪string

Definition at line 612 of file ResourceCompressor.php.

Referenced by TYPO3\CMS\Core\Resource\ResourceCompressor\compressCssFile().

◆ compressJsFile()

string TYPO3\CMS\Core\Resource\ResourceCompressor::compressJsFile ( $filename )

Compresses a javascript file

Parameters

string $filename ‪Source filename, relative to requested page

Returns: ‪string Filename of the compressed file, relative to requested page

Definition at line 389 of file ResourceCompressor.php.

References TYPO3\CMS\Core\Resource\ResourceCompressor\getFilenameFromMainDir(), TYPO3\CMS\Core\Core\Environment\getPublicPath(), TYPO3\CMS\Core\Utility\PathUtility\pathinfo(), TYPO3\CMS\Core\Resource\ResourceCompressor\returnFileReference(), and TYPO3\CMS\Core\Resource\ResourceCompressor\writeFileAndCompressed().

Referenced by TYPO3\CMS\Core\Resource\ResourceCompressor\compressJsFiles(), and TYPO3\CMS\Core\Page\PageRenderer\processJsFile().

◆ compressJsFiles()

array TYPO3\CMS\Core\Resource\ResourceCompressor::compressJsFiles ( array $jsFiles )

Compress multiple javascript files

Parameters

array $jsFiles ‪The files to compress (array key = filename), relative to requested page

Returns: ‪array The js files after compression (array key = new filename), relative to requested page

Definition at line 366 of file ResourceCompressor.php.

References TYPO3\CMS\Core\Resource\ResourceCompressor\compressJsFile().

Referenced by TYPO3\CMS\Core\Page\PageRenderer\doCompressJavaScript().

◆ concatenateCssFiles()

array TYPO3\CMS\Core\Resource\ResourceCompressor::concatenateCssFiles ( array $cssFiles )

Concatenates the Stylesheet files

Parameters

array $cssFiles ‪CSS files to process

Returns: ‪array CSS files

Definition at line 106 of file ResourceCompressor.php.

References TYPO3\CMS\Core\Resource\ResourceCompressor\createMergedCssFile(), and TYPO3\CMS\Core\Resource\ResourceCompressor\getFilenameFromMainDir().

Referenced by TYPO3\CMS\Core\Page\PageRenderer\doConcatenateCss().

◆ concatenateJsFiles()

array TYPO3\CMS\Core\Resource\ResourceCompressor::concatenateJsFiles ( array $jsFiles )

Concatenates the JavaScript files

Parameters

array $jsFiles ‪JavaScript files to process

Returns: ‪array JS files

Definition at line 153 of file ResourceCompressor.php.

References TYPO3\CMS\Core\Resource\ResourceCompressor\createMergedJsFile(), TYPO3\CMS\Core\Resource\ResourceCompressor\getFilenameFromMainDir(), and TYPO3\CMS\Core\Resource\ResourceCompressor\getJavaScriptFileType().

Referenced by TYPO3\CMS\Core\Page\PageRenderer\doConcatenateJavaScript().

◆ createMergedCssFile()

mixed TYPO3\CMS\Core\Resource\ResourceCompressor::createMergedCssFile ( array $filesToInclude )

protected

Creates a merged CSS file

Parameters

array $filesToInclude ‪Files which should be merged, paths relative to root path

Returns: ‪mixed Filename of the merged file

Definition at line 207 of file ResourceCompressor.php.

References TYPO3\CMS\Core\Resource\ResourceCompressor\createMergedFile().

Referenced by TYPO3\CMS\Core\Resource\ResourceCompressor\concatenateCssFiles().

◆ createMergedFile()

mixed TYPO3\CMS\Core\Resource\ResourceCompressor::createMergedFile	(	array	$filesToInclude,
			$type = `'css'`
	)

protected

Creates a merged file with given file type

Parameters

array	$filesToInclude	‪Files which should be merged, paths relative to root path
string	$type	‪File type

Exceptions

Definition at line 232 of file ResourceCompressor.php.

References TYPO3\CMS\Core\Resource\ResourceCompressor\cssFixRelativeUrlPaths(), TYPO3\CMS\Core\Resource\ResourceCompressor\cssFixStatements(), TYPO3\CMS\Core\Core\Environment\getPublicPath(), TYPO3\CMS\Core\Utility\GeneralUtility\isValidUrl(), TYPO3\CMS\Core\Resource\ResourceCompressor\retrieveExternalFile(), TYPO3\CMS\Core\Utility\PathUtility\stripPathSitePrefix(), and TYPO3\CMS\Core\Utility\GeneralUtility\writeFile().

Referenced by TYPO3\CMS\Core\Resource\ResourceCompressor\createMergedCssFile(), and TYPO3\CMS\Core\Resource\ResourceCompressor\createMergedJsFile().

◆ createMergedJsFile()

mixed TYPO3\CMS\Core\Resource\ResourceCompressor::createMergedJsFile ( array $filesToInclude )

protected

Creates a merged JS file

Parameters

array $filesToInclude ‪Files which should be merged, paths relative to root path

Returns: ‪mixed Filename of the merged file

Definition at line 218 of file ResourceCompressor.php.

References TYPO3\CMS\Core\Resource\ResourceCompressor\createMergedFile().

Referenced by TYPO3\CMS\Core\Resource\ResourceCompressor\concatenateJsFiles().

◆ cssFixRelativeUrlPaths()

string TYPO3\CMS\Core\Resource\ResourceCompressor::cssFixRelativeUrlPaths	(	string	$contents,
		string	$filename
	)

protected

Parameters

string	$contents
string	$filename

Returns: ‪string

Definition at line 496 of file ResourceCompressor.php.

References TYPO3\CMS\Core\Utility\PathUtility\dirname(), and TYPO3\CMS\Core\Resource\ResourceCompressor\getPathFixer().

Referenced by TYPO3\CMS\Core\Resource\ResourceCompressor\compressCssFile(), and TYPO3\CMS\Core\Resource\ResourceCompressor\createMergedFile().

◆ cssFixStatements()

string TYPO3\CMS\Core\Resource\ResourceCompressor::cssFixStatements ( $contents )

protected

Definition at line 509 of file ResourceCompressor.php.

Referenced by TYPO3\CMS\Core\Resource\ResourceCompressor\createMergedFile().

◆ getFilenameFromMainDir()

string TYPO3\CMS\Core\Resource\ResourceCompressor::getFilenameFromMainDir ( $filename )

protected

Finds the relative path to a file, relative to the root path.

Parameters

string $filename ‪the name of the file

Returns: ‪string the path to the file relative to the root path ($this->rootPath)

Definition at line 415 of file ResourceCompressor.php.

References TYPO3\CMS\Core\Core\Environment\getBackendPath(), TYPO3\CMS\Core\Core\Environment\getPublicPath(), TYPO3\CMS\Core\Utility\PathUtility\getRelativePathTo(), and TYPO3\CMS\Core\Utility\PathUtility\isAbsolutePath().

Referenced by TYPO3\CMS\Core\Resource\ResourceCompressor\compressCssFile(), TYPO3\CMS\Core\Resource\ResourceCompressor\compressJsFile(), TYPO3\CMS\Core\Resource\ResourceCompressor\concatenateCssFiles(), and TYPO3\CMS\Core\Resource\ResourceCompressor\concatenateJsFiles().

◆ getJavaScriptFileType()

string TYPO3\CMS\Core\Resource\ResourceCompressor::getJavaScriptFileType ( )

protected

Determines the the JavaScript mime type

The <script> tag only needs the type if the page is not rendered as HTML5. In TYPO3 Backend or when TSFE is not available we always use HTML5. For TYPO3 Frontend the configured config.doctype is evaluated.

Returns: ‪string

Definition at line 665 of file ResourceCompressor.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Core\Resource\ResourceCompressor\concatenateJsFiles().

◆ getPathFixer()

TYPO3\CMS\Core\Resource\ResourceCompressor::getPathFixer ( )

protected

Definition at line 677 of file ResourceCompressor.php.

Referenced by TYPO3\CMS\Core\Resource\ResourceCompressor\cssFixRelativeUrlPaths().

◆ retrieveExternalFile()

string TYPO3\CMS\Core\Resource\ResourceCompressor::retrieveExternalFile ( $url )

protected

Retrieves an external file and stores it locally.

Parameters

string $url

Returns: ‪string Temporary local filename for the externally-retrieved file

Definition at line 593 of file ResourceCompressor.php.

References TYPO3\CMS\Core\Core\Environment\getPublicPath(), TYPO3\CMS\Core\Utility\GeneralUtility\getUrl(), and TYPO3\CMS\Core\Utility\GeneralUtility\writeFile().

Referenced by TYPO3\CMS\Core\Resource\ResourceCompressor\createMergedFile().

◆ returnFileReference()

string TYPO3\CMS\Core\Resource\ResourceCompressor::returnFileReference ( $filename )

protected

Decides whether a client can deal with gzipped content or not and returns the according file name, based on HTTP_ACCEPT_ENCODING

Parameters

string $filename ‪File name

Returns: ‪string $filename suffixed with '.gzip' or not - dependent on HTTP_ACCEPT_ENCODING

Definition at line 578 of file ResourceCompressor.php.

References TYPO3\CMS\Core\Core\Environment\getPublicPath(), and TYPO3\CMS\Core\Utility\PathUtility\getRelativePath().

Referenced by TYPO3\CMS\Core\Resource\ResourceCompressor\compressCssFile(), and TYPO3\CMS\Core\Resource\ResourceCompressor\compressJsFile().

◆ setRootPath()

TYPO3\CMS\Core\Resource\ResourceCompressor::setRootPath ( $rootPath )

Sets absolute path to working directory

Parameters

string $rootPath ‪Absolute path

Definition at line 93 of file ResourceCompressor.php.

References TYPO3\CMS\Core\Resource\ResourceCompressor\$rootPath.

Referenced by TYPO3\CMS\Core\Resource\ResourceCompressor\__construct(), TYPO3\CMS\Core\Tests\Unit\Resource\ResourceCompressorTest\getFilenamesFromMainDirInBackendContext(), TYPO3\CMS\Core\Tests\Unit\Resource\ResourceCompressorTest\getFilenamesFromMainDirInBackendContextWithSubFolder(), and TYPO3\CMS\Core\Tests\Unit\Resource\ResourceCompressorTest\getFilenamesFromMainDirInFrontendContext().

◆ writeFileAndCompressed()

TYPO3\CMS\Core\Resource\ResourceCompressor::writeFileAndCompressed	(	$filename,
		$contents
	)

protected

Writes $contents into file $filename together with a gzipped version into $filename.gz

Parameters

string	$filename	‪Target filename
string	$contents	‪File contents

Definition at line 561 of file ResourceCompressor.php.

References TYPO3\CMS\Core\Core\Environment\getPublicPath(), and TYPO3\CMS\Core\Utility\GeneralUtility\writeFile().

Referenced by TYPO3\CMS\Core\Resource\ResourceCompressor\compressCssFile(), and TYPO3\CMS\Core\Resource\ResourceCompressor\compressJsFile().

Member Data Documentation

◆ $createGzipped

bool TYPO3\CMS\Core\Resource\ResourceCompressor::$createGzipped = false

protected

gzipped versions are only created if $TYPO3_CONF_VARS[TYPO3_MODE]['compressionLevel'] is set

Definition at line 42 of file ResourceCompressor.php.

◆ $gzipCompressionLevel

int TYPO3\CMS\Core\Resource\ResourceCompressor::$gzipCompressionLevel = -1

protected

Definition at line 46 of file ResourceCompressor.php.

◆ $htaccessTemplate

string TYPO3\CMS\Core\Resource\ResourceCompressor::$htaccessTemplate

protected

Initial value:

= '<FilesMatch "\\.(js|css)(\\.gzip)?$">
    <IfModule mod_expires.c>
        ExpiresActive on
        ExpiresDefault "access plus 7 days"
    </IfModule>
    FileETag MTime Size
</FilesMatch>'

Definition at line 50 of file ResourceCompressor.php.

Referenced by TYPO3\CMS\Core\Tests\Unit\Resource\ResourceCompressorTest\Fixtures\TestableResourceCompressor\getHtaccessTemplate().

◆ $rootPath

string TYPO3\CMS\Core\Resource\ResourceCompressor::$rootPath = ''

protected

Definition at line 36 of file ResourceCompressor.php.

Referenced by TYPO3\CMS\Core\Resource\ResourceCompressor\setRootPath().

◆ $targetDirectory

string TYPO3\CMS\Core\Resource\ResourceCompressor::$targetDirectory = 'typo3temp/assets/compressed/'

protected

Definition at line 32 of file ResourceCompressor.php.

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkBaseDirectory()

◆ compressCssFile()

◆ compressCssFiles()

◆ compressCssString()

◆ compressJsFile()

◆ compressJsFiles()

◆ concatenateCssFiles()

◆ concatenateJsFiles()

◆ createMergedCssFile()

◆ createMergedFile()

◆ createMergedJsFile()

◆ cssFixRelativeUrlPaths()

◆ cssFixStatements()

◆ getFilenameFromMainDir()

◆ getJavaScriptFileType()

◆ getPathFixer()

◆ retrieveExternalFile()

◆ returnFileReference()

◆ setRootPath()

◆ writeFileAndCompressed()

Member Data Documentation

◆ $createGzipped

◆ $gzipCompressionLevel

◆ $htaccessTemplate

◆ $rootPath

◆ $targetDirectory