4830 lines
336 KiB
HTML
4830 lines
336 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0"/>
|
|
<meta charset="utf-8"/>
|
|
<title> SYSTEM - PHP Framework » \ScssPhp\ScssPhp\Value\SassNumber
|
|
</title>
|
|
<meta name="author" content=""/>
|
|
<meta name="description" content=""/>
|
|
<base href="../">
|
|
|
|
<link href="css/template.css" rel="stylesheet" media="all"/>
|
|
|
|
<!--[if lt IE 9]>
|
|
<script src="https://html5shim.googlecode.com/svn/trunk/html5.js" type="text/javascript"></script>
|
|
<![endif]-->
|
|
<script src="js/jquery-1.7.1.min.js" type="text/javascript"></script>
|
|
<script src="js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script>
|
|
<script src="js/jquery.mousewheel.min.js" type="text/javascript"></script>
|
|
<script src="js/bootstrap.js" type="text/javascript"></script>
|
|
<script src="js/template.js" type="text/javascript"></script>
|
|
<script src="js/prettify/prettify.min.js" type="text/javascript"></script>
|
|
|
|
<link rel="shortcut icon" href="img/favicon.ico"/>
|
|
<link rel="apple-touch-icon" href="img/apple-touch-icon.png"/>
|
|
<link rel="apple-touch-icon" sizes="72x72" href="img/apple-touch-icon-72x72.png"/>
|
|
<link rel="apple-touch-icon" sizes="114x114" href="img/apple-touch-icon-114x114.png"/>
|
|
</head>
|
|
<body>
|
|
|
|
<div class="navbar navbar-fixed-top">
|
|
<div class="navbar-inner">
|
|
<div class="container">
|
|
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
|
|
<span class="icon-bar"></span> <span class="icon-bar"></span>
|
|
<span class="icon-bar"></span> </a>
|
|
<a class="brand" href="index.html">SYSTEM - PHP Framework</a>
|
|
|
|
<div class="nav-collapse">
|
|
<ul class="nav">
|
|
<li class="dropdown">
|
|
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
|
|
API Documentation <b class="caret"></b>
|
|
</a>
|
|
<ul class="dropdown-menu">
|
|
<li><a>Namespaces</a></li>
|
|
<li><a href="\LIB">LIB</a></li>
|
|
<li><a href="\GIT">GIT</a></li>
|
|
<li><a href="\vakata">vakata</a></li>
|
|
<li><a href="\Michelf">Michelf</a></li>
|
|
<li><a href="\MatthiasMullie">MatthiasMullie</a></li>
|
|
<li><a href="\PHPDocMD">PHPDocMD</a></li>
|
|
<li><a href="\ScssPhp">ScssPhp</a></li>
|
|
<li><a href="\SYSTEM">SYSTEM</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="dropdown" id="charts-menu">
|
|
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
|
|
Charts <b class="caret"></b>
|
|
</a>
|
|
<ul class="dropdown-menu">
|
|
<li>
|
|
<a href="graph_class.html">
|
|
<i class="icon-list-alt"></i> Class hierarchy diagram
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="dropdown" id="reports-menu">
|
|
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
|
|
Reports <b class="caret"></b>
|
|
</a>
|
|
<ul class="dropdown-menu">
|
|
<li>
|
|
<a href="errors.html">
|
|
<i class="icon-list-alt"></i> Errors
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="markers.html">
|
|
<i class="icon-list-alt"></i> Markers
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="deprecated.html">
|
|
<i class="icon-list-alt"></i> Deprecated
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="go_to_top">
|
|
<a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="___" class="container">
|
|
<noscript>
|
|
<div class="alert alert-warning">
|
|
Javascript is disabled; several features are only available if Javascript is enabled.
|
|
</div>
|
|
</noscript>
|
|
|
|
|
|
<style>
|
|
.deprecated h2 {
|
|
text-decoration: line-through;
|
|
}
|
|
</style>
|
|
<div class="row">
|
|
<div class="span4">
|
|
<div class="btn-group view pull-right" data-toggle="buttons-radio">
|
|
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button>
|
|
<button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
|
|
</div>
|
|
<div class="btn-group visibility" data-toggle="buttons-checkbox">
|
|
<button class="btn public active" title="Show public elements">Public</button>
|
|
<button class="btn protected" title="Show protected elements">Protected</button>
|
|
<button class="btn private" title="Show private elements">Private</button>
|
|
<button class="btn inherited active" title="Show inherited elements">Inherited</button>
|
|
</div>
|
|
|
|
<ul class="side-nav nav nav-list">
|
|
<li class="nav-header">
|
|
<i class="icon-custom icon-method"></i> Methods
|
|
<ul>
|
|
<li class="method public inherited">
|
|
<a href="#method___toString" title="__toString :: Returns a Sass representation of $this.">
|
|
<span class="description">Returns a Sass representation of $this.</span><pre>__toString</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_accept" title="accept :: ">
|
|
<span class="description"></span><pre>accept</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_asInt" title="asInt :: If $this is an integer according to {@see isInt}, returns {@see value} as an int.">
|
|
<span class="description">If $this is an integer according to {@see isInt}, returns {@see value} as an int.</span><pre>asInt</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_asList" title="asList :: This value as a list.">
|
|
<span class="description">This value as a list.</span><pre>asList</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_assertBoolean" title="assertBoolean :: Throws a {@see SassScriptException} if $this isn't a boolean.">
|
|
<span class="description">Throws a {@see SassScriptException} if $this isn't a boolean.</span><pre>assertBoolean</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_assertCalculation" title="assertCalculation :: Throws a {@see SassScriptException} if $this isn't a calculation.">
|
|
<span class="description">Throws a {@see SassScriptException} if $this isn't a calculation.</span><pre>assertCalculation</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_assertColor" title="assertColor :: Throws a {@see SassScriptException} if $this isn't a color.">
|
|
<span class="description">Throws a {@see SassScriptException} if $this isn't a color.</span><pre>assertColor</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_assertFunction" title="assertFunction :: Throws a {@see SassScriptException} if $this isn't a string.">
|
|
<span class="description">Throws a {@see SassScriptException} if $this isn't a string.</span><pre>assertFunction</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_assertInt" title="assertInt :: Returns the value as an int, if it's an integer value according to
|
|
{@see isInt}.">
|
|
<span class="description">Returns the value as an int, if it's an integer value according to
|
|
{@see isInt}.</span><pre>assertInt</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_assertMap" title="assertMap :: Throws a {@see SassScriptException} if $this isn't a map.">
|
|
<span class="description">Throws a {@see SassScriptException} if $this isn't a map.</span><pre>assertMap</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_assertNoUnits" title="assertNoUnits :: Throws a SassScriptException unless $this has no units.">
|
|
<span class="description">Throws a SassScriptException unless $this has no units.</span><pre>assertNoUnits</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_assertNumber" title="assertNumber :: Throws a {@see SassScriptException} if $this isn't a number.">
|
|
<span class="description">Throws a {@see SassScriptException} if $this isn't a number.</span><pre>assertNumber</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_assertString" title="assertString :: Throws a {@see SassScriptException} if $this isn't a string.">
|
|
<span class="description">Throws a {@see SassScriptException} if $this isn't a string.</span><pre>assertString</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_assertUnit" title="assertUnit :: Throws a SassScriptException unless $this has $unit as its only unit
|
|
(and as a numerator).">
|
|
<span class="description">Throws a SassScriptException unless $this has $unit as its only unit
|
|
(and as a numerator).</span><pre>assertUnit</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_coerce" title="coerce :: Returns a copy of this number, converted to the units represented by $newNumeratorUnits and $newDenominatorUnits.">
|
|
<span class="description">Returns a copy of this number, converted to the units represented by $newNumeratorUnits and $newDenominatorUnits.</span><pre>coerce</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_coerceToMatch" title="coerceToMatch :: Returns a copy of this number, converted to the same units as $other.">
|
|
<span class="description">Returns a copy of this number, converted to the same units as $other.</span><pre>coerceToMatch</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_coerceValue" title="coerceValue :: Returns {@see value}, converted to the units represented by $newNumeratorUnits and $newDenominatorUnits.">
|
|
<span class="description">Returns {@see value}, converted to the units represented by $newNumeratorUnits and $newDenominatorUnits.</span><pre>coerceValue</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_coerceValueToMatch" title="coerceValueToMatch :: Returns {@see value}, converted to the same units as $other.">
|
|
<span class="description">Returns {@see value}, converted to the same units as $other.</span><pre>coerceValueToMatch</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_coerceValueToUnit" title="coerceValueToUnit :: A shorthand for {@see coerceValue} with a single unit">
|
|
<span class="description">A shorthand for {@see coerceValue} with a single unit</span><pre>coerceValueToUnit</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_compatibleWithUnit" title="compatibleWithUnit :: Returns whether $this can be coerced to the given unit.">
|
|
<span class="description">Returns whether $this can be coerced to the given unit.</span><pre>compatibleWithUnit</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_convert" title="convert :: Returns a copy of this number, converted to the units represented by $newNumeratorUnits and $newDenominatorUnits.">
|
|
<span class="description">Returns a copy of this number, converted to the units represented by $newNumeratorUnits and $newDenominatorUnits.</span><pre>convert</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_convertToMatch" title="convertToMatch :: Returns a copy of this number, converted to the same units as $other.">
|
|
<span class="description">Returns a copy of this number, converted to the same units as $other.</span><pre>convertToMatch</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_convertValue" title="convertValue :: Returns {@see value}, converted to the units represented by $newNumeratorUnits and $newDenominatorUnits.">
|
|
<span class="description">Returns {@see value}, converted to the units represented by $newNumeratorUnits and $newDenominatorUnits.</span><pre>convertValue</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_convertValueToMatch" title="convertValueToMatch :: Returns {@see value}, converted to the same units as $other.">
|
|
<span class="description">Returns {@see value}, converted to the same units as $other.</span><pre>convertValueToMatch</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_create" title="create :: Creates a number, optionally with a single numerator unit.">
|
|
<span class="description">Creates a number, optionally with a single numerator unit.</span><pre>create</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_dividedBy" title="dividedBy :: ">
|
|
<span class="description"></span><pre>dividedBy</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_equals" title="equals :: ">
|
|
<span class="description"></span><pre>equals</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_getDenominatorUnits" title="getDenominatorUnits :: ">
|
|
<span class="description"></span><pre>getDenominatorUnits</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_getNumeratorUnits" title="getNumeratorUnits :: ">
|
|
<span class="description"></span><pre>getNumeratorUnits</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_getSeparator" title="getSeparator :: The separator for this value as a list.">
|
|
<span class="description">The separator for this value as a list.</span><pre>getSeparator</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_getUnitString" title="getUnitString :: Returns a human-readable string representation of this number's units.">
|
|
<span class="description">Returns a human-readable string representation of this number's units.</span><pre>getUnitString</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_getValue" title="getValue :: The value of this number.">
|
|
<span class="description">The value of this number.</span><pre>getValue</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_greaterThan" title="greaterThan :: ">
|
|
<span class="description"></span><pre>greaterThan</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_greaterThanOrEquals" title="greaterThanOrEquals :: ">
|
|
<span class="description"></span><pre>greaterThanOrEquals</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_hasBrackets" title="hasBrackets :: Whether this value as a list has brackets.">
|
|
<span class="description">Whether this value as a list has brackets.</span><pre>hasBrackets</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_hasCompatibleUnits" title="hasCompatibleUnits :: Returns whether $this has units that are compatible with $other.">
|
|
<span class="description">Returns whether $this has units that are compatible with $other.</span><pre>hasCompatibleUnits</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_hasUnit" title="hasUnit :: Returns whether $this has $unit as its only unit (and as a numerator).">
|
|
<span class="description">Returns whether $this has $unit as its only unit (and as a numerator).</span><pre>hasUnit</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_hasUnits" title="hasUnits :: Returns true if the number has units.">
|
|
<span class="description">Returns true if the number has units.</span><pre>hasUnits</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_isInt" title="isInt :: Whether $this is an integer, according to {@see NumberUtil::fuzzyEquals}.">
|
|
<span class="description">Whether $this is an integer, according to {@see NumberUtil::fuzzyEquals}.</span><pre>isInt</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_isTruthy" title="isTruthy :: Whether the value counts as `true` in an `@if` statement and other contexts">
|
|
<span class="description">Whether the value counts as `true` in an `@if` statement and other contexts</span><pre>isTruthy</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_lessThan" title="lessThan :: ">
|
|
<span class="description"></span><pre>lessThan</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_lessThanOrEquals" title="lessThanOrEquals :: ">
|
|
<span class="description"></span><pre>lessThanOrEquals</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_minus" title="minus :: ">
|
|
<span class="description"></span><pre>minus</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_modulo" title="modulo :: ">
|
|
<span class="description"></span><pre>modulo</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_plus" title="plus :: ">
|
|
<span class="description"></span><pre>plus</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_sassIndexToListIndex" title="sassIndexToListIndex :: Converts $sassIndex into a PHP-style index into the list returned by
|
|
{@see asList}.">
|
|
<span class="description">Converts $sassIndex into a PHP-style index into the list returned by
|
|
{@see asList}.</span><pre>sassIndexToListIndex</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_times" title="times :: ">
|
|
<span class="description"></span><pre>times</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_toCssString" title="toCssString :: Returns a valid CSS representation of $this.">
|
|
<span class="description">Returns a valid CSS representation of $this.</span><pre>toCssString</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_tryMap" title="tryMap :: Return $this as a SassMap if it is one (including empty lists) or null otherwise.">
|
|
<span class="description">Return $this as a SassMap if it is one (including empty lists) or null otherwise.</span><pre>tryMap</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_unaryPlus" title="unaryPlus :: ">
|
|
<span class="description"></span><pre>unaryPlus</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_valueInRange" title="valueInRange :: If {@see value} is between $min and $max, returns it.">
|
|
<span class="description">If {@see value} is between $min and $max, returns it.</span><pre>valueInRange</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public inherited">
|
|
<a href="#method_withListContents" title="withListContents :: Returns a new list containing $contents that defaults to this value's
|
|
separator and brackets.">
|
|
<span class="description">Returns a new list containing $contents that defaults to this value's
|
|
separator and brackets.</span><pre>withListContents</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_withoutSlash" title="withoutSlash :: ">
|
|
<span class="description"></span><pre>withoutSlash</pre>
|
|
</a>
|
|
</li>
|
|
|
|
<li class="method public">
|
|
<a href="#method_withUnits" title="withUnits :: Creates a number with full $numeratorUnits and $denominatorUnits.">
|
|
<span class="description">Creates a number with full $numeratorUnits and $denominatorUnits.</span><pre>withUnits</pre>
|
|
</a>
|
|
</li>
|
|
|
|
</ul>
|
|
</li>
|
|
<li class="nav-header protected">» Protected
|
|
<ul>
|
|
<li class="method protected">
|
|
<a href="#method___construct" title="__construct :: ">
|
|
<span class="description"></span><pre>__construct</pre>
|
|
</a>
|
|
</li>
|
|
<li class="method protected">
|
|
<a href="#method_getConversionFactor" title="getConversionFactor :: Returns the number of [unit1]s per [unit2].">
|
|
<span class="description">Returns the number of [unit1]s per [unit2].</span><pre>getConversionFactor</pre>
|
|
</a>
|
|
</li>
|
|
<li class="method protected inherited">
|
|
<a href="#method_getLengthAsList" title="getLengthAsList :: The length of {@see asList}.">
|
|
<span class="description">The length of {@see asList}.</span><pre>getLengthAsList</pre>
|
|
</a>
|
|
</li>
|
|
<li class="method protected">
|
|
<a href="#method_multiplyUnits" title="multiplyUnits :: ">
|
|
<span class="description"></span><pre>multiplyUnits</pre>
|
|
</a>
|
|
</li>
|
|
<li class="method protected">
|
|
<a href="#method_withValue" title="withValue :: Returns a SassNumber with this value and the same units.">
|
|
<span class="description">Returns a SassNumber with this value and the same units.</span><pre>withValue</pre>
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="nav-header private">» Private
|
|
<ul>
|
|
<li class="method private">
|
|
<a href="#method_buildUnitString" title="buildUnitString :: Returns unit(s) as the product of numerator units divided by the product of denominator units">
|
|
<span class="description">Returns unit(s) as the product of numerator units divided by the product of denominator units</span><pre>buildUnitString</pre>
|
|
</a>
|
|
</li>
|
|
<li class="method private">
|
|
<a href="#method_canonicalizeUnitList" title="canonicalizeUnitList :: ">
|
|
<span class="description"></span><pre>canonicalizeUnitList</pre>
|
|
</a>
|
|
</li>
|
|
<li class="method private">
|
|
<a href="#method_coerceUnits" title="coerceUnits :: ">
|
|
<span class="description"></span><pre>coerceUnits</pre>
|
|
</a>
|
|
</li>
|
|
<li class="method private">
|
|
<a href="#method_compatibilityException" title="compatibilityException :: ">
|
|
<span class="description"></span><pre>compatibilityException</pre>
|
|
</a>
|
|
</li>
|
|
<li class="method private">
|
|
<a href="#method_convertOrCoerceValue" title="convertOrCoerceValue :: ">
|
|
<span class="description"></span><pre>convertOrCoerceValue</pre>
|
|
</a>
|
|
</li>
|
|
<li class="method private">
|
|
<a href="#method_getCanonicalMultiplier" title="getCanonicalMultiplier :: ">
|
|
<span class="description"></span><pre>getCanonicalMultiplier</pre>
|
|
</a>
|
|
</li>
|
|
<li class="method private">
|
|
<a href="#method_getCanonicalMultiplierForUnit" title="getCanonicalMultiplierForUnit :: ">
|
|
<span class="description"></span><pre>getCanonicalMultiplierForUnit</pre>
|
|
</a>
|
|
</li>
|
|
<li class="method private inherited">
|
|
<a href="#method_selectorString" title="selectorString :: Converts a `selector-parse()`-style input into a string that can be
|
|
parsed.">
|
|
<span class="description">Converts a `selector-parse()`-style input into a string that can be
|
|
parsed.</span><pre>selectorString</pre>
|
|
</a>
|
|
</li>
|
|
<li class="method private inherited">
|
|
<a href="#method_selectorStringOrNull" title="selectorStringOrNull :: Converts a `selector-parse()`-style input into a string that can be
|
|
parsed.">
|
|
<span class="description">Converts a `selector-parse()`-style input into a string that can be
|
|
parsed.</span><pre>selectorStringOrNull</pre>
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="nav-header">
|
|
<i class="icon-custom icon-constant"></i> Constants
|
|
<ul>
|
|
<li class="constant private">
|
|
<a href="#constant_CONVERSIONS" title="CONVERSIONS :: ">
|
|
<span class="description"></span><pre>CONVERSIONS</pre>
|
|
</a>
|
|
</li>
|
|
<li class="constant public">
|
|
<a href="#constant_PRECISION" title="PRECISION :: ">
|
|
<span class="description"></span><pre>PRECISION</pre>
|
|
</a>
|
|
</li>
|
|
<li class="constant private">
|
|
<a href="#constant_TYPES_BY_UNIT" title="TYPES_BY_UNIT :: A map from units to the human-readable names of those unit types.">
|
|
<span class="description">A map from units to the human-readable names of those unit types.</span><pre>TYPES_BY_UNIT</pre>
|
|
</a>
|
|
</li>
|
|
<li class="constant private">
|
|
<a href="#constant_UNITS_BY_TYPE" title="UNITS_BY_TYPE :: A map from human-readable names of unit types to the convertible units that
|
|
fall into those types.">
|
|
<span class="description">A map from human-readable names of unit types to the convertible units that
|
|
fall into those types.</span><pre>UNITS_BY_TYPE</pre>
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
|
|
<div class="span8">
|
|
<div class="element class">
|
|
<h1>SassNumber</h1>
|
|
<small style="display: block; text-align: right">
|
|
Extends <a href="classes/ScssPhp-ScssPhp-Value-Value.html"><abbr title="\ScssPhp\ScssPhp\Value\Value">Value</abbr></a>
|
|
</small>
|
|
<p class="short_description">A SassScript number.</p>
|
|
<div class="details">
|
|
<div class="long_description">
|
|
<p>Numbers can have units. Although there's no literal syntax for it, numbers
|
|
support scientific-style numerator and denominator units (for example,
|
|
<code class="prettyprint">miles/hour</code>). These are expected to be resolved before being emitted to
|
|
CSS.</p>
|
|
|
|
</div>
|
|
<table class="table table-bordered">
|
|
<tr>
|
|
<th>
|
|
package
|
|
</th>
|
|
<td>
|
|
|
|
<p>Application</p>
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3><i class="icon-custom icon-method"></i> Methods</h3>
|
|
<a id="method___construct"></a>
|
|
<div class="element clickable method protected method___construct" data-toggle="collapse" data-target=".method___construct .collapse">
|
|
<h2>__construct</h2>
|
|
<pre>__construct(floatvalue, array{: \ScssPhp\ScssPhp\Value\SassNumber, : \ScssPhp\ScssPhp\Value\SassNumber}|nullasSlash = null) : mixed</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>value</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
float</code><p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>asSlash</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
array{: \ScssPhp\ScssPhp\Value\SassNumber, : \ScssPhp\ScssPhp\Value\SassNumber}|null</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
mixed</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method___toString"></a>
|
|
<div class="element clickable method public method___toString inherited" data-toggle="collapse" data-target=".method___toString .collapse">
|
|
<h2>Returns a Sass representation of $this.</h2>
|
|
<pre>__toString() : string</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> <span class="label">final</span> </div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"><p>Note that this is equivalent to calling <code class="prettyprint">inspect()</code> on the value, and thus
|
|
won't reflect the user's output settings. {@see \ScssPhp\ScssPhp\Value\toCssString} should be used
|
|
instead to convert $this to CSS.</p>
|
|
</div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
string</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_accept"></a>
|
|
<div class="element clickable method public method_accept" data-toggle="collapse" data-target=".method_accept .collapse">
|
|
<h2>accept</h2>
|
|
<pre>accept(\ScssPhp\ScssPhp\Visitor\ValueVisitorvisitor) : mixed</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>visitor</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Visitor\ValueVisitor</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
mixed</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_asInt"></a>
|
|
<div class="element clickable method public method_asInt" data-toggle="collapse" data-target=".method_asInt .collapse">
|
|
<h2>If $this is an integer according to {@see isInt}, returns {@see value} as an int.</h2>
|
|
<pre>asInt() : ?int</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"><p>Otherwise, returns <code class="prettyprint">null</code>.</p>
|
|
</div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
?int</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_asList"></a>
|
|
<div class="element clickable method public method_asList inherited" data-toggle="collapse" data-target=".method_asList .collapse">
|
|
<h2>This value as a list.</h2>
|
|
<pre>asList() : list<\ScssPhp\ScssPhp\Value\Value></pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> </div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"><p>All SassScript values can be used as lists. Maps count as lists of pairs,
|
|
and all other values count as single-value lists.</p>
|
|
</div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
list<\ScssPhp\ScssPhp\Value\Value></code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_assertBoolean"></a>
|
|
<div class="element clickable method public method_assertBoolean inherited" data-toggle="collapse" data-target=".method_assertBoolean .collapse">
|
|
<h2>Throws a {@see SassScriptException} if $this isn't a boolean.</h2>
|
|
<pre>assertBoolean(?stringname = null) : \ScssPhp\ScssPhp\Value\SassBoolean</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> </div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"><p>Note that generally, functions should use {@see \ScssPhp\ScssPhp\Value\isTruthy} rather than requiring
|
|
a literal boolean.</p>
|
|
<p>If this came from a function argument, $name is the argument name
|
|
(without the <code class="prettyprint">$</code>). It's used for error reporting.</p>
|
|
</div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>Throws</th>
|
|
<td>
|
|
<dl>
|
|
<dt>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Exception\SassScriptException</dt>
|
|
<dd></dd>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>name</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
?string</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Value\SassBoolean</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_assertCalculation"></a>
|
|
<div class="element clickable method public method_assertCalculation inherited" data-toggle="collapse" data-target=".method_assertCalculation .collapse">
|
|
<h2>Throws a {@see SassScriptException} if $this isn't a calculation.</h2>
|
|
<pre>assertCalculation(?stringname = null) : \ScssPhp\ScssPhp\Value\SassCalculation</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> </div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"><p>If this came from a function argument, $name is the argument name
|
|
(without the <code class="prettyprint">$</code>). It's used for error reporting.</p>
|
|
</div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>Throws</th>
|
|
<td>
|
|
<dl>
|
|
<dt>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Exception\SassScriptException</dt>
|
|
<dd></dd>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>name</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
?string</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Value\SassCalculation</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_assertColor"></a>
|
|
<div class="element clickable method public method_assertColor inherited" data-toggle="collapse" data-target=".method_assertColor .collapse">
|
|
<h2>Throws a {@see SassScriptException} if $this isn't a color.</h2>
|
|
<pre>assertColor(?stringname = null) : \ScssPhp\ScssPhp\Value\SassColor</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> </div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"><p>If this came from a function argument, $name is the argument name
|
|
(without the <code class="prettyprint">$</code>). It's used for error reporting.</p>
|
|
</div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>Throws</th>
|
|
<td>
|
|
<dl>
|
|
<dt>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Exception\SassScriptException</dt>
|
|
<dd></dd>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>name</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
?string</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Value\SassColor</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_assertFunction"></a>
|
|
<div class="element clickable method public method_assertFunction inherited" data-toggle="collapse" data-target=".method_assertFunction .collapse">
|
|
<h2>Throws a {@see SassScriptException} if $this isn't a string.</h2>
|
|
<pre>assertFunction(?stringname = null) : \ScssPhp\ScssPhp\Value\SassFunction</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> </div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"><p>If this came from a function argument, $name is the argument name
|
|
(without the <code class="prettyprint">$</code>). It's used for error reporting.</p>
|
|
</div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>Throws</th>
|
|
<td>
|
|
<dl>
|
|
<dt>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Exception\SassScriptException</dt>
|
|
<dd></dd>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>name</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
?string</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Value\SassFunction</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_assertInt"></a>
|
|
<div class="element clickable method public method_assertInt" data-toggle="collapse" data-target=".method_assertInt .collapse">
|
|
<h2>Returns the value as an int, if it's an integer value according to
|
|
{@see isInt}.</h2>
|
|
<pre>assertInt(?stringname = null) : int</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>Throws</th>
|
|
<td>
|
|
<dl>
|
|
<dt>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Exception\SassScriptException</dt>
|
|
<dd><p>if the value isn't an integer. If this came
|
|
from a function argument, $name is the argument name (without the <code class="prettyprint">$</code>).
|
|
It's used for error reporting.</p>
|
|
</dd>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>name</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
?string</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
int</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_assertMap"></a>
|
|
<div class="element clickable method public method_assertMap inherited" data-toggle="collapse" data-target=".method_assertMap .collapse">
|
|
<h2>Throws a {@see SassScriptException} if $this isn't a map.</h2>
|
|
<pre>assertMap(?stringname = null) : \ScssPhp\ScssPhp\Value\SassMap</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> </div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"><p>If this came from a function argument, $name is the argument name
|
|
(without the <code class="prettyprint">$</code>). It's used for error reporting.</p>
|
|
</div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>Throws</th>
|
|
<td>
|
|
<dl>
|
|
<dt>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Exception\SassScriptException</dt>
|
|
<dd></dd>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>name</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
?string</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Value\SassMap</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_assertNoUnits"></a>
|
|
<div class="element clickable method public method_assertNoUnits" data-toggle="collapse" data-target=".method_assertNoUnits .collapse">
|
|
<h2>Throws a SassScriptException unless $this has no units.</h2>
|
|
<pre>assertNoUnits(?stringvarName = null) : void</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"><p>If this came from a function argument, $name is the argument name
|
|
(without the <code class="prettyprint">$</code>). It's used for error reporting.</p>
|
|
</div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>Throws</th>
|
|
<td>
|
|
<dl>
|
|
<dt>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Exception\SassScriptException</dt>
|
|
<dd></dd>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>varName</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
?string</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_assertNumber"></a>
|
|
<div class="element clickable method public method_assertNumber" data-toggle="collapse" data-target=".method_assertNumber .collapse">
|
|
<h2>Throws a {@see SassScriptException} if $this isn't a number.</h2>
|
|
<pre>assertNumber(?stringname = null) : \ScssPhp\ScssPhp\Value\SassNumber</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"><p>If this came from a function argument, $name is the argument name
|
|
(without the <code class="prettyprint">$</code>). It's used for error reporting.</p>
|
|
</div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>name</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
?string</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Value\SassNumber</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_assertString"></a>
|
|
<div class="element clickable method public method_assertString inherited" data-toggle="collapse" data-target=".method_assertString .collapse">
|
|
<h2>Throws a {@see SassScriptException} if $this isn't a string.</h2>
|
|
<pre>assertString(?stringname = null) : \ScssPhp\ScssPhp\Value\SassString</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> </div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"><p>If this came from a function argument, $name is the argument name
|
|
(without the <code class="prettyprint">$</code>). It's used for error reporting.</p>
|
|
</div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>Throws</th>
|
|
<td>
|
|
<dl>
|
|
<dt>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Exception\SassScriptException</dt>
|
|
<dd></dd>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>name</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
?string</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Value\SassString</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_assertUnit"></a>
|
|
<div class="element clickable method public method_assertUnit" data-toggle="collapse" data-target=".method_assertUnit .collapse">
|
|
<h2>Throws a SassScriptException unless $this has $unit as its only unit
|
|
(and as a numerator).</h2>
|
|
<pre>assertUnit(stringunit, ?stringvarName = null) : void</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"><p>If this came from a function argument, $name is the argument name
|
|
(without the <code class="prettyprint">$</code>). It's used for error reporting.</p>
|
|
</div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>Throws</th>
|
|
<td>
|
|
<dl>
|
|
<dt>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Exception\SassScriptException</dt>
|
|
<dd></dd>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>unit</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
string</code><p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>varName</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
?string</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_buildUnitString"></a>
|
|
<div class="element clickable method private method_buildUnitString" data-toggle="collapse" data-target=".method_buildUnitString .collapse">
|
|
<h2>Returns unit(s) as the product of numerator units divided by the product of denominator units</h2>
|
|
<pre>buildUnitString(list<string>numerators, list<string>denominators) : string</pre>
|
|
<div class="labels">
|
|
<span class="label">static</span> </div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>numerators</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
list<string></code><p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>denominators</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
list<string></code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
string</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_canonicalizeUnitList"></a>
|
|
<div class="element clickable method private method_canonicalizeUnitList" data-toggle="collapse" data-target=".method_canonicalizeUnitList .collapse">
|
|
<h2>canonicalizeUnitList</h2>
|
|
<pre>canonicalizeUnitList(list<string>units) : list<string></pre>
|
|
<div class="labels">
|
|
<span class="label">static</span> </div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>units</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
list<string></code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
list<string></code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_coerce"></a>
|
|
<div class="element clickable method public method_coerce" data-toggle="collapse" data-target=".method_coerce .collapse">
|
|
<h2>Returns a copy of this number, converted to the units represented by $newNumeratorUnits and $newDenominatorUnits.</h2>
|
|
<pre>coerce(list<string>newNumeratorUnits, list<string>newDenominatorUnits, ?stringname = null) : \ScssPhp\ScssPhp\Value\SassNumber</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"><p>This does not throw an error if this number is unitless and
|
|
$newNumeratorUnits/$newDenominatorUnits are not empty, or vice versa. Instead,
|
|
it treats all unitless numbers as convertible to and from all units without
|
|
changing the value.</p>
|
|
<p>Note that {@see \ScssPhp\ScssPhp\Value\coerceValue} is generally more efficient if the value
|
|
is going to be accessed directly.</p>
|
|
</div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>Throws</th>
|
|
<td>
|
|
<dl>
|
|
<dt>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Exception\SassScriptException</dt>
|
|
<dd><p>if this number's units are not compatible with $newNumeratorUnits and $newDenominatorUnits</p>
|
|
</dd>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>newNumeratorUnits</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
list<string></code><p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>newDenominatorUnits</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
list<string></code><p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>name</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
?string</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Value\SassNumber</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_coerceToMatch"></a>
|
|
<div class="element clickable method public method_coerceToMatch" data-toggle="collapse" data-target=".method_coerceToMatch .collapse">
|
|
<h2>Returns a copy of this number, converted to the same units as $other.</h2>
|
|
<pre>coerceToMatch(\ScssPhp\ScssPhp\Value\SassNumberother, string|nullname = null, string|nullotherName = null) : \ScssPhp\ScssPhp\Value\SassNumber</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"><p>Unlike {@see \ScssPhp\ScssPhp\Value\convertToMatch}, this does not throw an error if this number is
|
|
unitless and $other is not, or vice versa. Instead, it treats all unitless
|
|
numbers as convertible to and from all units without changing the value.</p>
|
|
<p>Note that {@see \ScssPhp\ScssPhp\Value\coerceValueToMatch} is generally more efficient if the value
|
|
is going to be accessed directly.</p>
|
|
</div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>Throws</th>
|
|
<td>
|
|
<dl>
|
|
<dt>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Exception\SassScriptException</dt>
|
|
<dd><p>if the units are not compatible</p>
|
|
</dd>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>other</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Value\SassNumber</code><p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>name</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
string|null</code><p><p>The argument name if this is a function argument</p>
|
|
</p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>otherName</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
string|null</code><p><p>The argument name for $other if this is a function argument</p>
|
|
</p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Value\SassNumber</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_coerceUnits"></a>
|
|
<div class="element clickable method private method_coerceUnits" data-toggle="collapse" data-target=".method_coerceUnits .collapse">
|
|
<h2>coerceUnits</h2>
|
|
<pre>coerceUnits(\ScssPhp\ScssPhp\Value\SassNumberother, callableoperation) : \ScssPhp\ScssPhp\Value\T</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
template
|
|
</th>
|
|
<td>
|
|
|
|
<p>T</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>other</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Value\SassNumber</code><p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>operation</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
callable</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Value\T</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_coerceValue"></a>
|
|
<div class="element clickable method public method_coerceValue" data-toggle="collapse" data-target=".method_coerceValue .collapse">
|
|
<h2>Returns {@see value}, converted to the units represented by $newNumeratorUnits and $newDenominatorUnits.</h2>
|
|
<pre>coerceValue(list<string>newNumeratorUnits, list<string>newDenominatorUnits, ?stringname = null) : float</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"><p>This does not throw an error if this number is unitless and
|
|
$newNumeratorUnits/$newDenominatorUnits are not empty, or vice versa. Instead,
|
|
it treats all unitless numbers as convertible to and from all units without
|
|
changing the value.</p>
|
|
</div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>Throws</th>
|
|
<td>
|
|
<dl>
|
|
<dt>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Exception\SassScriptException</dt>
|
|
<dd><p>if this number's units are not compatible with $newNumeratorUnits and $newDenominatorUnits</p>
|
|
</dd>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>newNumeratorUnits</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
list<string></code><p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>newDenominatorUnits</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
list<string></code><p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>name</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
?string</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
float</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_coerceValueToMatch"></a>
|
|
<div class="element clickable method public method_coerceValueToMatch" data-toggle="collapse" data-target=".method_coerceValueToMatch .collapse">
|
|
<h2>Returns {@see value}, converted to the same units as $other.</h2>
|
|
<pre>coerceValueToMatch(\ScssPhp\ScssPhp\Value\SassNumberother, string|nullname = null, string|nullotherName = null) : float</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"><p>Unlike {@see \ScssPhp\ScssPhp\Value\convertValueToMatch}, this does not throw an error if this number
|
|
is unitless and $other is not, or vice versa. Instead, it treats all unitless
|
|
numbers as convertible to and from all units without changing the value.</p>
|
|
</div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>Throws</th>
|
|
<td>
|
|
<dl>
|
|
<dt>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Exception\SassScriptException</dt>
|
|
<dd><p>if the units are not compatible</p>
|
|
</dd>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>other</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Value\SassNumber</code><p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>name</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
string|null</code><p><p>The argument name if this is a function argument</p>
|
|
</p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>otherName</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
string|null</code><p><p>The argument name for $other if this is a function argument</p>
|
|
</p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
float</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_coerceValueToUnit"></a>
|
|
<div class="element clickable method public method_coerceValueToUnit" data-toggle="collapse" data-target=".method_coerceValueToUnit .collapse">
|
|
<h2>A shorthand for {@see coerceValue} with a single unit</h2>
|
|
<pre>coerceValueToUnit(stringunit, ?stringname = null) : float</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>unit</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
string</code><p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>name</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
?string</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
float</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_compatibilityException"></a>
|
|
<div class="element clickable method private method_compatibilityException" data-toggle="collapse" data-target=".method_compatibilityException .collapse">
|
|
<h2>compatibilityException</h2>
|
|
<pre>compatibilityException(boolotherHasUnits, list<string>newNumeratorUnits, list<string>newDenominatorUnits, ?stringname, ?\ScssPhp\ScssPhp\Value\SassNumberother = null, ?stringotherName = null) : \ScssPhp\ScssPhp\Exception\SassScriptException</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>otherHasUnits</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
bool</code><p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>newNumeratorUnits</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
list<string></code><p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>newDenominatorUnits</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
list<string></code><p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>name</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
?string</code><p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>other</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
?\ScssPhp\ScssPhp\Value\SassNumber</code><p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>otherName</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
?string</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Exception\SassScriptException</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_compatibleWithUnit"></a>
|
|
<div class="element clickable method public method_compatibleWithUnit" data-toggle="collapse" data-target=".method_compatibleWithUnit .collapse">
|
|
<h2>Returns whether $this can be coerced to the given unit.</h2>
|
|
<pre>compatibleWithUnit(stringunit) : bool</pre>
|
|
<div class="labels">
|
|
<span class="label">abstract</span> </div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"><p>This always returns <code class="prettyprint">true</code> for a unitless number.</p>
|
|
</div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>unit</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
string</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
bool</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_convert"></a>
|
|
<div class="element clickable method public method_convert" data-toggle="collapse" data-target=".method_convert .collapse">
|
|
<h2>Returns a copy of this number, converted to the units represented by $newNumeratorUnits and $newDenominatorUnits.</h2>
|
|
<pre>convert(list<string>newNumeratorUnits, list<string>newDenominatorUnits, ?stringname = null) : \ScssPhp\ScssPhp\Value\SassNumber</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"><p>Note that {@see \ScssPhp\ScssPhp\Value\convertValue} is generally more efficient if the value
|
|
is going to be accessed directly.</p>
|
|
</div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>Throws</th>
|
|
<td>
|
|
<dl>
|
|
<dt>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Exception\SassScriptException</dt>
|
|
<dd><p>if this number's units are not compatible with $newNumeratorUnits and $newDenominatorUnits, or if either number is unitless but the other is not.</p>
|
|
</dd>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>newNumeratorUnits</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
list<string></code><p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>newDenominatorUnits</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
list<string></code><p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>name</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
?string</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Value\SassNumber</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_convertOrCoerceValue"></a>
|
|
<div class="element clickable method private method_convertOrCoerceValue" data-toggle="collapse" data-target=".method_convertOrCoerceValue .collapse">
|
|
<h2>convertOrCoerceValue</h2>
|
|
<pre>convertOrCoerceValue(list<string>newNumeratorUnits, list<string>newDenominatorUnits, boolcoerceUnitless, string|nullname = null, \ScssPhp\ScssPhp\Value\SassNumberother = null, string|nullotherName = null) : float</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>Throws</th>
|
|
<td>
|
|
<dl>
|
|
<dt>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Exception\SassScriptException</dt>
|
|
<dd><p>if this number's units are not compatible with $newNumeratorUnits and $newDenominatorUnits</p>
|
|
</dd>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>newNumeratorUnits</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
list<string></code><p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>newDenominatorUnits</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
list<string></code><p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>coerceUnitless</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
bool</code><p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>name</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
string|null</code><p><p>The argument name if this is a function argument</p>
|
|
</p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>other</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Value\SassNumber</code><p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>otherName</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
string|null</code><p><p>The argument name for $other if this is a function argument</p>
|
|
</p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
float</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_convertToMatch"></a>
|
|
<div class="element clickable method public method_convertToMatch" data-toggle="collapse" data-target=".method_convertToMatch .collapse">
|
|
<h2>Returns a copy of this number, converted to the same units as $other.</h2>
|
|
<pre>convertToMatch(\ScssPhp\ScssPhp\Value\SassNumberother, string|nullname = null, string|nullotherName = null) : \ScssPhp\ScssPhp\Value\SassNumber</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"><p>Note that {@see \ScssPhp\ScssPhp\Value\convertValueToMatch} is generally more efficient if the value
|
|
is going to be accessed directly.</p>
|
|
</div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>Throws</th>
|
|
<td>
|
|
<dl>
|
|
<dt>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Exception\SassScriptException</dt>
|
|
<dd><p>if the units are not compatible or if either number is unitless but the other is not.</p>
|
|
</dd>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>other</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Value\SassNumber</code><p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>name</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
string|null</code><p><p>The argument name if this is a function argument</p>
|
|
</p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>otherName</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
string|null</code><p><p>The argument name for $other if this is a function argument</p>
|
|
</p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Value\SassNumber</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_convertValue"></a>
|
|
<div class="element clickable method public method_convertValue" data-toggle="collapse" data-target=".method_convertValue .collapse">
|
|
<h2>Returns {@see value}, converted to the units represented by $newNumeratorUnits and $newDenominatorUnits.</h2>
|
|
<pre>convertValue(list<string>newNumeratorUnits, list<string>newDenominatorUnits, ?stringname = null) : float</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>Throws</th>
|
|
<td>
|
|
<dl>
|
|
<dt>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Exception\SassScriptException</dt>
|
|
<dd><p>if this number's units are not compatible with $newNumeratorUnits and $newDenominatorUnits, or if either number is unitless but the other is not.</p>
|
|
</dd>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>newNumeratorUnits</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
list<string></code><p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>newDenominatorUnits</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
list<string></code><p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>name</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
?string</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
float</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_convertValueToMatch"></a>
|
|
<div class="element clickable method public method_convertValueToMatch" data-toggle="collapse" data-target=".method_convertValueToMatch .collapse">
|
|
<h2>Returns {@see value}, converted to the same units as $other.</h2>
|
|
<pre>convertValueToMatch(\ScssPhp\ScssPhp\Value\SassNumberother, string|nullname = null, string|nullotherName = null) : float</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>Throws</th>
|
|
<td>
|
|
<dl>
|
|
<dt>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Exception\SassScriptException</dt>
|
|
<dd><p>if the units are not compatible or if either number is unitless but the other is not.</p>
|
|
</dd>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>other</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Value\SassNumber</code><p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>name</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
string|null</code><p><p>The argument name if this is a function argument</p>
|
|
</p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>otherName</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
string|null</code><p><p>The argument name for $other if this is a function argument</p>
|
|
</p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
float</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_create"></a>
|
|
<div class="element clickable method public method_create" data-toggle="collapse" data-target=".method_create .collapse">
|
|
<h2>Creates a number, optionally with a single numerator unit.</h2>
|
|
<pre>create(floatvalue, ?stringunit = null) : \ScssPhp\ScssPhp\Value\SassNumber</pre>
|
|
<div class="labels">
|
|
<span class="label">static</span> <span class="label">final</span> </div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"><p>This matches the numbers that can be written as literals.
|
|
{@see \ScssPhp\ScssPhp\Value\SassNumber::withUnits} can be used to construct more complex units.</p>
|
|
</div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>value</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
float</code><p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>unit</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
?string</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Value\SassNumber</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_dividedBy"></a>
|
|
<div class="element clickable method public method_dividedBy" data-toggle="collapse" data-target=".method_dividedBy .collapse">
|
|
<h2>dividedBy</h2>
|
|
<pre>dividedBy(\ScssPhp\ScssPhp\Value\Valueother) : \ScssPhp\ScssPhp\Value\Value</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>other</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Value\Value</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Value\Value</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_equals"></a>
|
|
<div class="element clickable method public method_equals" data-toggle="collapse" data-target=".method_equals .collapse">
|
|
<h2>equals</h2>
|
|
<pre>equals(objectother) : bool</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>other</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
object</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
bool</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_getCanonicalMultiplier"></a>
|
|
<div class="element clickable method private method_getCanonicalMultiplier" data-toggle="collapse" data-target=".method_getCanonicalMultiplier .collapse">
|
|
<h2>getCanonicalMultiplier</h2>
|
|
<pre>getCanonicalMultiplier(list<string>units) : float</pre>
|
|
<div class="labels">
|
|
<span class="label">static</span> </div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>units</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
list<string></code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
float</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_getCanonicalMultiplierForUnit"></a>
|
|
<div class="element clickable method private method_getCanonicalMultiplierForUnit" data-toggle="collapse" data-target=".method_getCanonicalMultiplierForUnit .collapse">
|
|
<h2>getCanonicalMultiplierForUnit</h2>
|
|
<pre>getCanonicalMultiplierForUnit(stringunit) : float</pre>
|
|
<div class="labels">
|
|
<span class="label">static</span> </div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>unit</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
string</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
float</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_getConversionFactor"></a>
|
|
<div class="element clickable method protected method_getConversionFactor" data-toggle="collapse" data-target=".method_getConversionFactor .collapse">
|
|
<h2>Returns the number of [unit1]s per [unit2].</h2>
|
|
<pre>getConversionFactor(stringunit1, stringunit2) : ?float</pre>
|
|
<div class="labels">
|
|
<span class="label">static</span> </div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"><p>Equivalently, <code class="prettyprint">1unit2 * conversionFactor(unit1, unit2) = 1unit1</code>.</p>
|
|
</div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>unit1</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
string</code><p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>unit2</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
string</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
?float</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_getDenominatorUnits"></a>
|
|
<div class="element clickable method public method_getDenominatorUnits" data-toggle="collapse" data-target=".method_getDenominatorUnits .collapse">
|
|
<h2>getDenominatorUnits</h2>
|
|
<pre>getDenominatorUnits() : list<string></pre>
|
|
<div class="labels">
|
|
<span class="label">abstract</span> </div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
list<string></code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_getLengthAsList"></a>
|
|
<div class="element clickable method protected method_getLengthAsList inherited" data-toggle="collapse" data-target=".method_getLengthAsList .collapse">
|
|
<h2>The length of {@see asList}.</h2>
|
|
<pre>getLengthAsList() : int</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> </div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"><p>This is used to compute {@see \ScssPhp\ScssPhp\Value\sassIndexToListIndex} without allocating a new
|
|
list.</p>
|
|
</div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
int</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_getNumeratorUnits"></a>
|
|
<div class="element clickable method public method_getNumeratorUnits" data-toggle="collapse" data-target=".method_getNumeratorUnits .collapse">
|
|
<h2>getNumeratorUnits</h2>
|
|
<pre>getNumeratorUnits() : list<string></pre>
|
|
<div class="labels">
|
|
<span class="label">abstract</span> </div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
list<string></code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_getSeparator"></a>
|
|
<div class="element clickable method public method_getSeparator inherited" data-toggle="collapse" data-target=".method_getSeparator .collapse">
|
|
<h2>The separator for this value as a list.</h2>
|
|
<pre>getSeparator() : \ScssPhp\ScssPhp\Value\ListSeparator</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> </div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"><p>All SassScript values can be used as lists. Maps count as lists of pairs,
|
|
and all other values count as single-value lists.</p>
|
|
</div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Value\ListSeparator</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_getUnitString"></a>
|
|
<div class="element clickable method public method_getUnitString" data-toggle="collapse" data-target=".method_getUnitString .collapse">
|
|
<h2>Returns a human-readable string representation of this number's units.</h2>
|
|
<pre>getUnitString() : string</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
string</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_getValue"></a>
|
|
<div class="element clickable method public method_getValue" data-toggle="collapse" data-target=".method_getValue .collapse">
|
|
<h2>The value of this number.</h2>
|
|
<pre>getValue() : float</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"><p>Note that due to details of floating-point arithmetic, this may be a
|
|
float even if $this represents an int from Sass's perspective. Use
|
|
{@see \ScssPhp\ScssPhp\Value\isInt} to determine whether this is an integer, {@see \ScssPhp\ScssPhp\Value\asInt} to get its
|
|
integer value, or {@see \ScssPhp\ScssPhp\Value\assertInt} to do both at once.</p>
|
|
</div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
float</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_greaterThan"></a>
|
|
<div class="element clickable method public method_greaterThan" data-toggle="collapse" data-target=".method_greaterThan .collapse">
|
|
<h2>greaterThan</h2>
|
|
<pre>greaterThan(\ScssPhp\ScssPhp\Value\Valueother) : \ScssPhp\ScssPhp\Value\SassBoolean</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>other</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Value\Value</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Value\SassBoolean</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_greaterThanOrEquals"></a>
|
|
<div class="element clickable method public method_greaterThanOrEquals" data-toggle="collapse" data-target=".method_greaterThanOrEquals .collapse">
|
|
<h2>greaterThanOrEquals</h2>
|
|
<pre>greaterThanOrEquals(\ScssPhp\ScssPhp\Value\Valueother) : \ScssPhp\ScssPhp\Value\SassBoolean</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>other</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Value\Value</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Value\SassBoolean</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_hasBrackets"></a>
|
|
<div class="element clickable method public method_hasBrackets inherited" data-toggle="collapse" data-target=".method_hasBrackets .collapse">
|
|
<h2>Whether this value as a list has brackets.</h2>
|
|
<pre>hasBrackets() : bool</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> </div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"><p>All SassScript values can be used as lists. Maps count as lists of pairs,
|
|
and all other values count as single-value lists.</p>
|
|
</div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
bool</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_hasCompatibleUnits"></a>
|
|
<div class="element clickable method public method_hasCompatibleUnits" data-toggle="collapse" data-target=".method_hasCompatibleUnits .collapse">
|
|
<h2>Returns whether $this has units that are compatible with $other.</h2>
|
|
<pre>hasCompatibleUnits(\ScssPhp\ScssPhp\Value\SassNumberother) : bool</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"><p>Unlike {@see \ScssPhp\ScssPhp\Value\isComparableTo}, unitless numbers are only considered compatible
|
|
with other unitless numbers.</p>
|
|
</div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>other</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Value\SassNumber</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
bool</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_hasUnit"></a>
|
|
<div class="element clickable method public method_hasUnit" data-toggle="collapse" data-target=".method_hasUnit .collapse">
|
|
<h2>Returns whether $this has $unit as its only unit (and as a numerator).</h2>
|
|
<pre>hasUnit(stringunit) : bool</pre>
|
|
<div class="labels">
|
|
<span class="label">abstract</span> </div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>unit</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
string</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
bool</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_hasUnits"></a>
|
|
<div class="element clickable method public method_hasUnits" data-toggle="collapse" data-target=".method_hasUnits .collapse">
|
|
<h2>Returns true if the number has units.</h2>
|
|
<pre>hasUnits() : bool</pre>
|
|
<div class="labels">
|
|
<span class="label">abstract</span> </div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
bool</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_isInt"></a>
|
|
<div class="element clickable method public method_isInt" data-toggle="collapse" data-target=".method_isInt .collapse">
|
|
<h2>Whether $this is an integer, according to {@see NumberUtil::fuzzyEquals}.</h2>
|
|
<pre>isInt() : bool</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"><p>The int value can be accessed using {@see \ScssPhp\ScssPhp\Value\asInt} or {@see \ScssPhp\ScssPhp\Value\assertInt}. Note that
|
|
this may return <code class="prettyprint">false</code> for very large doubles even though they may be
|
|
mathematically integers, because not all platforms have a valid
|
|
representation for integers that large.</p>
|
|
</div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
bool</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_isTruthy"></a>
|
|
<div class="element clickable method public method_isTruthy inherited" data-toggle="collapse" data-target=".method_isTruthy .collapse">
|
|
<h2>Whether the value counts as `true` in an `@if` statement and other contexts</h2>
|
|
<pre>isTruthy() : bool</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> </div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
bool</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_lessThan"></a>
|
|
<div class="element clickable method public method_lessThan" data-toggle="collapse" data-target=".method_lessThan .collapse">
|
|
<h2>lessThan</h2>
|
|
<pre>lessThan(\ScssPhp\ScssPhp\Value\Valueother) : \ScssPhp\ScssPhp\Value\SassBoolean</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>other</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Value\Value</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Value\SassBoolean</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_lessThanOrEquals"></a>
|
|
<div class="element clickable method public method_lessThanOrEquals" data-toggle="collapse" data-target=".method_lessThanOrEquals .collapse">
|
|
<h2>lessThanOrEquals</h2>
|
|
<pre>lessThanOrEquals(\ScssPhp\ScssPhp\Value\Valueother) : \ScssPhp\ScssPhp\Value\SassBoolean</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>other</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Value\Value</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Value\SassBoolean</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_minus"></a>
|
|
<div class="element clickable method public method_minus" data-toggle="collapse" data-target=".method_minus .collapse">
|
|
<h2>minus</h2>
|
|
<pre>minus(\ScssPhp\ScssPhp\Value\Valueother) : \ScssPhp\ScssPhp\Value\Value</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>other</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Value\Value</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Value\Value</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_modulo"></a>
|
|
<div class="element clickable method public method_modulo" data-toggle="collapse" data-target=".method_modulo .collapse">
|
|
<h2>modulo</h2>
|
|
<pre>modulo(\ScssPhp\ScssPhp\Value\Valueother) : \ScssPhp\ScssPhp\Value\SassNumber</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>other</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Value\Value</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Value\SassNumber</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_multiplyUnits"></a>
|
|
<div class="element clickable method protected method_multiplyUnits" data-toggle="collapse" data-target=".method_multiplyUnits .collapse">
|
|
<h2>multiplyUnits</h2>
|
|
<pre>multiplyUnits(floatvalue, list<string>otherNumerators, list<string>otherDenominators) : \ScssPhp\ScssPhp\Value\SassNumber</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>value</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
float</code><p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>otherNumerators</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
list<string></code><p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>otherDenominators</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
list<string></code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Value\SassNumber</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_plus"></a>
|
|
<div class="element clickable method public method_plus" data-toggle="collapse" data-target=".method_plus .collapse">
|
|
<h2>plus</h2>
|
|
<pre>plus(\ScssPhp\ScssPhp\Value\Valueother) : \ScssPhp\ScssPhp\Value\Value</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>other</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Value\Value</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Value\Value</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_sassIndexToListIndex"></a>
|
|
<div class="element clickable method public method_sassIndexToListIndex inherited" data-toggle="collapse" data-target=".method_sassIndexToListIndex .collapse">
|
|
<h2>Converts $sassIndex into a PHP-style index into the list returned by
|
|
{@see asList}.</h2>
|
|
<pre>sassIndexToListIndex(\ScssPhp\ScssPhp\Value\ValuesassIndex, ?stringname = null) : int</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> </div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"><p>Sass indexes are one-based, while PHP indexes are zero-based. Sass
|
|
indexes may also be negative in order to index from the end of the list.</p>
|
|
</div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>Throws</th>
|
|
<td>
|
|
<dl>
|
|
<dt>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Exception\SassScriptException</dt>
|
|
<dd><p>if $sassIndex isn't a number, if that
|
|
number isn't an integer, or if that integer isn't a valid index for
|
|
{@see \ScssPhp\ScssPhp\Value\asList}. If $sassIndex came from a function argument, $name is the
|
|
argument name (without the <code class="prettyprint">$</code>). It's used for error reporting.</p>
|
|
</dd>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>sassIndex</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Value\Value</code><p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>name</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
?string</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
int</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_selectorString"></a>
|
|
<div class="element clickable method private method_selectorString inherited" data-toggle="collapse" data-target=".method_selectorString .collapse">
|
|
<h2>Converts a `selector-parse()`-style input into a string that can be
|
|
parsed.</h2>
|
|
<pre>selectorString(?stringname) : string</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> </div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>Throws</th>
|
|
<td>
|
|
<dl>
|
|
<dt>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Exception\SassScriptException</dt>
|
|
<dd><p>if $this isn't a type or a structure that
|
|
can be parsed as a selector.</p>
|
|
</dd>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>name</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
?string</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
string</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_selectorStringOrNull"></a>
|
|
<div class="element clickable method private method_selectorStringOrNull inherited" data-toggle="collapse" data-target=".method_selectorStringOrNull .collapse">
|
|
<h2>Converts a `selector-parse()`-style input into a string that can be
|
|
parsed.</h2>
|
|
<pre>selectorStringOrNull() : ?string</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> </div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"><p>Returns <code class="prettyprint">null</code> if $this isn't a type or a structure that can be parsed as
|
|
a selector.</p>
|
|
</div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
?string</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_times"></a>
|
|
<div class="element clickable method public method_times" data-toggle="collapse" data-target=".method_times .collapse">
|
|
<h2>times</h2>
|
|
<pre>times(\ScssPhp\ScssPhp\Value\Valueother) : \ScssPhp\ScssPhp\Value\Value</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>other</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Value\Value</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Value\Value</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_toCssString"></a>
|
|
<div class="element clickable method public method_toCssString inherited" data-toggle="collapse" data-target=".method_toCssString .collapse">
|
|
<h2>Returns a valid CSS representation of $this.</h2>
|
|
<pre>toCssString(boolquote = true) : string</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> <span class="label">final</span> </div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"><p>Use {@see \ScssPhp\ScssPhp\Value\toString} instead to get a string representation even if this
|
|
isn't valid CSS.</p>
|
|
<p>Internal-only: If $quote is <code class="prettyprint">false</code>, quoted strings are emitted without
|
|
quotes.</p>
|
|
</div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>Throws</th>
|
|
<td>
|
|
<dl>
|
|
<dt>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Exception\SassScriptException</dt>
|
|
<dd><p>if $this cannot be represented in plain CSS.</p>
|
|
</dd>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>quote</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
bool</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
string</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_tryMap"></a>
|
|
<div class="element clickable method public method_tryMap inherited" data-toggle="collapse" data-target=".method_tryMap .collapse">
|
|
<h2>Return $this as a SassMap if it is one (including empty lists) or null otherwise.</h2>
|
|
<pre>tryMap() : ?\ScssPhp\ScssPhp\Value\SassMap</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> </div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
?\ScssPhp\ScssPhp\Value\SassMap</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_unaryPlus"></a>
|
|
<div class="element clickable method public method_unaryPlus" data-toggle="collapse" data-target=".method_unaryPlus .collapse">
|
|
<h2>unaryPlus</h2>
|
|
<pre>unaryPlus() : \ScssPhp\ScssPhp\Value\Value</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Value\Value</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_valueInRange"></a>
|
|
<div class="element clickable method public method_valueInRange" data-toggle="collapse" data-target=".method_valueInRange .collapse">
|
|
<h2>If {@see value} is between $min and $max, returns it.</h2>
|
|
<pre>valueInRange(floatmin, floatmax, ?stringname = null) : float</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"><p>If {@see \ScssPhp\ScssPhp\Value\value} is {@see \ScssPhp\ScssPhp\Util\NumberUtil::fuzzyEquals} to $min or $max, it's clamped to the
|
|
appropriate value. Otherwise, this throws a {@see \ScssPhp\ScssPhp\Exception\SassScriptException}. If this
|
|
came from a function argument, $name is the argument name (without the
|
|
<code class="prettyprint">$</code>). It's used for error reporting.</p>
|
|
</div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>Throws</th>
|
|
<td>
|
|
<dl>
|
|
<dt>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Exception\SassScriptException</dt>
|
|
<dd><p>if the value is outside the range</p>
|
|
</dd>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>min</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
float</code><p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>max</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
float</code><p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>name</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
?string</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
float</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_withListContents"></a>
|
|
<div class="element clickable method public method_withListContents inherited" data-toggle="collapse" data-target=".method_withListContents .collapse">
|
|
<h2>Returns a new list containing $contents that defaults to this value's
|
|
separator and brackets.</h2>
|
|
<pre>withListContents(list<\ScssPhp\ScssPhp\Value\Value>contents, ?\ScssPhp\ScssPhp\Value\ListSeparatorseparator = null, ?boolbrackets = null) : \ScssPhp\ScssPhp\Value\SassList</pre>
|
|
<div class="labels">
|
|
<span class="label">inherited</span> </div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>contents</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
list<\ScssPhp\ScssPhp\Value\Value></code><p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>separator</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
?\ScssPhp\ScssPhp\Value\ListSeparator</code><p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>brackets</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
?bool</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Value\SassList</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_withoutSlash"></a>
|
|
<div class="element clickable method public method_withoutSlash" data-toggle="collapse" data-target=".method_withoutSlash .collapse">
|
|
<h2>withoutSlash</h2>
|
|
<pre>withoutSlash() : \ScssPhp\ScssPhp\Value\SassNumber</pre>
|
|
<div class="labels">
|
|
</div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Value\SassNumber</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_withUnits"></a>
|
|
<div class="element clickable method public method_withUnits" data-toggle="collapse" data-target=".method_withUnits .collapse">
|
|
<h2>Creates a number with full $numeratorUnits and $denominatorUnits.</h2>
|
|
<pre>withUnits(floatvalue, list<string>numeratorUnits = [], list<string>denominatorUnits = []) : \ScssPhp\ScssPhp\Value\SassNumber</pre>
|
|
<div class="labels">
|
|
<span class="label">static</span> <span class="label">final</span> </div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>value</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
float</code><p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>numeratorUnits</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
list<string></code><p></p>
|
|
</div>
|
|
<div class="subelement argument">
|
|
<h4>denominatorUnits</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
list<string></code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Value\SassNumber</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<a id="method_withValue"></a>
|
|
<div class="element clickable method protected method_withValue" data-toggle="collapse" data-target=".method_withValue .collapse">
|
|
<h2>Returns a SassNumber with this value and the same units.</h2>
|
|
<pre>withValue(floatvalue) : \ScssPhp\ScssPhp\Value\SassNumber</pre>
|
|
<div class="labels">
|
|
<span class="label">abstract</span> </div>
|
|
|
|
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Arguments</h3>
|
|
<div class="subelement argument">
|
|
<h4>value</h4>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
float</code><p></p>
|
|
</div>
|
|
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
<h3>Response</h3>
|
|
<code>
|
|
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
|
|
\ScssPhp\ScssPhp\Value\SassNumber</code><p></p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<h3><i class="icon-custom icon-constant"></i> Constants</h3>
|
|
<a id="constant_PRECISION"> </a>
|
|
<div class="element clickable constant constant_PRECISION" data-toggle="collapse" data-target=".constant_PRECISION .collapse">
|
|
<h2>PRECISION</h2>
|
|
<pre>PRECISION</pre>
|
|
<div class="labels">
|
|
</div>
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a id="constant_CONVERSIONS"> </a>
|
|
<div class="element clickable constant constant_CONVERSIONS" data-toggle="collapse" data-target=".constant_CONVERSIONS .collapse">
|
|
<h2>CONVERSIONS</h2>
|
|
<pre>CONVERSIONS</pre>
|
|
<div class="labels">
|
|
</div>
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
see
|
|
</th>
|
|
<td>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a id="constant_UNITS_BY_TYPE"> </a>
|
|
<div class="element clickable constant constant_UNITS_BY_TYPE" data-toggle="collapse" data-target=".constant_UNITS_BY_TYPE .collapse">
|
|
<h2>A map from human-readable names of unit types to the convertible units that
|
|
fall into those types.</h2>
|
|
<pre>UNITS_BY_TYPE</pre>
|
|
<div class="labels">
|
|
</div>
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a id="constant_TYPES_BY_UNIT"> </a>
|
|
<div class="element clickable constant constant_TYPES_BY_UNIT" data-toggle="collapse" data-target=".constant_TYPES_BY_UNIT .collapse">
|
|
<h2>A map from units to the human-readable names of those unit types.</h2>
|
|
<pre>TYPES_BY_UNIT</pre>
|
|
<div class="labels">
|
|
</div>
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<h3><i class="icon-custom icon-property"></i> Properties</h3>
|
|
<a id="property_value"> </a>
|
|
<div class="element clickable property private property_value" data-toggle="collapse" data-target=".property_value .collapse">
|
|
<h2>value</h2>
|
|
<pre>value : float</pre>
|
|
<div class="labels">
|
|
</div>
|
|
<div class="row collapse">
|
|
<div class="detail-description">
|
|
<div class="long_description"></div>
|
|
|
|
<table class="table">
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<th>
|
|
|
|
</th>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Type(s)</h3>
|
|
<code>float</code>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a id="\ScssPhp\ScssPhp\Value\SassNumber"></a>
|
|
<ul class="breadcrumb">
|
|
<li><a href="index.html"><i class="icon-custom icon-class"></i></a></li>
|
|
|
|
|
|
<li><span class="divider">\</span><a href="\ScssPhp\ScssPhp\Value">Value</a></li>
|
|
|
|
<li class="active"><span class="divider">\</span><a href="\ScssPhp\ScssPhp\Value\SassNumber">SassNumber</a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<footer class="span12">
|
|
Template is built using <a href="https://getbootstrap.com/">Twitter Bootstrap 2</a> and icons provided by
|
|
<a href="https://glyphicons.com/">Glyphicons</a>.<br/>
|
|
Documentation is powered by <a href="https://www.phpdoc.org/">phpDocumentor </a> and<br/>
|
|
generated on Thu, 21 Nov 2024 01:33:24 +0000.<br/>
|
|
</footer>
|
|
</body>
|
|
</html>
|