Class FOFLess

This class is taken near verbatim (changes marked with FOF comment markers) from:

LESS css compiler, adapted from http://lesscss.org

THIS IS THIRD PARTY CODE. Code comments are mostly useless placeholders to stop phpcs from complaining...

Package: FrameworkOnFramework\less
Copyright: Copyright (C) 2010-2016 Nicholas K. Dionysopoulos / Akeeba Ltd. All rights reserved.
License: General Public License version 2 or later; see LICENSE.txt
Since: 2.0
Located at fof/less/less.php

Methods summary

`protected string\|null`	# `findImport( string $url )` Attempts to find the path of an import url, returns null for css files Attempts to find the path of an import url, returns null for css files Parameters `$url` `string` - $url The URL of the import Returns `string\|null`
`protected boolean`	# `fileExists( string $name )` Does file $name exists? It's a simple proxy to JFile for now Does file $name exists? It's a simple proxy to JFile for now Parameters `$name` `string` - $name The file we check for existence Returns `boolean`
`public static array`	# `compressList( array $items, string $delim )` Compresslist Compresslist Parameters `$items` `array` - $items Items `$delim` `string` - $delim Delimiter Returns `array`
`public static string`	# `preg_quote( string $what )` Quote for regular expression Quote for regular expression Parameters `$what` `string` - $what What to quote Returns `string` - Quoted string
`protected boolean`	# `tryImport( string $importPath, stdObject $parentBlock, string $out )` Try import Try import Parameters `$importPath` `string` - $importPath Import path `$parentBlock` `stdObject` - $parentBlock Parent block `$out` `string` - $out Out Returns `boolean`
`protected`	# `compileImportedProps( array $props, stdClass $block, string $out, FOFLessParser $sourceParser, string $importDir )` Compile Imported Props Compile Imported Props Parameters `$props` `array` - $props Props `$block` `stdClass` - $block Block `$out` `string` - $out Out `$sourceParser` `FOFLessParser` - $sourceParser Source parser `$importDir` `string` - $importDir Import dir
`protected`	# `compileBlock( stdClass $block )` Recursively compiles a block. Recursively compiles a block. A block is analogous to a CSS block in most cases. A single LESS document is encapsulated in a block when parsed, but it does not have parent tags so all of it's children appear on the root level when compiled. Blocks are made up of props and children. Props are property instructions, array tuples which describe an action to be taken, eg. write a property, set a variable, mixin a block. The children of a block are just all the blocks that are defined within. This is used to look up mixins when performing a mixin. Compiling the block involves pushing a fresh environment on the stack, and iterating through the props, compiling each one. Parameters `$block` `stdClass` - $block Block See `FOFLess::compileProp()`
`protected`	# `compileCSSBlock( stdClass $block )` Compile CSS block Compile CSS block Parameters `$block` `stdClass` - $block Block to compile
`protected`	# `compileMedia( stdClass $media )` Compile media Compile media Parameters `$media` `stdClass` - $media Media
`protected stdClass`	# `mediaParent( stdClass $scope )` Media parent Media parent Parameters `$scope` `stdClass` - $scope Scope Returns `stdClass`
`protected`	# `compileNestedBlock( stdClass $block, array $selectors )` Compile nested block Compile nested block Parameters `$block` `stdClass` - $block Block `$selectors` `array` - $selectors Selectors
`protected`	# `compileRoot( stdClass $root )` Compile root Compile root Parameters `$root` `stdClass` - $root Root
`protected`	# `compileProps( type $block, type $out )` Compile props Compile props Parameters `$block` `type` - $block Something `$out` `type` - $out Something
`protected type`	# `sortProps( type $props, type $split = false )` Sort props Sort props Parameters `$props` `type` - $props X `$split` `type` - $split X Returns `type`
`protected string`	# `compileMediaQuery( type $queries )` Compile media query Compile media query Parameters `$queries` `type` - $queries Queries Returns `string`
`protected type`	# `multiplyMedia( type $env, type $childQueries = null )` Multiply media Multiply media Parameters `$env` `type` - $env X `$childQueries` `type` - $childQueries X Returns `type`
`protected type`	# `expandParentSelectors( type & $tag, type $replace )` Expand parent selectors Expand parent selectors Parameters `$tag` `type` - &$tag Tag `$replace` `type` - $replace Replace Returns `type`
`protected array`	# `findClosestSelectors( )` Find closest selectors Find closest selectors Returns `array`
`protected array`	# `multiplySelectors( array $selectors )` Multiply $selectors against the nearest selectors in env Multiply $selectors against the nearest selectors in env Parameters `$selectors` `array` - $selectors The selectors Returns `array`
`protected array`	# `compileSelectors( array $selectors )` Reduces selector expressions Reduces selector expressions Parameters `$selectors` `array` - $selectors The selector expressions Returns `array`
`protected boolean`	# `eq( mixed $left, mixed $right )` Equality check Equality check Parameters `$left` `mixed` - $left Left operand `$right` `mixed` - $right Right operand Returns `boolean` - True if equal
`protected boolean`	# `patternMatch( type $block, type $callingArgs )` Pattern match Pattern match Parameters `$block` `type` - $block X `$callingArgs` `type` - $callingArgs X Returns `boolean`
`protected type`	# `patternMatchAll( type $blocks, type $callingArgs )` Pattern match all Pattern match all Parameters `$blocks` `type` - $blocks X `$callingArgs` `type` - $callingArgs X Returns `type`
`protected null`	# `findBlocks( array $searchIn, string $path, array $args, array $seen = array() )` Attempt to find blocks matched by path and args Attempt to find blocks matched by path and args Parameters `$searchIn` `array` - $searchIn Block to search in `$path` `string` - $path The path to search for `$args` `array` - $args Arguments `$seen` `array` - $seen Your guess is as good as mine; that's third party code Returns `null`
`protected`	# `zipSetArgs( array $args, array $values )` Sets all argument names in $args to either the default value or the one passed in through $values Sets all argument names in $args to either the default value or the one passed in through $values Parameters `$args` `array` - $args Arguments `$values` `array` - $values Values
`protected`	# `compileProp( array $prop, stdClass $block, string $out )` Compile a prop and update $lines or $blocks appropriately Compile a prop and update $lines or $blocks appropriately Parameters `$prop` `array` - $prop Prop `$block` `stdClass` - $block Block `$out` `string` - $out Out
`protected`	# `compileValue( array $value )` Compiles a primitive value into a CSS property value. Compiles a primitive value into a CSS property value. Values in lessphp are typed by being wrapped in arrays, their format is typically: array(type, contents [, additional_contents]*) The input is expected to be reduced. This function will not work on things like expressions and variables. Parameters `$value` `array` - $value Value
`protected boolean`	# `lib_isnumber( type $value )` Lib is number Lib is number Parameters `$value` `type` - $value X Returns `boolean`
`protected boolean`	# `lib_isstring( type $value )` Lib is string Lib is string Parameters `$value` `type` - $value X Returns `boolean`
`protected boolean`	# `lib_iscolor( type $value )` Lib is color Lib is color Parameters `$value` `type` - $value X Returns `boolean`
`protected boolean`	# `lib_iskeyword( type $value )` Lib is keyword Lib is keyword Parameters `$value` `type` - $value X Returns `boolean`
`protected boolean`	# `lib_ispixel( type $value )` Lib is pixel Lib is pixel Parameters `$value` `type` - $value X Returns `boolean`
`protected boolean`	# `lib_ispercentage( type $value )` Lib is percentage Lib is percentage Parameters `$value` `type` - $value X Returns `boolean`
`protected boolean`	# `lib_isem( type $value )` Lib is em Lib is em Parameters `$value` `type` - $value X Returns `boolean`
`protected boolean`	# `lib_isrem( type $value )` Lib is rem Lib is rem Parameters `$value` `type` - $value X Returns `boolean`
`protected boolean`	# `lib_rgbahex( type $color )` LIb rgba hex LIb rgba hex Parameters `$color` `type` - $color X Returns `boolean`
`protected type`	# `lib_argb( type $color )` Lib argb Lib argb Parameters `$color` `type` - $color X Returns `type`
`protected string`	# `lib_e( string $arg )` Utility func to unquote a string Utility func to unquote a string Parameters `$arg` `string` - $arg Arg Returns `string`
`protected type`	# `lib__sprintf( type $args )` Lib sprintf Lib sprintf Parameters `$args` `type` - $args X Returns `type`
`protected array`	# `lib_floor( type $arg )` Lib floor Lib floor Parameters `$arg` `type` - $arg X Returns `array`
`protected array`	# `lib_ceil( type $arg )` Lib ceil Lib ceil Parameters `$arg` `type` - $arg X Returns `array`
`protected array`	# `lib_round( type $arg )` Lib round Lib round Parameters `$arg` `type` - $arg X Returns `array`
`protected array`	# `lib_unit( type $arg )` Lib unit Lib unit Parameters `$arg` `type` - $arg X Returns `array`
`protected array`	# `colorArgs( array $args )` Helper function to get arguments for color manipulation functions. takes a list that contains a color like thing and a percentage Helper function to get arguments for color manipulation functions. takes a list that contains a color like thing and a percentage Parameters `$args` `array` - $args Args Returns `array`
`protected type`	# `lib_darken( type $args )` Lib darken Lib darken Parameters `$args` `type` - $args X Returns `type`
`protected type`	# `lib_lighten( type $args )` Lib lighten Lib lighten Parameters `$args` `type` - $args X Returns `type`
`protected type`	# `lib_saturate( type $args )` Lib saturate Lib saturate Parameters `$args` `type` - $args X Returns `type`
`protected type`	# `lib_desaturate( type $args )` Lib desaturate Lib desaturate Parameters `$args` `type` - $args X Returns `type`
`protected type`	# `lib_spin( type $args )` Lib spin Lib spin Parameters `$args` `type` - $args X Returns `type`
`protected type`	# `lib_fadeout( type $args )` Lib fadeout Lib fadeout Parameters `$args` `type` - $args X Returns `type`
`protected type`	# `lib_fadein( type $args )` Lib fadein Lib fadein Parameters `$args` `type` - $args X Returns `type`
`protected type`	# `lib_hue( type $color )` Lib hue Lib hue Parameters `$color` `type` - $color X Returns `type`
`protected type`	# `lib_saturation( type $color )` Lib saturation Lib saturation Parameters `$color` `type` - $color X Returns `type`
`protected type`	# `lib_lightness( type $color )` Lib lightness Lib lightness Parameters `$color` `type` - $color X Returns `type`
`protected string`	# `lib_alpha( string $value )` Get the alpha of a color Defaults to 1 for non-colors or colors without an alpha Get the alpha of a color Defaults to 1 for non-colors or colors without an alpha Parameters `$value` `string` - $value Value Returns `string`
`protected string`	# `lib_fade( array $args )` Set the alpha of the color Set the alpha of the color Parameters `$args` `array` - $args Args Returns `string`
`protected string`	# `lib_percentage( array $arg )` Third party code; your guess is as good as mine Third party code; your guess is as good as mine Parameters `$arg` `array` - $arg Arg Returns `string`
`protected string`	# `lib_mix( array $args )` mixes two colors by weight mix(@color1, @color2, @weight); http://sass-lang.com/docs/yardoc/Sass/Script/Functions.html#mix-instance_method mixes two colors by weight mix(@color1, @color2, @weight); http://sass-lang.com/docs/yardoc/Sass/Script/Functions.html#mix-instance_method Parameters `$args` `array` - $args Args Returns `string`
`protected string`	# `lib_contrast( array $args )` Third party code; your guess is as good as mine Third party code; your guess is as good as mine Parameters `$args` `array` - $arg Arg Returns `string`
`protected type`	# `assertColor( type $value, type $error = "expected color value" )` Assert color Assert color Parameters `$value` `type` - $value X `$error` `type` - $error X Returns `type`
`protected type`	# `assertNumber( type $value, type $error = "expecting number" )` Assert number Assert number Parameters `$value` `type` - $value X `$error` `type` - $error X Returns `type`
`protected type`	# `toHSL( type $color )` To HSL To HSL Parameters `$color` `type` - $color X Returns `type`
`protected type`	# `toRGB_helper( type $comp, type $temp1, type $temp2 )` To RGB helper To RGB helper Parameters `$comp` `type` - $comp X `$temp1` `type` - $temp1 X `$temp2` `type` - $temp2 X Returns `type`
`protected type`	# `toRGB( type $color )` Converts a hsl array into a color value in rgb. Expects H to be in range of 0 to 360, S and L in 0 to 100 Converts a hsl array into a color value in rgb. Expects H to be in range of 0 to 360, S and L in 0 to 100 Parameters `$color` `type` - $color X Returns `type`
`protected type`	# `clamp( type $v, type $max = 1, type $min = 0 )` Clamp Clamp Parameters `$v` `type` - $v X `$max` `type` - $max X `$min` `type` - $min X Returns `type`
`protected type`	# `funcToColor( type $func )` Convert the rgb, rgba, hsl color literals of function type as returned by the parser into values of color type. Convert the rgb, rgba, hsl color literals of function type as returned by the parser into values of color type. Parameters `$func` `type` - $func X Returns `type`
`protected type`	# `reduce( type $value, type $forExpression = false )` Reduce Reduce Parameters `$value` `type` - $value X `$forExpression` `type` - $forExpression X Returns `type`
`protected null`	# `coerceColor( type $value )` Coerce a value for use in color operation Coerce a value for use in color operation Parameters `$value` `type` - $value X Returns `null`
`protected null`	# `coerceString( type $value )` Make something string like into a string Make something string like into a string Parameters `$value` `type` - $value X Returns `null`
`protected type`	# `flattenList( type $value )` Turn list of length 1 into value type Turn list of length 1 into value type Parameters `$value` `type` - $value X Returns `type`
`protected type`	# `toBool( type $a )` To bool To bool Parameters `$a` `type` - $a X Returns `type`
`protected type`	# `evaluate( type $exp )` Evaluate an expression Evaluate an expression Parameters `$exp` `type` - $exp X Returns `type`
`protected string`	# `stringConcatenate( type $left, string $right )` String concatenate String concatenate Parameters `$left` `type` - $left X `$right` `string` - $right X Returns `string`
`protected integer`	# `fixColor( type $c )` Make sure a color's components don't go out of bounds Make sure a color's components don't go out of bounds Parameters `$c` `type` - $c X Returns `integer`
`protected type`	# `op_number_color( type $op, type $lft, type $rgt )` Op number color Op number color Parameters `$op` `type` - $op X `$lft` `type` - $lft X `$rgt` `type` - $rgt X Returns `type`
`protected type`	# `op_color_number( type $op, type $lft, integer $rgt )` Op color number Op color number Parameters `$op` `type` - $op X `$lft` `type` - $lft X `$rgt` `integer` - $rgt X Returns `type`
`protected type`	# `op_color_color( type $op, type $left, type $right )` Op color color Op color color Parameters `$op` `type` - $op X `$left` `type` - $left X `$right` `type` - $right X Returns `type`
`public type`	# `lib_red( type $color )` Lib red Lib red Parameters `$color` `type` - $color X Returns `type`
`public type`	# `lib_green( type $color )` Lib green Lib green Parameters `$color` `type` - $color X Returns `type`
`public type`	# `lib_blue( type $color )` Lib blue Lib blue Parameters `$color` `type` - $color X Returns `type`
`protected type`	# `op_number_number( type $op, type $left, type $right )` Operator on two numbers Operator on two numbers Parameters `$op` `type` - $op X `$left` `type` - $left X `$right` `type` - $right X Returns `type`
`protected stdclass`	# `makeOutputBlock( type $type, type $selectors = null )` Make output block Make output block Parameters `$type` `type` - $type X `$selectors` `type` - $selectors X Returns `stdclass`
`protected stdclass`	# `pushEnv( type $block = null )` The state of execution The state of execution Parameters `$block` `type` - $block X Returns `stdclass`
`protected type`	# `popEnv( )` Pop something off the stack Pop something off the stack Returns `type`
`protected`	# `set( type $name, type $value )` Set something in the current env Set something in the current env Parameters `$name` `type` - $name X `$value` `type` - $value X
`protected type`	# `get( type $name, type $default = null )` Get the highest occurrence entry for a name Get the highest occurrence entry for a name Parameters `$name` `type` - $name X `$default` `type` - $default X Returns `type`
`protected`	# `injectVariables( type $args )` Inject array of unparsed strings into environment as variables Inject array of unparsed strings into environment as variables Parameters `$args` `type` - $args X Throws `Exception`
`public`	# `__construct( type $fname = null )` Initialize any static state, can initialize parser for a file Initialize any static state, can initialize parser for a file Parameters `$fname` `type` - $fname X
`public type`	# `compile( type $string, type $name = null )` Compile Compile Parameters `$string` `type` - $string X `$name` `type` - $name X Returns `type`
`public type`	# `compileFile( type $fname, type $outFname = null )` Compile file Compile file Parameters `$fname` `type` - $fname X `$outFname` `type` - $outFname X Returns `type` Throws `Exception`
`public boolean`	# `checkedCompile( type $in, type $out )` Compile only if changed input has changed or output doesn't exist Compile only if changed input has changed or output doesn't exist Parameters `$in` `type` - $in X `$out` `type` - $out X Returns `boolean`
`public array`	# `cachedCompile( mixed $in, boolean $force = false )` Execute lessphp on a .less file or a lessphp cache structure Execute lessphp on a .less file or a lessphp cache structure The lessphp cache structure contains information about a specific less file having been parsed. It can be used as a hint for future calls to determine whether or not a rebuild is required. The cache structure contains two important keys that may be used externally: compiled: The final compiled CSS updated: The time (in seconds) the CSS was last compiled The cache structure is a plain-ol' PHP associative array and can be serialized and unserialized without a hitch. Parameters `$in` `mixed` - $in Input `$force` `boolean` - $force Force rebuild? Returns `array` - lessphp cache structure
`public type`	# `parse( null $str = null, type $initialVariables = null )` Parse and compile buffer Parse and compile buffer Deprecated 2.0 Parameters `$str` `null` - $str X `$initialVariables` `type` - $initialVariables X Returns `type` Throws `Exception`
`protected FOFLessParser`	# `makeParser( type $name )` Make parser Make parser Parameters `$name` `type` - $name X Returns `FOFLessParser`
`public`	# `setFormatter( type $name )` Set Formatter Set Formatter Parameters `$name` `type` - $name X
`protected FOFLessFormatterLessjs`	# `newFormatter( )` New formatter New formatter Returns `FOFLessFormatterLessjs`
`public`	# `setPreserveComments( type $preserve )` Set preserve comments Set preserve comments Parameters `$preserve` `type` - $preserve X
`public`	# `registerFunction( type $name, type $func )` Register function Register function Parameters `$name` `type` - $name X `$func` `type` - $func X
`public`	# `unregisterFunction( type $name )` Unregister function Unregister function Parameters `$name` `type` - $name X
`public`	# `setVariables( type $variables )` Set variables Set variables Parameters `$variables` `type` - $variables X
`public`	# `unsetVariable( type $name )` Unset variable Unset variable Parameters `$name` `type` - $name X
`public`	# `setImportDir( type $dirs )` Set import dir Set import dir Parameters `$dirs` `type` - $dirs X
`public`	# `addImportDir( type $dir )` Add import dir Add import dir Parameters `$dir` `type` - $dir X
`public type`	# `allParsedFiles( )` All parsed files All parsed files Returns `type`
`protected`	# `addParsedFile( type $file )` Add parsed file Add parsed file Parameters `$file` `type` - $file X
`protected`	# `throwError( type $msg = null )` Uses the current value of $this->count to show line and line number Uses the current value of $this->count to show line and line number Parameters `$msg` `type` - $msg X
`public static type`	# `ccompile( type $in, type $out, FOFLess $less = null )` Compile file $in to file $out if $in is newer than $out Returns true when it compiles, false otherwise Compile file $in to file $out if $in is newer than $out Returns true when it compiles, false otherwise Parameters `$in` `type` - $in X `$out` `type` - $out X `$less` `FOFLess` - $less X Returns `type`
`public static type`	# `cexecute( type $in, type $force = false, FOFLess $less = null )` Compile execute Compile execute Parameters `$in` `type` - $in X `$force` `type` - $force X `$less` `FOFLess` - $less X Returns `type`

Magic methods summary

Properties summary

`public static string`	`$VERSION`	#
`protected static array`	`$TRUE`	#
`protected static array`	`$FALSE`	#
`protected array`	`$libFunctions`	#
`protected array`	`$registeredVars`	#
`protected boolean`	`$preserveComments`	#
`public string`	`$vPrefix`	# Prefix of abstract properties Prefix of abstract properties
`public string`	`$mPrefix`	# Prefix of abstract blocks Prefix of abstract blocks
`public string`	`$parentSelector`	#
`public boolean`	`$importDisabled`	#
`public string`	`$importDir`	#
`protected mixed`	`$numberPrecision`	#
`protected FOFLessParser`	`$sourceParser`	# Set to the parser that generated the current line when compiling so we know how to create error messages Set to the parser that generated the current line when compiling so we know how to create error messages
`protected mixed`	`$sourceLoc`	#
`public static array`	`$defaultValue`	#
`protected static integer`	`$nextImportId`	# Uniquely identify imports Uniquely identify imports
`protected static array`	`$cssColors`	#

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class FOFLess

Methods summary

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

See

Parameters

Parameters

Parameters

Returns

Parameters

Parameters

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns