SYSTEM - PHP Framework
Back to top  

Value

Implements Equatable, Stringable

A SassScript value.

All SassScript values are unmodifiable. New values can be constructed using subclass constructors like new SassString. Untyped values can be cast to particular types using assert*() functions like {@see \ScssPhp\ScssPhp\Value\assertString}, which throw user-friendly error messages if they fail.

package

Application

Methods

Returns a Sass representation of $this.

__toString() : string
final

Note that this is equivalent to calling inspect() 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.

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

Response

Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50 string

This value as a list.

asList() : list<\ScssPhp\ScssPhp\Value\Value>

All SassScript values can be used as lists. Maps count as lists of pairs, and all other values count as single-value lists.

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

Response

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>

Throws a {@see SassScriptException} if $this isn't a boolean.

assertBoolean(?stringname = null) : \ScssPhp\ScssPhp\Value\SassBoolean

Note that generally, functions should use {@see \ScssPhp\ScssPhp\Value\isTruthy} rather than requiring a literal boolean.

If this came from a function argument, $name is the argument name (without the $). It's used for error reporting.

Throws
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

Arguments

name

Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50 ?string

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

Response

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

Throws a {@see SassScriptException} if $this isn't a calculation.

assertCalculation(?stringname = null) : \ScssPhp\ScssPhp\Value\SassCalculation

If this came from a function argument, $name is the argument name (without the $). It's used for error reporting.

Throws
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

Arguments

name

Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50 ?string

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

Response

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

Throws a {@see SassScriptException} if $this isn't a color.

assertColor(?stringname = null) : \ScssPhp\ScssPhp\Value\SassColor

If this came from a function argument, $name is the argument name (without the $). It's used for error reporting.

Throws
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

Arguments

name

Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50 ?string

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

Response

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

Throws a {@see SassScriptException} if $this isn't a string.

assertFunction(?stringname = null) : \ScssPhp\ScssPhp\Value\SassFunction

If this came from a function argument, $name is the argument name (without the $). It's used for error reporting.

Throws
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

Arguments

name

Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50 ?string

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

Response

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

Throws a {@see SassScriptException} if $this isn't a map.

assertMap(?stringname = null) : \ScssPhp\ScssPhp\Value\SassMap

If this came from a function argument, $name is the argument name (without the $). It's used for error reporting.

Throws
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

Arguments

name

Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50 ?string

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

Response

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

Throws a {@see SassScriptException} if $this isn't a number.

assertNumber(?stringname = null) : \ScssPhp\ScssPhp\Value\SassNumber

If this came from a function argument, $name is the argument name (without the $). It's used for error reporting.

Throws
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

Arguments

name

Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50 ?string

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

Response

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

Throws a {@see SassScriptException} if $this isn't a string.

assertString(?stringname = null) : \ScssPhp\ScssPhp\Value\SassString

If this came from a function argument, $name is the argument name (without the $). It's used for error reporting.

Throws
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

Arguments

name

Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50 ?string

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

Response

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

The length of {@see asList}.

getLengthAsList() : int

This is used to compute {@see \ScssPhp\ScssPhp\Value\sassIndexToListIndex} without allocating a new list.

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

Response

Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50 int

The separator for this value as a list.

getSeparator() : \ScssPhp\ScssPhp\Value\ListSeparator

All SassScript values can be used as lists. Maps count as lists of pairs, and all other values count as single-value lists.

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

Response

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

Whether this value as a list has brackets.

hasBrackets() : bool

All SassScript values can be used as lists. Maps count as lists of pairs, and all other values count as single-value lists.

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

Response

Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50 bool

Whether the value counts as `true` in an `@if` statement and other contexts

isTruthy() : bool
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

Response

Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50 bool

Converts $sassIndex into a PHP-style index into the list returned by {@see asList}.

sassIndexToListIndex(\ScssPhp\ScssPhp\Value\ValuesassIndex, ?stringname = null) : int

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.

Throws
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

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 $). It's used for error reporting.

Arguments

sassIndex

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

name

Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50 ?string

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

Response

Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50 int

Converts a `selector-parse()`-style input into a string that can be parsed.

selectorString(?stringname) : string
Throws
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

if $this isn't a type or a structure that can be parsed as a selector.

Arguments

name

Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50 ?string

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

Response

Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50 string

Converts a `selector-parse()`-style input into a string that can be parsed.

selectorStringOrNull() : ?string

Returns null if $this isn't a type or a structure that can be parsed as a selector.

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

Response

Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50 ?string

Returns a valid CSS representation of $this.

toCssString(boolquote = true) : string
final

Use {@see \ScssPhp\ScssPhp\Value\toString} instead to get a string representation even if this isn't valid CSS.

Internal-only: If $quote is false, quoted strings are emitted without quotes.

Throws
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

if $this cannot be represented in plain CSS.

Arguments

quote

Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50 bool

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

Response

Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50 string

Return $this as a SassMap if it is one (including empty lists) or null otherwise.

tryMap() : ?\ScssPhp\ScssPhp\Value\SassMap
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

Response

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

Returns a new list containing $contents that defaults to this value's separator and brackets.

withListContents(list<\ScssPhp\ScssPhp\Value\Value>contents, ?\ScssPhp\ScssPhp\Value\ListSeparatorseparator = null, ?boolbrackets = null) : \ScssPhp\ScssPhp\Value\SassList

Arguments

contents

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>

separator

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

brackets

Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50 ?bool

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

Response

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