General

functions

_ss-char-at

Since 1.2.0 - undefined
@function _ss-char-at($string, $index) { ... }
View source

Description

Return character from $string at $index.

Parameters

parameter Name parameter Description parameter Type parameter Default value
$string

string to check

String none
$index

index to inspect

String none

Returns

String

_ss-levenshtein

Since 1.2.0 - undefined
@function _ss-levenshtein($a, $b) { ... }
View source

Description

Calculating Levenshtein distance between strings $a and $b.

Parameters

parameter Name parameter Description parameter Type parameter Default value
$a

first string

String none
$b

second string

String none

Returns

Number

_ss-str-count

Since 1.2.0 - undefined
@function _ss-str-count($string, $needle) { ... }
View source

Description

Count the number of occurrences of $needle in $string.

Parameters

parameter Name parameter Description parameter Type parameter Default value
$string

string

String none
$needle

substring to count in $string

String none

Returns

Number

_ss-str-ends-with

Since 1.2.0 - undefined
@function _ss-str-ends-with($string, $needle) { ... }
View source

Description

Check whether $string ends with $needle.

Parameters

parameter Name parameter Description parameter Type parameter Default value
$string

string to check

String none
$needle

substring to check

String none

Returns

Bool

_ss-str-explode

Since 1.2.0 - undefined
@function _ss-str-explode($string, $delimiter: '') { ... }
View source

Description

Split $string into several parts using $delimiter.

Parameters

parameter Name parameter Description parameter Type parameter Default value
$string

string to split

String none
$delimiter

string to use as a delimiter to split $string

String ''

Returns

List

_ss-str-implode

Since 1.2.0 - undefined
@function _ss-str-implode($list) { ... }
View source

Description

Implode $list into a string.

Parameters

parameter Name parameter Description parameter Type parameter Default value
$list

list to convert to string

List none

Returns

String

_ss-str-last-index

Since 1.2.0 - undefined
@function _ss-str-last-index($string, $needle) { ... }
View source

Description

Return last index of $needle in $string.

Parameters

parameter Name parameter Description parameter Type parameter Default value
$string

string to search in

String none
$needle

substring to search for

String none

Returns

Number

_ss-str-lcfirst

Since 1.2.0 - undefined
@function _ss-str-lcfirst($string) { ... }
View source

Description

Lower case first character of $string.

Parameters

parameter Name parameter Description parameter Type parameter Default value
$string

string to lower the first character

String none

Returns

String

_ss-str-pad

Since 1.2.0 - undefined
@function _ss-str-pad($string, $length, $pad: " ", $direction: left) { ... }
View source

Description

Pad $string from $direction with $pad to reach $length characters.

Parameters

parameter Name parameter Description parameter Type parameter Default value
$string

string to pad

String none
$length

number of characters to go for in returned string

Number none
$pad

string to use to pad $string

String " "
$direction

direction left or right for padding

String left

Returns

String

_ss-str-printf

Since 1.2.0 - undefined
@function _ss-str-printf($string, $elements...) { ... }
View source

Description

Replace occurrences of %s in $string by $elements.

Parameters

parameter Name parameter Description parameter Type parameter Default value
$string

string to check

String none
$elements

strings to use for replacements in %s

Arglist none

Returns

String

Requires

_ss-str-repeat

Since 1.2.0 - undefined
@function _ss-str-repeat($string, $times) { ... }
View source

Description

Repeat $string $times times.

Parameters

parameter Name parameter Description parameter Type parameter Default value
$string

string to repeat

String none
$times

number of times to repeat $string

Number none

Returns

String

_ss-str-replace

Since 1.2.0 - undefined
@function _ss-str-replace($string, $search, $replace: "") { ... }
View source

Description

Replace $search with $replace in $string.

Parameters

parameter Name parameter Description parameter Type parameter Default value
$string

Initial string

String none
$search

Substring to replace

String none
$replace

New value

String ""

Returns

Updated string

String

Requires

Used by

_ss-str-reverse

Since 1.2.0 - undefined
@function _ss-str-reverse($string) { ... }
View source

Description

Reverse $string.

Parameters

parameter Name parameter Description parameter Type parameter Default value
$string

string to reverse

String none

Returns

String

_ss-str-rot

Since 1.2.0 - undefined
@function _ss-str-rot($string, $rot: 13) { ... }
View source

Description

Rotate all characters from the alphabet in $string by $rot positions.

Parameters

parameter Name parameter Description parameter Type parameter Default value
$string

string to rotate

String none
$rot

number of positions to switch in alphabet

Number 13

Returns

String

_ss-str-shuffle

Since 1.2.0 - undefined
@function _ss-str-shuffle($string) { ... }
View source

Description

Shuffle characters from $string.

Parameters

parameter Name parameter Description parameter Type parameter Default value
$string

string to shuffle

String none

Returns

String

_ss-str-starts-with

Since 1.2.0 - undefined
@function _ss-str-starts-with($string, $needle) { ... }
View source

Description

Check whether $string stars with $needle.

Parameters

parameter Name parameter Description parameter Type parameter Default value
$string

string to check

String none
$needle

substring to check

String none

Returns

Bool

_ss-str-trim

Since 1.2.0 - undefined
@function _ss-str-trim($string) { ... }
View source

Description

Remove all trailing and leading whitespaces from $string.

Parameters

parameter Name parameter Description parameter Type parameter Default value
$string

string

String none

Returns

String

_ss-str-ucfirst

Since 1.2.0 - undefined
@function _ss-str-ucfirst($string) { ... }
View source

Description

Capitalize first letter from $string.

Parameters

parameter Name parameter Description parameter Type parameter Default value
$string

string for capitalization

String none

Returns

String

_ss-str-word-count

Since 1.2.0 - undefined
@function _ss-str-word-count($string) { ... }
View source

Description

Count number of words in $string.

Parameters

parameter Name parameter Description parameter Type parameter Default value
$string

string to check

String none

Returns

String

_ss-stringify

Since 1.2.0 - undefined
@function _ss-stringify($literal) { ... }
View source

Description

Cast $literal to string.

Parameters

parameter Name parameter Description parameter Type parameter Default value
$literal

number to cast to string

Any none

Returns

String

Used by