Documentation

Siteuser_Oauth_Vkontakte_Controller extends Siteuser_Oauth_Controller
in package

Siteuser_Oauth_Vkontakte_Controller

Tags
subpackage

Siteuser

version
7.x
author

Hostmake LLC

copyright

© 2005-2022 ООО "Хостмэйк" (Hostmake LLC), http://www.hostcms.ru

Table of Contents

$code  : string
Code for exchange to access token
$_allowedProperties  : array<string|int, mixed>
Allowed object properties
$_config  : array<string|int, mixed>
Config
$_propertiesValues  : array<string|int, mixed>
Properties values
$_unlimitedProperties  : bool
Object has unlimited number of properties
__construct()  : mixed
Constructor.
addAllowedProperties()  : self
Add additional allowed properties
addAllowedProperty()  : self
Add additional allowed property
execute()  : mixed
Execute the business logic
factory()  : mixed
Build oauth provider class by provider id
set()  : self
Run when writing data to inaccessible properties
setUnlimitedProperties()  : self
Set unlimitedProperties
_getData()  : mixed
cURL request sender

Properties

$code

Code for exchange to access token

public string $code = \NULL

$_allowedProperties

Allowed object properties

protected array<string|int, mixed> $_allowedProperties = array('CLIENT_ID', 'CLIENT_SECRET', 'REDIRECT_URI')

$_config

Config

protected array<string|int, mixed> $_config = array()

$_propertiesValues

Properties values

protected array<string|int, mixed> $_propertiesValues = array()

$_unlimitedProperties

Object has unlimited number of properties

protected bool $_unlimitedProperties = \FALSE

Methods

__construct()

Constructor.

public __construct() : mixed
Return values
mixed

addAllowedProperties()

Add additional allowed properties

public addAllowedProperties(array<string|int, mixed> $array) : self
Parameters
$array : array<string|int, mixed>

array of properties' names

Return values
self

addAllowedProperty()

Add additional allowed property

public addAllowedProperty(string $property) : self
Parameters
$property : string

property name

Return values
self

execute()

Execute the business logic

public execute() : mixed
Return values
mixed

factory()

Build oauth provider class by provider id

public static factory(int $iOAuthProviderId) : mixed
Parameters
$iOAuthProviderId : int

provider id

Return values
mixed

set()

Run when writing data to inaccessible properties

public set(string $property, string $value) : self
Parameters
$property : string

property name

$value : string

property value

Return values
self

setUnlimitedProperties()

Set unlimitedProperties

public setUnlimitedProperties([bool $value = TRUE ]) : self
Parameters
$value : bool = TRUE

default TRUR

Return values
self

_getData()

cURL request sender

private _getData(string $sUrl, array<string|int, mixed> $aParams) : mixed
Parameters
$sUrl : string

URL

$aParams : array<string|int, mixed>

parameters

Return values
mixed

Search results