MediaWiki REL1_31
Static Public Member Functions | Public Attributes | Static Protected Member Functions | Static Protected Attributes | Static Private Member Functions | List of all members
CSSMin Class Reference

Transforms CSS data. More...

Collaboration diagram for CSSMin:
Collaboration graph
[legend]

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.
 
static encodeImageAsDataURI ( $file, $type=null, $ie8Compat=true)
 Encode an image file as a data URI.
 
static encodeStringAsDataURI ( $contents, $type, $ie8Compat=true)
 Encode file contents as a data URI with chosen MIME type.
 
static getLocalFileReferences ( $source, $path)
 Get a list of local files referenced in a stylesheet (includes non-existent files).
 
static getMimeType ( $file)
 
static minify ( $css)
 Removes whitespace from CSS data.
 
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.
 
static remapOne ( $file, $query, $local, $remote, $embed)
 Remap or embed a CSS URL path.
 
static serializeStringValue ( $value)
 Serialize a string (escape and quote) for use as a CSS string value.
 

Public Attributes

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

Static Protected Member Functions

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

Static Protected Attributes

static array $mimeTypes
 List of common image files extensions and MIME-types.
 

Static Private Member Functions

static getUrlRegex ()
 
static processUrlMatch (array &$match, $flags=0)
 

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 221 of file CSSMin.php.

Referenced by 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|bool Image contents encoded as a data URI or false.

Definition at line 114 of file CSSMin.php.

References $type.

◆ 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|bool Image contents encoded as a data URI or false.

Definition at line 142 of file CSSMin.php.

References $type.

◆ 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
array List of local file references

Definition at line 63 of file CSSMin.php.

References $matches, and $source.

◆ getMimeType()

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

Definition at line 202 of file CSSMin.php.

References $ext.

Referenced by remap().

◆ getUrlRegex()

static CSSMin::getUrlRegex ( )
staticprivate

Definition at line 408 of file CSSMin.php.

◆ isLocalUrl()

static CSSMin::isLocalUrl ( $maybeUrl)
staticprotected

Is this CSS rule referencing a local URL?

Parameters
string$maybeUrl
Returns
bool

Definition at line 398 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 385 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 547 of file CSSMin.php.

References $css.

◆ processUrlMatch()

static CSSMin::processUrlMatch ( array & $match,
$flags = 0 )
staticprivate

Definition at line 443 of file CSSMin.php.

◆ 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 243 of file CSSMin.php.

References $source, buildUrlValue(), EMBED_REGEX, getMimeType(), remapOne(), and true.

◆ 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 488 of file CSSMin.php.

References $query, PROTO_RELATIVE, 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://www.w3.org/TR/2016/WD-cssom-1-20160317/#serialize-a-string

Parameters
string$value
Returns
string

Definition at line 190 of file CSSMin.php.

References $value.

Member Data Documentation

◆ $mimeTypes

array 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.

◆ COMMENT_REGEX

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

Definition at line 41 of file CSSMin.php.

◆ DATA_URI_SIZE_LIMIT

const CSSMin::DATA_URI_SIZE_LIMIT = 32768

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*\*\/'

Definition at line 40 of file CSSMin.php.

Referenced by remap().

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