- string\concatenate
- string\substring
- string\contains
- string\pos
- string\test
- string\length
- string\trim
- string\lowerCase
- string\upperCase
- string\pad
- string\match
- string\matchAll
- string\matchExtract
- string\replace
- string\split
string\concatenate(STRING_1, STRING_2)
Concatenates two or more strings.
!!! example
```
$someVariable = string\concatenate('ab', 'cd'); // will return 'abcd'
```
string\substring(STRING, START, LENGTH)
Extracts the characters from a STRING by START position and LENGTH.
If LENGTH is omitted, the substring starting from START until the end of the STRING will be returned.
If LENGTH is negative, then that many characters will be omitted from the end of STRING.
!!! example
```
$someVariable = string\substring('abcde', 1, 2); // will return 'bc'
$someVariable = string\substring('abcde', 1, -1); // will return 'bcd'
```
string\contains(STRING, NEEDLE)
Whether STRING contains NEEDLE.
!!! example
```
string\contains('hello world', 'world') // will return true
```
string\pos(STRING, NEEDLE)
Returns position of NEEDLE in STRING, false if not found.
!!! example
```
string\pos('hello world', 'world') // will return `6`
```
string\test(STRING, REGULAR_EXPRESSION)
Search a match between REGULAR_EXPRESSION and STRING. Returns TRUE of FALSE.
!!! example
```
string\test('hello world', '/hello/i') // will return TRUE
```
string\length(STRING)
The length of STRING.
!!! example
```
string\length('hello world') // will return `11`
```
string\trim(STRING)
Strips whitespace from the beginning and end of STRING.
!!! example
```
string\trim(' hello world ') // will return `hello world`
```
string\lowerCase(STRING)
Converts letters to lower case.
!!! example
```
string\lowerCase('HELLO world') // will return `hello world`
```
string\upperCase(STRING)
Converts letters to upper case.
!!! example
```
string\upperCase('HELLO world') // will return `HELLO WORLD`
```
string\pad(STRING, LENGTH, [PAD_STRING], [PAD_TYPE])
Pads STRING to a certain LENGTH with PAD_STRING.
PAD_STRING by default is a whitespace string ' '.
PAD_TYPE can be 'right', 'left', 'both'. By default it is 'right'.
!!! example
```
string\pad('100', 5, '*', 'right') // will return `100**`
```
string\match(STRING, REGULAR_EXPRESSION, [OFFSET])
Retrieves the first result of matching a STRING against a REGULAR_EXPRESSION. Returns NULL if no matches are found.
!!! example
```
string\match('{token1} foo {token2} bar', '/{[^}]*}/')
```
Will return `{token1}`.
The slash character / defines the start and the end of a REGULAR_EXPRESSION.
string\matchAll(STRING, REGULAR_EXPRESSION, [OFFSET])
Retrieves all results of matching a STRING against a REGULAR_EXPRESSION. Returns NULL if no matches are found.
!!! example
```
string\matchAll('{token1} foo {token2} bar', '/{[^}]*}/')
```
Will return an array `['{token1}', '{token2}']`.
string\matchExtract(STRING, REGULAR_EXPRESSION)
As of v7.4.
Returns an array of substrings that match parenthesized sub-patterns. Returns NULL if no matches are found.
!!! example
```
string\matchExtract('values: 1000 2000', '/values\: (.*) (.*)$/')
```
Will return `['1000', '2000']`.
The slash character / defines the start and the end of a REGULAR_EXPRESSION.
string\replace(STRING, SEARCH, REPLACE)
Replaces all occurrences of SEARCH with REPLACE in STRING.
!!! example
```
string\replace('Hello {test}', '{test}', 'world')
```
Will return `'Hello world'`.
!!! note
The REPLACE parameter must be a string. Use [number\format](number.md#numberformat) function to cast an integer or a float to a string.
string\split(STRING, SEPARATOR)
Splits a STRING into array of strings by a string SEPARATOR. (as of v7.1)
!!! example
```
string\split('hello world', ' ') // will return ['hello', 'world']
```