StringFunction
Table of Contents
Methods
- collate() : Collate
- Construct a COLLATE call expression on a string expression
- collateAi() : Collate
- Construct a COLLATE call expression on a string expression with accent-insensitive collation and case-sensitive collation
- collateCi() : Collate
- Construct a COLLATE call expression on a string expression with case-insensitive collation and accent-insensitive collation
- collateCiAi() : Collate
- Construct a COLLATE call expression on a string expression with case-insensitive and accent-insensitive collation
- collateCsAs() : Collate
- Construct a COLLATE call expression on a string expression with case-sensitive and accent-sensitive collation
- collateMatch() : CollateMatch
- Construct a COLLATE call expression on a string expression
- collateMatchAi() : CollateMatch
- Construct a COLLATE call expression on a string expression with accent-insensitive collation and case-sensitive collation
- collateMatchCi() : CollateMatch
- Construct a COLLATE call expression on a string expression with case-insensitive collation and accent-insensitive collation
- collateMatchCiAi() : CollateMatch
- Construct a COLLATE call expression on a string expression with case-insensitive and accent-insensitive collation
- collateMatchCsAs() : CollateMatch
- Construct a COLLATE call expression on a string expression with case-sensitive and accent-sensitive collation
- collation() : Collate
- Construct a COLLATE call expression on a string expression
- concat() : ConcatOperator
- Concatenate two string expressions
- groupConcat() : GroupConcatFunction
- Construct a GROUP_CONCAT call expression on a string expression
- length() : LengthOperator
- Construct a length call expression on a string expression
- locate() : Locate
- Construct a LOCATE call expression on a string expression
- lower() : Lower
- Construct a LOWER call expression on a string expression
- match() : MatchOperator
- Construct a boolean 'like' expression
- notMatch() : NotMatchOperator
- Construct a boolean 'not like' expression
- present() : BooleanOr
- Construct an expression that will evaluate if a string expression is not null or its length is greater than 0
- regexpInstr() : RegexInstrFunction
- Construct a REGEXP_INSTR call expression on a string expression
- regexpMatch() : RegexMatchOperator
- Construct a boolean REGEXP expression
- regexpReplace() : RegexReplaceFunction
- Construct a REGEXP_REPLACE call expression on a string expression
- regexpSubStr() : RegexSubStrFunction
- Construct a REGEXP_SUBSTR call expression on a string expression
- replace() : mixed
- Construct a REPLACE call expression on a string expression
- substring() : Substring
- Construct a SUBSTRING call expression on a string expression
- trim() : Trim
- Construct a TRIM call expression on a string expression
- upper() : Upper
- Construct an UPPER call expression on a string expression
Methods
collate()
Construct a COLLATE call expression on a string expression
public
collate(mixed $ci, mixed $ai[, mixed $charset = "" ]) : Collate
Parameters
- $ci : mixed
-
bool case-insensitive
- $ai : mixed
-
bool accent insensitive
- $charset : mixed = ""
-
string (optional) charset to use
Return values
Collate —a new Collate
collateAi()
Construct a COLLATE call expression on a string expression with accent-insensitive collation and case-sensitive collation
public
collateAi([mixed $charset = "" ]) : Collate
Parameters
- $charset : mixed = ""
-
string (optional) charset to use
Return values
Collate —a new Collate
collateCi()
Construct a COLLATE call expression on a string expression with case-insensitive collation and accent-insensitive collation
public
collateCi([mixed $charset = "" ]) : Collate
Parameters
- $charset : mixed = ""
-
string (optional) charset to use
Return values
Collate —a new Collate
collateCiAi()
Construct a COLLATE call expression on a string expression with case-insensitive and accent-insensitive collation
public
collateCiAi([mixed $charset = "" ]) : Collate
Parameters
- $charset : mixed = ""
-
string (optional) charset to use
Return values
Collate —a new Collate
collateCsAs()
Construct a COLLATE call expression on a string expression with case-sensitive and accent-sensitive collation
public
collateCsAs([mixed $charset = "" ]) : Collate
Parameters
- $charset : mixed = ""
-
string (optional) charset to use
Return values
Collate —a new Collate
collateMatch()
Construct a COLLATE call expression on a string expression
public
collateMatch(mixed $other, mixed $ci, mixed $ai[, mixed $charset = "" ]) : CollateMatch
Parameters
- $other : mixed
-
mixed expression to compare with
- $ci : mixed
-
bool case-insensitive
- $ai : mixed
-
bool accent insensitive
- $charset : mixed = ""
-
string (optional) charset to use
Return values
CollateMatch —a new CollateMatch
collateMatchAi()
Construct a COLLATE call expression on a string expression with accent-insensitive collation and case-sensitive collation
public
collateMatchAi(mixed $other[, mixed $charset = "" ]) : CollateMatch
Parameters
- $other : mixed
-
mixed expression to compare with
- $charset : mixed = ""
-
string (optional) charset to use
Return values
CollateMatch —a new CollateMatch
collateMatchCi()
Construct a COLLATE call expression on a string expression with case-insensitive collation and accent-insensitive collation
public
collateMatchCi(mixed $other[, mixed $charset = "" ]) : CollateMatch
Parameters
- $other : mixed
-
mixed expression to compare with
- $charset : mixed = ""
-
string (optional) charset to use
Return values
CollateMatch —a new CollateMatch
collateMatchCiAi()
Construct a COLLATE call expression on a string expression with case-insensitive and accent-insensitive collation
public
collateMatchCiAi(mixed $other[, mixed $charset = "" ]) : CollateMatch
Parameters
- $other : mixed
-
mixed expression to compare with
- $charset : mixed = ""
-
string (optional) charset to use
Return values
CollateMatch —a new CollateMatch
collateMatchCsAs()
Construct a COLLATE call expression on a string expression with case-sensitive and accent-sensitive collation
public
collateMatchCsAs(mixed $other[, mixed $charset = "" ]) : CollateMatch
Parameters
- $other : mixed
-
mixed expression to compare with
- $charset : mixed = ""
-
string (optional) charset to use
Return values
CollateMatch —a new CollateMatch
collation()
Construct a COLLATE call expression on a string expression
public
collation(mixed $collation) : Collate
Parameters
- $collation : mixed
-
string (optional) collation to use
Return values
Collate —a new Collate
concat()
Concatenate two string expressions
public
concat(mixed $other) : ConcatOperator
Parameters
- $other : mixed
-
mixed expression to concatenate with
Return values
ConcatOperator —a new ConcatOperator
groupConcat()
Construct a GROUP_CONCAT call expression on a string expression
public
groupConcat([mixed $separator = ', ' ][, mixed $groups = NULL ][, mixed $orders = NULL ]) : GroupConcatFunction
Parameters
- $separator : mixed = ', '
-
string separator to use
- $groups : mixed = NULL
-
array groups to concatenate
- $orders : mixed = NULL
-
array orders to use
Return values
GroupConcatFunction —a new GroupConcatFunction
length()
Construct a length call expression on a string expression
public
length() : LengthOperator
Return values
LengthOperator —a new LengthOperator
locate()
Construct a LOCATE call expression on a string expression
public
locate(mixed $substring[, mixed $start = 1 ]) : Locate
Parameters
- $substring : mixed
-
mixed substring to locate
- $start : mixed = 1
-
int start position
Return values
Locate —a new Locate
lower()
Construct a LOWER call expression on a string expression
public
lower() : Lower
Return values
Lower —a new Lower
match()
Construct a boolean 'like' expression
public
match(mixed $other) : MatchOperator
Parameters
- $other : mixed
-
mixed expression to compare with
Return values
MatchOperator —a new MatchOperator
notMatch()
Construct a boolean 'not like' expression
public
notMatch(mixed $other) : NotMatchOperator
Parameters
- $other : mixed
-
mixed expression to compare with
Return values
NotMatchOperator —a new NotMatchOperator
present()
Construct an expression that will evaluate if a string expression is not null or its length is greater than 0
public
present() : BooleanOr
Return values
BooleanOr —a new BooleanOr
regexpInstr()
Construct a REGEXP_INSTR call expression on a string expression
public
regexpInstr(mixed $pattern[, mixed $start = 1 ][, mixed $occurrence = 1 ][, mixed $return = 0 ][, mixed $flags = 'c' ]) : RegexInstrFunction
Parameters
- $pattern : mixed
-
string pattern to search
- $start : mixed = 1
-
int start position (default 1)
- $occurrence : mixed = 1
-
int occurrence to replace (default 1)
- $return : mixed = 0
-
int return option (default 0)
- $flags : mixed = 'c'
-
string flags to use (default 'c')
Return values
RegexInstrFunction —a new RegexInstrFunction
regexpMatch()
Construct a boolean REGEXP expression
public
regexpMatch(mixed $regex) : RegexMatchOperator
Parameters
- $regex : mixed
-
mixed the regex operand
Return values
RegexMatchOperator —a new RegexMatchOperator
regexpReplace()
Construct a REGEXP_REPLACE call expression on a string expression
public
regexpReplace(mixed $pattern, mixed $replacement[, mixed $start = 1 ][, mixed $occurrence = 0 ][, mixed $flags = 'c' ]) : RegexReplaceFunction
Parameters
- $pattern : mixed
-
string pattern to search
- $replacement : mixed
-
string replacement
- $start : mixed = 1
-
int start position (default 1)
- $occurrence : mixed = 0
-
int occurrence to replace (default 0)
- $flags : mixed = 'c'
-
string flags to use (default 'c')
Return values
RegexReplaceFunction —a new RegexReplaceFunction
regexpSubStr()
Construct a REGEXP_SUBSTR call expression on a string expression
public
regexpSubStr(mixed $pattern[, mixed $start = 1 ][, mixed $occurrence = 1 ][, mixed $flags = 'c' ]) : RegexSubStrFunction
Parameters
- $pattern : mixed
-
string pattern to search
- $start : mixed = 1
-
int start position (default 1)
- $occurrence : mixed = 1
-
int occurrence to replace (default 1)
- $flags : mixed = 'c'
-
string flags to use (default 'c')
Return values
RegexSubStrFunction —a new RegexSubStrFunction
replace()
Construct a REPLACE call expression on a string expression
public
replace(mixed $oldString, mixed $newString) : mixed
Parameters
- $oldString : mixed
-
mixed old string to replace
- $newString : mixed
-
mixed new string to use
substring()
Construct a SUBSTRING call expression on a string expression
public
substring(mixed $start[, mixed $length = NULL ]) : Substring
Parameters
- $start : mixed
-
int start position
- $length : mixed = NULL
-
mixed length of the substring
Return values
Substring —a new Substring
trim()
Construct a TRIM call expression on a string expression
public
trim() : Trim
Return values
Trim —a new Trim
upper()
Construct an UPPER call expression on a string expression
public
upper() : Upper
Return values
Upper —a new Upper