1. class
  2. GenericDatabase
  3. \
  4. Engine
  5. \
  6. PgSQL
  7. \
  8. Connection
  9. \
  10. Options
  11. \
  12. OptionsHandler

OptionsHandler

class OptionsHandler extends AbstractOptions implements IOptions (View source)

Properties

static protected array $options

Array to store connection options

 from  AbstractOptions
static protected IConnection $instance

Database connection instance

 from  AbstractOptions

Methods

__construct(IConnection $instance)

Initialize options with a connection instance

from  AbstractOptions
IConnection
getInstance()

Get the database connection instance

from  AbstractOptions
void
set(string $name, mixed $value)

Set an option value using dynamic method call

from  AbstractOptions
mixed
get(string $name)

Get an option value using dynamic method call

from  AbstractOptions
mixed
getOptions(int|null $type = null)

Get all options or a specific option type defined by user

from  AbstractOptions
void
setOptions(array|null $options = null)

This method is responsible for set options before connect in database

void
define()

This method is responsible for set options after connect in database

Details

in AbstractOptions at line 58
__construct(IConnection $instance)

Initialize options with a connection instance

Parameters

IConnection $instance

The database connection instance

in AbstractOptions at line 68
IConnection getInstance()

Get the database connection instance

Return Value

IConnection

The current database connection instance

in AbstractOptions at line 80
void set(string $name, mixed $value)

Set an option value using dynamic method call

Parameters

string $name

The name of the option to set
mixed $value

The value to set

Return Value

void

in AbstractOptions at line 91
mixed get(string $name)

Get an option value using dynamic method call

Parameters

string $name

The name of the option to get

Return Value

mixed

The value of the requested option

in AbstractOptions at line 102
mixed getOptions(int|null $type = null)

Get all options or a specific option type defined by user

Parameters

int|null $type

Optional type of options to retrieve

Return Value

mixed

All options or specific type options if type parameter provided

at line 20
void setOptions(array|null $options = null)

This method is responsible for set options before connect in database

Parameters

array|null $options

= null

Return Value

void

Exceptions

ReflectionException

at line 47
void define()

This method is responsible for set options after connect in database

Return Value

void