Класс yii\authclient\OpenId

OpenId предоставляет простой интерфейс для аутентификации OpenID (1.1 и 2.0).

Поддерживает обнаружение Yadis и HTML.

Использование:

use yii\authclient\OpenId;

$client = new OpenId();
$client->authUrl = 'https://open.id.provider.url'; // Setup provider endpoint
$url = $client->buildAuthUrl(); // Get authentication URL
return Yii::$app->getResponse()->redirect($url); // Redirect to authentication URL
// After user returns at our site:
if ($client->validate()) { // validate response
    $userAttributes = $client->getUserAttributes(); // get account info
    ...
}

Расширения AX и SREG поддерживаются. Для их использования укажите $requiredAttributes и/или $optionalAttributes.

См. также http://openid.net/.

Публичные свойства

Публичные методы

Защищённые методы

Подробное описание свойств

$authUrl общедоступное свойство

Базовый URL авторизации, который следует использовать для построения фактического URL авторизации методом buildAuthUrl().

public string $authUrl = null

$axToSregMap общедоступное свойство

Карта соответствий между именами атрибутов AX и SREG в формате: axAttributeName => sregAttributeName

public array $axToSregMap = ['namePerson/friendly' => 'nickname', 'contact/email' => 'email', 'namePerson' => 'fullname', 'birthDate' => 'dob', 'person/gender' => 'gender', 'contact/postalCode/home' => 'postcode', 'contact/country/home' => 'country', 'pref/language' => 'language', 'pref/timezone' => 'timezone']

$cainfo общедоступное свойство

Имя файла, содержащего один или несколько сертификатов для проверки узла. Это значение будет действовать только в том случае, если $verifyPeer установлено.

public string $cainfo = null

$capath общедоступное свойство

Директория, содержащая несколько сертификатов CA. Это значение будет действовать только в том случае, если $verifyPeer установлено.

public string $capath = null

$claimedId общедоступное свойство

Заявленный идентификатор (идентичность).

public string getClaimedId ( )
public void setClaimedId ( $claimedId )

$data общедоступное свойство

Данные, которые должны быть использованы для получения ответа OpenID. Если не задано, будет использоваться комбинация GET и POST.

public array $data = null

$optionalAttributes общедоступное свойство

Список атрибутов, которые могут быть возвращены сервером. Имена атрибутов всегда должны быть указаны в формате AX. Например:

['namePerson/first', 'namePerson/last']

public array $optionalAttributes = []

$requiredAttributes общедоступное свойство

Список атрибутов, которые всегда должны быть возвращены сервером. Имена атрибутов всегда должны быть указаны в формате AX. Например:

['namePerson/friendly', 'contact/email']

public array $requiredAttributes = []

$returnUrl общедоступное свойство

URL возврата авторизации.

public string getReturnUrl ( )
public void setReturnUrl ( $returnUrl )

$trustRoot общедоступное свойство

Корень доверия клиента (область).

public string getTrustRoot ( )
public void setTrustRoot ( $value )

$verifyPeer общедоступное свойство

Необходимо ли проверять сертификат узла.

public boolean $verifyPeer = null

Подробное описание методов