Docs For Class Veriplace

Description

Contains required and optional properties for configuring a Veriplace client programmatically.

see: Veriplace_DefaultClientFactory
see: Veriplace_Client::__construct()

Located in /Veriplace/Configuration.php (line 55)

Class Constant Summary

DEFAULT_PROTOCOL = Veriplace_ProtocolVersion::OAUTH_1_0_A

DEFAULT_SERVER_URI = 'http://veriplace.com'

JSON_CONTENT_TYPE = "application/json"

XML_CONTENT_TYPE = "text/xml"

Variable Summary

Veriplace_Token $applicationToken

array $callbackExcludeParameters

Veriplace_CallbackFactory $callbackFactory

array $callbackIncludeParameters

int $callbackPath

string $callbackServerName

int $callbackServerPort

string $consumerKey

string $consumerSecret

mixed $defaultLocationMode

mixed $defaultTimeout

mixed $locationFilter

mixed $locationOptions

string $preferredEncoding

string $protocol

VeriplaceRedirector $redirector

string $serverURI

Veriplace_OAuthStore $tokenStore

Method Summary

Veriplace_Configuration __construct ([string $consumerKey = null], [string $consumerSecret = null])

Variables

Veriplace_Token $applicationToken (line 102)

The application-specific access token for this application, if any.

This property may be left null if you will not be using any methods that require an application token (such as Veriplace_UserDiscoveryAPI::getUserByParameters()).

access: public

array $callbackExcludeParameters (line 172)

Specifies the names of query string parameters that should not be included in callback URIs.

This property is only used if you did not specify a Veriplace_CallbackFactory, and can be left null.

access: public

Veriplace_CallbackFactory $callbackFactory (line 121)

Specifies an object that can generate a callback URI and query string based on an existing HTTP request.

This property may be left null to use the standard implementation, Veriplace_DefaultCallbackFactory.

access: public

array $callbackIncludeParameters (line 162)

Specifies the names of query string parameters to be included in callback URIs, if they should not all be included.

This property is only used if you did not specify a Veriplace_CallbackFactory, and can be left null.

access: public

int $callbackPath (line 152)

Specifies a URI subpath for callback URIs, if it can't be detected automatically due to your network configuration (for instance, if your application's output is hosted within a page from another application).

This property is only used if you did not specify a Veriplace_CallbackFactory, and can be left null.

access: public

string $callbackServerName (line 131)

Specifies a hostname for callback URIs, if it can't be detected automatically due to your network configuration.

This property is only used if you did not specify a Veriplace_CallbackFactory, and can be left null.

access: public

int $callbackServerPort (line 141)

Specifies a port for callback URIs, if it can't be detected automatically due to your network configuration.

This property is only used if you did not specify a Veriplace_CallbackFactory, and can be left null.

access: public

string $consumerKey (line 85)

The OAuth consumer key for this application. This property must always be specified.

access: public

string $consumerSecret (line 92)

The OAuth consumer secret for this application. This property must always be specified.

access: public

mixed $defaultLocationMode (line 207)

deprecated: Use $locationOptions instead.
access: public

mixed $defaultTimeout (line 217)

deprecated: Use $locationOptions instead.
access: public

mixed $locationFilter (line 212)

deprecated: Use $locationOptions instead.
access: public

mixed $locationOptions (line 111)

Specifies a Veriplace_LocationOptions object whose properties will be used for all location requests by default.

These properties include the location mode, Veriplace_LocationFilter, and default timeout. They can all be overridden on a per-request basis.

access: public

string $preferredEncoding (line 202)

Specifies the MIME type to request for all server responses.

This must be equal to either Veriplace_Configuration::XML_CONTENT_TYPE or Veriplace_Configuration::JSON_CONTENT_TYPE; the default is XML.

The client can decode responses equally well either way, so you won't normally need to be concerned with this unless you are monitoring network traffic and find a particular encoding easier to read.

access: public

string $protocol (line 76)

The OAuth protocol version to use.

If omitted, this defaults to DEFAULT_PROTOCOL; otherwise it must be one of the values specified in Veriplace_ProtocolVersion.

access: public

VeriplaceRedirector $redirector (line 189)

Specifies an object that can redirect the User Agent to a given URI.

If this is null, the client will send a standard HTTP redirect.

access: public

string $serverURI (line 65)

The URI of the Veriplace server.

If not specified, this defaults to DEFAULT_SERVER_URI. Currently all applications should use the default; other URIs are used only for WaveMarket internal testing.

access: public

Veriplace_OAuthStore $tokenStore (line 181)

The object that will store request tokens and access tokens across multiple requests.

This property may be left null to use the default implementation.

access: public

Methods

Constructor __construct (line 230)

Constructs a new configuration object, optionally specifying the consumer key and secret.

access: public

Veriplace_Configuration __construct ([string $consumerKey = null], [string $consumerSecret = null])

string $consumerKey: The OAuth consumer key; if not specified in the constructor, this must be set before initializing the client.
string $consumerSecret: The OAuth consumer secret; if not specified in the constructor, this must be set before initializing the client.

Class Constants

DEFAULT_PROTOCOL = Veriplace_ProtocolVersion::OAUTH_1_0_A (line 78)

DEFAULT_SERVER_URI = 'http://veriplace.com' (line 67)

JSON_CONTENT_TYPE = "application/json" (line 220)

XML_CONTENT_TYPE = "text/xml" (line 219)