Overview

Namespaces

  • Comprobo
    • Verify
      • Auth
      • Exceptions
      • HTTP

Classes

  • Api
  • Factory
  • State
  • User
  • Workflow
  • Overview
  • Namespace
  • Class

Class Factory

Provides depedency resolution and injection for various classes in the library. Normally not used directly by a third-party but can be if required for some reason.

Namespace: Comprobo\Verify
Located at Factory.php
Methods summary
public
# __construct( array $userConfig = ['env' => 'production'] )

Create a new Comprobo\Verify\Factory

Create a new Comprobo\Verify\Factory

Parameters

$userConfig
any custom configuration variables that need to be overwritten
public Comprobo\Verify\Api
# getApi( )

Returns

Comprobo\Verify\Api
The common API methods such as authenticating your server
public Comprobo\Verify\Workflow
# getWorkflow( )

Returns

Comprobo\Verify\Workflow
workflow service integration
public Comprobo\Verify\User
# getUser( )

Returns

Comprobo\Verify\User
user service integration
public Comprobo\Verify\State
# getState( )

Treated as a singleton in the application

Treated as a singleton in the application

Returns

Comprobo\Verify\State
the current API state such as access token and organisation context
public array
# getConfig( )

Returns

array
the current SDK config
public Comprobo\Verify\Auth\Server
# getServerAuth( )

Returns

Comprobo\Verify\Auth\Server
the auth service integration
public Comprobo\Verify\HTTP\Request
# getRequest( )

Returns

Comprobo\Verify\HTTP\Request
HTTP client wrapper for making system calls
public string
# javascriptPath( )

Returns

string
url for JavaScript files that must be included to operate the SDK in the browser
API documentation generated by ApiGen