API Documentation
Back to top  

MongoAuthOptions

Options configuring Mongo authentication.

package

Default

Methods

MongoAuthOptions constructor

__construct( $mongoAuthOptions = null)

Arguments

$mongoAuthOptions

mixed | null

getCollectionName

getCollectionName() : string

Response

string

getConfig

getConfig() : array

Response

array

getDatasourceName

getDatasourceName() : string

Response

string

getPasswordField

getPasswordField() : string

Response

string

getPermissionField

getPermissionField() : string

Response

string

getRoleField

getRoleField() : string

Response

string

getSaltField

getSaltField() : string

Response

string

getSaltStyle

getSaltStyle() : string

Response

string

getShared

getShared() : boolean

Response

boolean

getUsernameCredentialField

getUsernameCredentialField() : string

Response

string

getUsernameField

getUsernameField() : string

Response

string

setCollectionName

setCollectionName( $collectionName) : $this

Arguments

$collectionName

string

Response

$this

setConfig

setConfig( $config) : $this

Arguments

$config

array

Response

$this

setDatasourceName

setDatasourceName( $datasourceName) : $this

Arguments

$datasourceName

string

Response

$this

setPasswordField

setPasswordField( $passwordField) : $this

Arguments

$passwordField

string

Response

$this

setPermissionField

setPermissionField( $permissionField) : $this

Arguments

$permissionField

string

Response

$this

setRoleField

setRoleField( $roleField) : $this

Arguments

$roleField

string

Response

$this

setSaltField

setSaltField( $saltField) : $this

Arguments

$saltField

string

Response

$this

setSaltStyle

setSaltStyle( $saltStyle) : $this

Arguments

$saltStyle

string

Response

$this

setShared

setShared( $shared) : $this

Arguments

$shared

boolean

Response

$this

setUsernameCredentialField

setUsernameCredentialField( $usernameCredentialField) : $this

Arguments

$usernameCredentialField

string

Response

$this

setUsernameField

setUsernameField( $usernameField) : $this

Arguments

$usernameField

string

Response

$this