Index Documentation

ValkeyProviderInfo
in package
implements CacheProviderInfo

Represents Valkey provider info.

Table of Contents

Interfaces

CacheProviderInfo
Base type for cache provider info.

Methods

__construct()  : mixed
getDatabaseNumber()  : int
Database that should be selected.
getEndPoint()  : EndPoint
Gets server endpoint.
getPassword()  : string
Password to authenticate with.
getPrefix()  : string
A prefix that gets applied to every key.
getServerHost()  : string
Retrieves the server hostname.
getServerPort()  : int
Retrieves the server Unix path.
getUsername()  : string
Username to authenticate with.
hasDatabaseNumber()  : bool
Whether a database should be selected.
hasPassword()  : bool
Whether a password should be used.
hasUsername()  : bool
Whether a username should be used.
isPersistent()  : bool
Whether the connection should be persistent.

Methods

__construct()

public __construct(EndPoint $endPoint, string $prefix, bool $persist, string $username, string $password, int $dbNumber) : mixed
Parameters
$endPoint : EndPoint
$prefix : string
$persist : bool
$username : string
$password : string
$dbNumber : int

getDatabaseNumber()

Database that should be selected.

public getDatabaseNumber() : int
Return values
int

getPassword()

Password to authenticate with.

public getPassword() : string
Return values
string

getPrefix()

A prefix that gets applied to every key.

public getPrefix() : string
Return values
string

getServerHost()

Retrieves the server hostname.

public getServerHost() : string
Tags
throws
RuntimeException

Unsupported endpoint specified.

Return values
string

getServerPort()

Retrieves the server Unix path.

public getServerPort() : int
Return values
int

getUsername()

Username to authenticate with.

public getUsername() : string
Return values
string

hasDatabaseNumber()

Whether a database should be selected.

public hasDatabaseNumber() : bool
Return values
bool

hasPassword()

Whether a password should be used.

public hasPassword() : bool
Return values
bool

hasUsername()

Whether a username should be used.

public hasUsername() : bool
Return values
bool

isPersistent()

Whether the connection should be persistent.

public isPersistent() : bool
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results