TimeTrex API Manual

Option
in package

Table of Contents

getArrayByBitMask()  : array<string|int, mixed>|bool
getBitMaskByArray()  : int|mixed
getByArray()  : array<string|int, mixed>|bool
Takes $needles as an array, loops through them returning matching keys => value pairs from haystack Useful for filtering results to a select box, like status.
getByFuzzyValue()  : array<string|int, mixed>|bool|mixed
Tries to replicate Factory::handleSQLSyntax() or 'text_metaphone' matching in SQL.
getByKey()  : bool
getByValue()  : bool

Methods

getArrayByBitMask()

public static getArrayByBitMask( $bitmask,  $options) : array<string|int, mixed>|bool
Parameters
$bitmask :
$options :
Return values
array<string|int, mixed>|bool —

getBitMaskByArray()

public static getBitMaskByArray( $keys,  $options) : int|mixed
Parameters
$keys :
$options :
Return values
int|mixed —

getByArray()

Takes $needles as an array, loops through them returning matching keys => value pairs from haystack Useful for filtering results to a select box, like status.

public static getByArray( $needles,  $haystack) : array<string|int, mixed>|bool
Parameters
$needles :
$haystack :
Return values
array<string|int, mixed>|bool —

getByFuzzyValue()

Tries to replicate Factory::handleSQLSyntax() or 'text_metaphone' matching in SQL.

public static getByFuzzyValue( $value,  $options[, bool $value_is_translated = true ]) : array<string|int, mixed>|bool|mixed
Parameters
$value :
$options :
$value_is_translated : bool = true
Return values
array<string|int, mixed>|bool|mixed —

getByKey()

public static getByKey( $key,  $options[, bool $false = false ]) : bool
Parameters
$key :
$options :
$false : bool = false
Return values
bool —

getByValue()

public static getByValue( $value,  $options[, bool $value_is_translated = true ]) : bool
Parameters
$value :
$options :
$value_is_translated : bool = true
Return values
bool —

Search results