Overview

Namespaces

  • Genetsis
    • core
      • activityid
      • user
  • None

Classes

  • AccessToken
  • ClientToken
  • Encryption
  • FileCache
  • LogConfig
  • LoginStatus
  • LoginStatusType
  • OAuth
  • OAuthConfig
  • OauthTemplate
  • RefreshToken
  • Request
  • StoredToken
  • Things
  • User

Interfaces

  • iTokenTypes

Exceptions

  • InvalidGrantException
  • Overview
  • Namespace
  • Class

Class OAuthConfig

Manages OAuth configuration file.

Namespace: Genetsis\core
Package: Genetsis
Category: Bean
Version: 1.0
Located at core/OAuthConfig.php
Methods summary
public static
# init( )
public static string
# getClientId( )

Returns web client identifier.

Returns web client identifier.

Returns

string
Web client identifier. It could be empty.
public static string
# getClientSecret( )

Returns web client secret.

Returns web client secret.

Returns

string
Web client secret. It could be empty.
public static string
# getRedirectUrl( string $type, string $urlCallback = null )

Returns an URL to redirect user. Redirects can to have more than a url associate to a type. Value in first position is the default value.

Returns an URL to redirect user. Redirects can to have more than a url associate to a type. Value in first position is the default value.

Parameters

$type
Identifier to select a URL type.
$urlCallback
Url for callback. This url must to be defined in 'oauthconf.xml'

Returns

string

The URL selected. It could be empty if not exists that type or if $urlCallback is not defined in 'oauthconf.xml'.

public static string
# getEndpointUrl( $type )

Returns an endpoint to interact with Genetsis ID servers.

Returns an endpoint to interact with Genetsis ID servers.

Parameters

$type
Identifier to select an URL.

Returns

string
The URL selected. It could be empty if not exists that type.
public static boolean
# getApiUrl( $type, null $verb = null )

Returns an endpoint to interact with API-Query.

Returns an endpoint to interact with API-Query.

Parameters

$type
to select an URL.
$verb

Returns

boolean
public static string
# getSection( string $type )

Returns a section.

Returns a section.

Parameters

$type
Identifier to select a section.

Returns

string
The section selected. It could be empty if not exists that type.
public static mixed
# getDefaultSection( )

Return default section or false if no exist a default.

Return default section or false if no exist a default.

Returns

mixed
default section or false
public static mixed
# getPrizeSection( $section, $prize )

Return a prize for the section in activityID if exist

Return a prize for the section in activityID if exist

Parameters

$section
identifier
$prize
identifier in ActivityID

Returns

mixed
int prize ID in activityId, null if prize not exist
public static string
# getApiOpinatorUrl( )

Return Api Opinator URL

Return Api Opinator URL

Returns

string
public static string
# getHost( )

Returns hosts for GID environement

Returns hosts for GID environement

Returns

string

The URL selected. It could be empty if not exists that type.

API documentation generated by ApiGen