A SassScript string.
Strings can either be quoted or unquoted. Unquoted strings are usually CSS identifiers, but they may contain any text.
| package |
Application |
|---|
__construct(stringtext, boolquotes = true) : mixed
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
bool
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
mixed
__toString() : string
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
string
accept(\ScssPhp\ScssPhp\Visitor\ValueVisitorvisitor) : mixed
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
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
mixed
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
list<\ScssPhp\ScssPhp\Value\Value>
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
?string
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
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
?string
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
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
?string
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
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
?string
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
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
?string
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
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
?string
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
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.
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
\ScssPhp\ScssPhp\Value\SassString
equals(objectother) : bool
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
object
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
bool
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
int
getSassLength() : int
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
int
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
\ScssPhp\ScssPhp\Value\ListSeparator
getText() : string
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
string
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
bool
hasQuotes() : bool
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
bool
isBlank() : bool
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
bool
isSpecialNumber() : bool
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
bool
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
bool
isVar() : bool
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
bool
plus(\ScssPhp\ScssPhp\Value\Valueother) : \ScssPhp\ScssPhp\Value\Value
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
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
sassIndexToCodePointIndex(\ScssPhp\ScssPhp\Value\ValuesassIndex, ?stringname = null) : int
This index is suitable to use with functions dealing with codepoints (i.e. the mbstring functions).
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 string.
See also {@see \ScssPhp\ScssPhp\Value\sassIndexToStringIndex}, which is an index into {@see \ScssPhp\ScssPhp\Value\getText} directly.
| 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\Value\Value
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
int
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\Value\Value
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
int
sassIndexToStringIndex(\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 string.
In addition, Sass indices refer to Unicode code points while PHP string
indices refer to bytes. For example, the character U+1F60A,
Smiling Face With Smiling Eyes, is a single Unicode code point but is
represented in UTF-8 as several bytes (0xF0, 0x9F, 0x98 and 0x8A). So in
PHP, substr("a😊b", 1, 1) returns "\xF0", whereas in Sass
str-slice("a😊b", 1, 1) returns "😊".
| 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\Value\Value
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
int
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
?string
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
string
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
?string
toCssString(boolquote = true) : string
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
bool
Deprecated: Please use getType in phar:///app/lib/system/lib/phpdocumentor/lib/phpDocumentor.phar/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
string
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
?\ScssPhp\ScssPhp\Value\SassMap
withListContents(list<\ScssPhp\ScssPhp\Value\Value>contents, ?\ScssPhp\ScssPhp\Value\ListSeparatorseparator = null, ?boolbrackets = null) : \ScssPhp\ScssPhp\Value\SassList
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>
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
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
\ScssPhp\ScssPhp\Value\SassList
text : string
For quoted strings, this is the semantic content—any escape sequences that were been written in the source text are resolved to their Unicode values. For unquoted strings, though, escape sequences are preserved as literal backslashes.
This difference allows us to distinguish between identifiers with escapes,
such as url\u28 http://example.com\u29, and unquoted strings that
contain characters that aren't valid in identifiers, such as
url(http://example.com). Unfortunately, it also means that we don't
consider foo and f\6F\6F the same string.
string
quotes : bool
bool