Абстрактный класс yii\authclient\signature\BaseMethod

Все классы | Свойства | Методы

Наследование	yii\authclient\signature\BaseMethod » yii\base\Object
Реализует	yii\base\Configurable
Подклассы	yii\authclient\signature\HmacSha, yii\authclient\signature\HmacSha1, yii\authclient\signature\PlainText, yii\authclient\signature\RsaSha, yii\authclient\signature\RsaSha1
Доступно с версии	2.0
Исходный код	https://github.com/yiisoft/yii2-authclient/blob/master/signature/BaseMethod.php

BaseMethod — базовый класс для методов подписи OAuth.

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

Свойство	Тип	Описание	Определено в
$name	string	Имя метода.	yii\authclient\signature\BaseMethod

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

Метод	Описание	Определено в
__call()	Вызывает метод, который не является методом класса.	yii\base\Object
__construct()	Конструктор.	yii\base\Object
__get()	Возвращает значение свойства объекта.	yii\base\Object
__isset()	Проверяет, установлено ли свойство, т. е. определено и не равно null.	yii\base\Object
__set()	Устанавливает значение свойства объекта.	yii\base\Object
__unset()	Устанавливает свойство объекта в значение null.	yii\base\Object
canGetProperty()	Возвращает значение, указывающее, можно ли читать свойство.	yii\base\Object
canSetProperty()	Возвращает значение, указывающее, можно ли установить свойство.	yii\base\Object
className()	Возвращает полное имя этого класса.	yii\base\Object
generateSignature()	Генерирует подпись запроса OAuth.	yii\authclient\signature\BaseMethod
getName()	Возвращает каноническое имя метода подписи.	yii\authclient\signature\BaseMethod
hasMethod()	Возвращает значение, указывающее, определен ли метод.	yii\base\Object
hasProperty()	Возвращает значение, указывающее, определено ли свойство.	yii\base\Object
init()	Инициализирует объект.	yii\base\Object
verify()	Проверяет заданный запрос OAuth.	yii\authclient\signature\BaseMethod

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

$name публичное только для чтения свойство

Имя метода.

public abstract string getName ( )

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

generateSignature() публичный абстрактный метод

Генерирует подпись запроса OAuth.

public abstract string generateSignature ( $baseString, $key )
$baseString	string	Базовая строка подписи.
$key	string	Ключ подписи.
return	string	Строка подписи.

getName() публичный абстрактный метод

Возвращает каноническое имя метода подписи.

public abstract string getName ( )
return	string	Имя метода.

verify() публичный метод

Проверяет заданный запрос OAuth.

public boolean verify ( $signature, $baseString, $key )
$signature	string	Подпись для проверки.
$baseString	string	Базовая строка подписи.
$key	string	Ключ подписи.
return	boolean	Успешно.

© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-authclient-signature-basemethod.html