Overview

Namespaces

  • Comprobo
    • Verify
      • Auth
      • Exceptions
      • HTTP

Classes

  • Comprobo\Verify\Api
  • Comprobo\Verify\Auth\Server
  • Comprobo\Verify\Factory
  • Comprobo\Verify\HTTP\Request
  • Comprobo\Verify\State
  • Comprobo\Verify\User
  • Comprobo\Verify\Workflow

Exceptions

  • Comprobo\Verify\Exceptions\Auth
  • Comprobo\Verify\Exceptions\Misconfiguration
  • Comprobo\Verify\Exceptions\User
  • Overview
  • Namespace
  • Class
  1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 
<?php
namespace Comprobo\Verify;

/**
 * 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.
 */
class Factory
{
    /**
     * @var array
     */
    private $config;
    /**
     * @var State
     */
    private $state;

    /**
     * Create a new Comprobo\Verify\Factory
     *
     * @param array $userConfig any custom configuration variables that need to be overwritten
     */
    public function __construct(array $userConfig = ['env' => 'local'])
    {
        $requiredKeys = ['env'];

        foreach ($requiredKeys as $key) {
            // @todo More validation on these items.
            if (!array_key_exists($key, $userConfig)) {
                throw new Exceptions\Misconfiguration("Missing required config key $key");
            }
        }

        $this->config = array_merge($userConfig, $this->moduleConfig($userConfig));
        $this->state = new State();
    }

    /**
     * @return Comprobo\Verify\Api The common API methods such as authenticating your server
     */
    public function getApi()
    {
        return new Api($this);
    }

    /**
     * @return Comprobo\Verify\User user and identity service integration
     */
    public function getUser()
    {
        return new User($this->config, $this, $this->state);
    }

    /**
     * @return Comprobo\Verify\Workflow workflow service integration
     */
    public function getWorkflow()
    {
        return new Workflow($this->config, $this, $this->state);
    }

    /**
     *  @return Comprobo\Verify\State the current API state such as access token and organisation context
     */
    public function getState()
    {
        return $this->state;
    }

    /**
     *  @return array the current SDK config
     */
    public function getConfig()
    {
        return $this->config;
    }

    /**
     * @return Auth\Server the auth service integration
     */
    public function getServerAuth()
    {
        return new Auth\Server($this->config, $this);
    }

    /**
     * @return HTTP\Request HTTP client wrapper for making system calls
     */
    public function getRequest()
    {
        return new HTTP\Request();
    }

    /**
     * @return string url for JavaScript files that must be included to operate the SDK in the browser
     */
    public function javascriptPath()
    {
        return $this->config['urls']['javascriptPath'];
    }

    /**
     * @param  array $userConfig any custom parameters passed to the application by the caller
     * @return array environment-specific module configuration
     */
    private function moduleConfig(array $userConfig)
    {
        switch (strtolower($userConfig['env'])) {
            case 'staging':
                $baseUrl = 'https://staging.comprobo.net/';
                $authUrl = 'https://auth.staging.comprobo.net/';
                $uiUrl   =  'https://staging.comprobo.net/';
                $orgUrl  = 'https://identity.staging.comprobo.net/organisation/';
                $workflowUrl  = 'https://workflow.staging.comprobo.net/workflow/';
                break;
            case 'local':
                $baseUrl = 'http://localhost:8081/';
                $authUrl = 'http://localhost:8081/';
                $uiUrl   = 'http://localhost:8080/';
                $orgUrl  = 'http://localhost:8081/';
                $workflowUrl  = 'http://localhost:8081/';
                break;
            default:
                $baseUrl = '';
                $authUrl = '';
                $uiUrl   = '';
                $orgUrl  = '';
                $workflowUrl  = '';
        }

        return [
            'urls' => [
                'auth'            => $authUrl . '/v1/auth/integrations/authenticate',
                'authMethods'     => $authUrl . 'v1/auth/methods',
                'userToken'       => $authUrl . 'v1/auth/integrations/token/{uuid}',
                'javascriptPath'  => $uiUrl . 'comprobo-verify.js',
                'userCreate'      => $orgUrl . 'v1/organisation/{orgid}/integration/user',
                'workflowAssign'  => $workflowUrl . 'v1/workflow/{workflowid}/invitees',
                'workflowClone'   => $workflowUrl . 'v1/workflow/{workflowid}/clone',
                'workflowList'    => $workflowUrl . 'v1/workflow/list',
                'workflowAnalyse' => $workflowUrl . 'v1/workflow/{workflowid}/model/analyse',
            ],
            'data' => [
                'mappingsFile' => __DIR__ . "/../api-mappings.json"
            ]
        ];
    }
}
API documentation generated by ApiGen