Класс yii\authclient\signature\HmacSha
| Наследование | yii\authclient\signature\HmacSha » yii\authclient\signature\BaseMethod » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable |
| Подклассы | yii\authclient\signature\HmacSha1 |
| Доступно с версии | 2.1.3 |
| Исходный код | https://github.com/yiisoft/yii2-authclient/blob/master/signature/HmacSha.php |
HmacSha1 представляет метод подписи 'HMAC SHA'.
Примечание: Для этого класса требуется расширение PHP "Hash" (http://php.net/manual/ru/book.hash.php).
Публичные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $algorithm | string | Алгоритм хэширования, например sha1, sha256 и так далее. |
yii\authclient\signature\HmacSha |
| $name | string | Имя метода. | yii\authclient\signature\HmacSha |
Публичные методы
| Метод | Описание | Определено в |
|---|---|---|
| __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\HmacSha |
| getName() | Возвращает каноническое имя метода подписи. | yii\authclient\signature\HmacSha |
| hasMethod() | Возвращает значение, указывающее, определен ли метод. | yii\base\Object |
| hasProperty() | Возвращает значение, указывающее, определено ли свойство. | yii\base\Object |
| init() | Инициализирует объект. | yii\authclient\signature\HmacSha |
| verify() | Проверяет предоставленный запрос OAuth. | yii\authclient\signature\BaseMethod |
Подробности свойств
$algorithm публичное свойство
Алгоритм хэширования, например sha1, sha256 и так далее.
См. также http://php.net/manual/ru/function.hash-algos.php.
public string $algorithm = null
$name публичное только для чтения свойство
Имя метода.
public string getName ( )
Подробности методов
generateSignature() публичный метод
Генерирует подпись запроса OAuth.
| public string generateSignature ( $baseString, $key ) | ||
|---|---|---|
| $baseString | string |
Строка-основа подписи. |
| $key | string |
Ключ подписи. |
| return | string |
Строка подписи. |
getName() публичный метод
Возвращает каноническое имя метода подписи.
| public string getName ( ) | ||
|---|---|---|
| return | string |
Имя метода. |
init() публичный метод
Инициализирует объект.
Этот метод вызывается в конце конструктора после инициализации объекта заданной конфигурацией.
| public void init ( ) |
|---|
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-authclient-signature-hmacsha.html
