class Search (View source)

Constants

ANY

MYSQL

MARIADB

AURORA_MYSQL

DS

Properties

static stdClass $data

Loaded data

static bool $loaded

Data is loaded

static string $DATA_DIR

The directory where the data is located

Methods

static void
loadData()

Load data from disk

static void
loadTestData(SlimData $slimData)

Load test data

static string
getByName(string $name, int $type = Search::ANY)

get the first link to doc available

static stdClass
getVariable(string $name)

Get a variable

static string
getVariableType(string $name)

get the type of the variable

static array
getStaticVariables()

Return the list of static variables

static array
getDynamicVariables()

Return the list of dynamic variables

static array
getVariablesWithDynamic(bool $dynamic)

Return the list of variables having dynamic = $dynamic

Details

static void loadData()

Load data from disk

Return Value

void

Exceptions

KBException

static void loadTestData(SlimData $slimData)

Load test data

Parameters

SlimData $slimData

The SlimData object

Return Value

void

static string getByName(string $name, int $type = Search::ANY)

get the first link to doc available

Parameters

string $name

Name of variable

int $type

(optional) Type of link Search::MYSQL/Search::MARIADB/Search::ANY

Return Value

string

Exceptions

KBException

static stdClass getVariable(string $name)

Get a variable

Parameters

string $name

Name of variable

Return Value

stdClass

Exceptions

KBException

static string getVariableType(string $name)

get the type of the variable

Parameters

string $name

Name of variable

Return Value

string

Exceptions

KBException

static array getStaticVariables()

Return the list of static variables

Return Value

array

static array getDynamicVariables()

Return the list of dynamic variables

Return Value

array

static array getVariablesWithDynamic(bool $dynamic)

Return the list of variables having dynamic = $dynamic

Parameters

bool $dynamic dynamic=true/dynamic=false

Return Value

array