Overview

Namespaces

  • Racoon
    • Api
      • Auth
      • Exception
      • Response
        • Format
        • Generate
      • Schema

Classes

  • ApiKeyAuthenticator
  • NoAuthenticator

Interfaces

  • AuthInterface
  • Overview
  • Namespace
  • Class

Class ApiKeyAuthenticator

Basic authenticator which can be used to set a static list of API keys. Class ApiKeyAuthenticator

Racoon\Api\Auth\ApiKeyAuthenticator implements Racoon\Api\Auth\AuthInterface
Namespace: Racoon\Api\Auth
Package: Racoon\Api\Auth
Located at Auth/ApiKeyAuthenticator.php
Methods summary
public
# __construct( )
public boolean
# authenticate( Racoon\Api\Request $request )

Parameters

$request

Returns

boolean

Throws

Racoon\Api\Exception\AuthenticationException

Implementation of

Racoon\Api\Auth\AuthInterface::authenticate()
public string
# getApiKeyName( )

Returns

string
public
# setApiKeyName( string $apiKeyName )

Parameters

$apiKeyName
public string[]
# getValidApiKeys( )

Returns

string[]
public
# setValidApiKeys( string[] $validApiKeys )

Parameters

$validApiKeys
public
# addValidApiKey( string $apiKey )

Parameters

$apiKey
Properties summary
protected string $apiKeyName
#
protected string[] $validApiKeys
# []
API documentation generated by ApiGen