Index Documentation

DbConfigValueInfo
in package
implements ConfigValueInfo

Provides information about a databased configuration value.

Table of Contents

Interfaces

ConfigValueInfo
Provides a common interface for configuration values.

Methods

__construct()  : mixed
__toString()  : string
getArray()  : array<string|int, mixed>
Ensures the value is an array and returns the value.
getBoolean()  : bool
Ensures the value is a boolean and returns the value.
getFloat()  : float
Ensures the value is a floating point number and returns the value.
getInteger()  : int
Ensures the value is an integer and returns the value.
getName()  : string
Gets the name of this configuration value.
getString()  : string
Ensures the value is a string and returns the value.
getType()  : string
Gets the type of this configuration value.
getValue()  : mixed
Gets the raw value without any type validation.
isArray()  : bool
Checks whether the value is an array.
isBoolean()  : bool
Checks whether the value is a boolean.
isFloat()  : bool
Checks whether the value is a floating point number.
isInteger()  : bool
Checks whether the value is an integer.
isString()  : bool
Checks whether the value is a string.

Methods

getArray()

Ensures the value is an array and returns the value.

public getArray() : array<string|int, mixed>
Return values
array<string|int, mixed> —

Array configuration value.

getBoolean()

Ensures the value is a boolean and returns the value.

public getBoolean() : bool
Return values
bool —

Boolean configuration value.

getFloat()

Ensures the value is a floating point number and returns the value.

public getFloat() : float
Return values
float —

Floating point number configuration value.

getInteger()

Ensures the value is an integer and returns the value.

public getInteger() : int
Return values
int —

Integer configuration value.

getName()

Gets the name of this configuration value.

public getName() : string
Return values
string —

Configuration value name.

getString()

Ensures the value is a string and returns the value.

public getString() : string
Return values
string —

String configuration value.

getType()

Gets the type of this configuration value.

public getType() : string
Return values
string —

Configuration value type name.

getValue()

Gets the raw value without any type validation.

public getValue() : mixed
Return values
mixed —

The configuration value.

isArray()

Checks whether the value is an array.

public isArray() : bool
Return values
bool —

True if the value is an array.

isBoolean()

Checks whether the value is a boolean.

public isBoolean() : bool
Return values
bool —

True if the value is a boolean.

isFloat()

Checks whether the value is a floating point number.

public isFloat() : bool
Return values
bool —

True if the value is a floating point number.

isInteger()

Checks whether the value is an integer.

public isInteger() : bool
Return values
bool —

True if the value is an integer.

isString()

Checks whether the value is a string.

public isString() : bool
Return values
bool —

True if the value is a string.


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results