Arikaim CMS

AuthFactory
in package

Auth factory class.

Table of Contents

Constants

AUTH_BASIC  = 'basic'
AUTH_JWT  = 'jwt'
AUTH_PUBLIC  = 'public'
AUTH_SESSION  = 'session'
AUTH_TOKEN  = 'token'
CSRF_TOKEN  = 'csrf'
OAUTH_TOKEN  = 'oauth'

Properties

$authNames  : array<string|int, mixed>
Auth name
$providerClasses  : array<string|int, mixed>
Auth provider classes
$providers  : array<string|int, mixed>
Providers object pool

Methods

createAuthProviders()  : array<string|int, mixed>
Create auth providers
createMiddleware()  : object|null
Create auth middleware
createProvider()  : object|null
Create auth provider
getAuthProviderClass()  : string
Get auth provider class
isValidAuthName()  : bool
Check if auth name is valid
resolveAuthType()  : null|string
Resolve auth type

Constants

Properties

$authNames

Auth name

private static array<string|int, mixed> $authNames = [Self::AUTH_BASIC, Self::AUTH_SESSION, Self::AUTH_JWT, Self::AUTH_TOKEN, Self::CSRF_TOKEN, Self::OAUTH_TOKEN, Self::AUTH_PUBLIC]

$providerClasses

Auth provider classes

private static array<string|int, mixed> $providerClasses = [Self::AUTH_BASIC => 'Arikaim\\Core\\Access\\Provider\\BasicAuthProvider', Self::AUTH_SESSION => 'Arikaim\\Core\\Access\\Provider\\SessionAuthProvider', Self::AUTH_JWT => 'Arikaim\\Core\\Access\\Provider\\JwtAuthProvider', Self::AUTH_TOKEN => 'Arikaim\\Core\\Access\\Provider\\TokenAuthProvider', Self::OAUTH_TOKEN => 'Arikaim\\Core\\Access\\Provider\\OauthProvider', Self::AUTH_PUBLIC => 'Arikaim\\Core\\Access\\Provider\\PublicAuthProvider']

$providers

Providers object pool

private static array<string|int, mixed> $providers = []

Methods

createAuthProviders()

Create auth providers

public static createAuthProviders(string|array<string|int, mixed> $authName[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
$authName : string|array<string|int, mixed>
$params : array<string|int, mixed> = []
Return values
array<string|int, mixed>

createMiddleware()

Create auth middleware

public static createMiddleware(string $authName[, object|null $container = null ][, array<string|int, mixed> $options = [] ]) : object|null
Parameters
$authName : string
$container : object|null = null
$options : array<string|int, mixed> = []
Return values
object|null

createProvider()

Create auth provider

public static createProvider(string $name[, array<string|int, mixed> $params = [] ]) : object|null
Parameters
$name : string
$params : array<string|int, mixed> = []
Return values
object|null

getAuthProviderClass()

Get auth provider class

public static getAuthProviderClass(string $name) : string
Parameters
$name : string
Return values
string

isValidAuthName()

Check if auth name is valid

public static isValidAuthName(string $name) : bool
Parameters
$name : string
Return values
bool

resolveAuthType()

Resolve auth type

public static resolveAuthType(string|null|array<string|int, mixed> $type) : null|string
Parameters
$type : string|null|array<string|int, mixed>
Return values
null|string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results