MediaWiki  master
CSSMin Class Reference

Transforms CSS data. More...

Static Public Member Functions

static buildUrlValue ( $url)
 Build a CSS 'url()' value for the given URL, quoting parentheses (and other funny characters) and escaping quotes as necessary. More...
 
static encodeImageAsDataURI ( $file, $type=null, $ie8Compat=true)
 Encode an image file as a data URI. More...
 
static encodeStringAsDataURI ( $contents, $type, $ie8Compat=true)
 Encode file contents as a data URI with chosen MIME type. More...
 
static getLocalFileReferences ( $source, $path)
 Get a list of local files referenced in a stylesheet (includes non-existent files). More...
 
static getMimeType ( $file)
 
static minify ( $css)
 Removes whitespace from CSS data. More...
 
static remap ( $source, $local, $remote, $embedData=true)
 Remaps CSS URL paths and automatically embeds data URIs for CSS rules or url() values preceded by an / * @embed * / comment. More...
 
static remapOne ( $file, $query, $local, $remote, $embed)
 Remap or embed a CSS URL path. More...
 
static serializeStringValue ( $value)
 Serialize a string (escape and quote) for use as a CSS string value. More...
 

Static Protected Member Functions

static isLocalUrl ( $maybeUrl)
 Is this CSS rule referencing a local URL? More...
 
static isRemoteUrl ( $maybeUrl)
 Is this CSS rule referencing a remote URL? More...
 

Static Protected Attributes

static string[] $mimeTypes
 List of common image files extensions and MIME-types. More...
 

Static Private Member Functions

static getUrlRegex ()
 

Private Attributes

const COMMENT_REGEX = '\/\*.*?\*\/'
 
const DATA_URI_SIZE_LIMIT = 32768
 Internet Explorer data URI length limit. More...
 
const EMBED_REGEX = '\/\*\s*\@embed\s*\*\/'
 

Detailed Description

Transforms CSS data.

This class provides minification, URL remapping, URL extracting, and data-URL embedding.

Definition at line 30 of file CSSMin.php.

Member Function Documentation

◆ buildUrlValue()

static CSSMin::buildUrlValue (   $url)
static

Build a CSS 'url()' value for the given URL, quoting parentheses (and other funny characters) and escaping quotes as necessary.

See http://www.w3.org/TR/css-syntax-3/#consume-a-url-token

Parameters
string$urlURL to process
Returns
string 'url()' value, usually just "url($url)", quoted/escaped if necessary

Definition at line 216 of file CSSMin.php.

Referenced by ResourceLoaderImageModule\getCssDeclarations(), ResourceLoaderSkinModule\getLessVars(), ResourceLoaderSkinModule\getStyles(), CssContentHandler\makeRedirectContent(), and remap().

◆ encodeImageAsDataURI()

static CSSMin::encodeImageAsDataURI (   $file,
  $type = null,
  $ie8Compat = true 
)
static

Encode an image file as a data URI.

If the image file has a suitable MIME type and size, encode it as a data URI, base64-encoded for binary files or just percent-encoded otherwise. Return false if the image type is unfamiliar or file exceeds the size limit.

Parameters
string$fileImage file to encode.
string | null$typeFile's MIME type or null. If null, CSSMin will try to autodetect the type.
bool$ie8CompatBy default, a data URI will only be produced if it can be made short enough to fit in Internet Explorer 8 (and earlier) URI length limit (32,768 bytes). Pass false to remove this limitation.
Returns
string|false Image contents encoded as a data URI or false.

Definition at line 113 of file CSSMin.php.

References $file, $type, encodeStringAsDataURI(), and getMimeType().

Referenced by remapOne().

◆ encodeStringAsDataURI()

static CSSMin::encodeStringAsDataURI (   $contents,
  $type,
  $ie8Compat = true 
)
static

Encode file contents as a data URI with chosen MIME type.

The URI will be base64-encoded for binary files or just percent-encoded otherwise.

Since
1.25
Parameters
string$contentsFile contents to encode.
string$typeFile's MIME type.
bool$ie8CompatSee encodeImageAsDataURI().
Returns
string|false Image contents encoded as a data URI or false.

Definition at line 141 of file CSSMin.php.

References $type.

Referenced by encodeImageAsDataURI(), and ResourceLoaderImage\getDataUri().

◆ getLocalFileReferences()

static CSSMin::getLocalFileReferences (   $source,
  $path 
)
static

Get a list of local files referenced in a stylesheet (includes non-existent files).

Parameters
string$sourceCSS stylesheet source to process
string$pathFile path where the source was read from
Returns
string[] List of local file references

Definition at line 63 of file CSSMin.php.

References $matches, $path, and $source.

Referenced by ResourceLoaderFileModule\processStyle().

◆ getMimeType()

static CSSMin::getMimeType (   $file)
static
Parameters
string$file
Returns
bool|string

Definition at line 201 of file CSSMin.php.

References $ext, and $file.

Referenced by encodeImageAsDataURI(), and remap().

◆ getUrlRegex()

static CSSMin::getUrlRegex ( )
staticprivate
Returns
string

Definition at line 392 of file CSSMin.php.

Referenced by remap().

◆ isLocalUrl()

static CSSMin::isLocalUrl (   $maybeUrl)
staticprotected

Is this CSS rule referencing a local URL?

Parameters
string$maybeUrl
Returns
bool

Definition at line 384 of file CSSMin.php.

◆ isRemoteUrl()

static CSSMin::isRemoteUrl (   $maybeUrl)
staticprotected

Is this CSS rule referencing a remote URL?

Parameters
string$maybeUrl
Returns
bool

Definition at line 371 of file CSSMin.php.

◆ minify()

static CSSMin::minify (   $css)
static

Removes whitespace from CSS data.

Parameters
string$cssCSS data to minify
Returns
string Minified CSS data

Definition at line 476 of file CSSMin.php.

Referenced by ResourceLoader\applyFilter(), BenchmarkCSSMin\execute(), and MinifyScript\minify().

◆ remap()

static CSSMin::remap (   $source,
  $local,
  $remote,
  $embedData = true 
)
static

Remaps CSS URL paths and automatically embeds data URIs for CSS rules or url() values preceded by an / * @embed * / comment.

Parameters
string$sourceCSS data to remap
string$localFile path where the source was read from
string$remoteURL path to the file
bool$embedDataIf false, never do any data URI embedding, even if / * @embed * / is found.
Returns
string Remapped CSS data

Definition at line 238 of file CSSMin.php.

References $file, $mimeTypes, $source, buildUrlValue(), getMimeType(), getUrlRegex(), remapOne(), and true.

Referenced by BenchmarkCSSMin\execute(), and ResourceLoaderFileModule\processStyle().

◆ remapOne()

static CSSMin::remapOne (   $file,
  $query,
  $local,
  $remote,
  $embed 
)
static

Remap or embed a CSS URL path.

Parameters
string$fileURL to remap/embed
string$query
string$localFile path where the source was read from
string$remoteURL path to the file
bool$embedWhether to do any data URI embedding
Returns
string Remapped/embedded URL data

Definition at line 417 of file CSSMin.php.

References $file, encodeImageAsDataURI(), PROTO_RELATIVE, OutputPage\transformFilePath(), wfExpandUrl(), and wfRemoveDotSegments().

Referenced by remap().

◆ serializeStringValue()

static CSSMin::serializeStringValue (   $value)
static

Serialize a string (escape and quote) for use as a CSS string value.

https://drafts.csswg.org/cssom/#serialize-a-string

Parameters
string$value
Returns
string

Definition at line 189 of file CSSMin.php.

Referenced by ResourceLoaderLessVarFileModule\wrapAndEscapeMessage().

Member Data Documentation

◆ $mimeTypes

string [] CSSMin::$mimeTypes
staticprotected
Initial value:
= [
'gif' => 'image/gif',
'jpe' => 'image/jpeg',
'jpeg' => 'image/jpeg',
'jpg' => 'image/jpeg',
'png' => 'image/png',
'tif' => 'image/tiff',
'tiff' => 'image/tiff',
'xbm' => 'image/x-xbitmap',
'svg' => 'image/svg+xml',
]

List of common image files extensions and MIME-types.

Definition at line 44 of file CSSMin.php.

Referenced by remap().

◆ COMMENT_REGEX

const CSSMin::COMMENT_REGEX = '\/\*.*?\*\/'
private

Definition at line 41 of file CSSMin.php.

◆ DATA_URI_SIZE_LIMIT

const CSSMin::DATA_URI_SIZE_LIMIT = 32768
private

Internet Explorer data URI length limit.

See encodeImageAsDataURI().

Definition at line 38 of file CSSMin.php.

◆ EMBED_REGEX

const CSSMin::EMBED_REGEX = '\/\*\s*\@embed\s*\*\/'
private

Definition at line 40 of file CSSMin.php.


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