Class yii\authclient\signature\HmacSha

Inheritanceyii\authclient\signature\HmacSha » yii\authclient\signature\BaseMethod » yii\base\BaseObject
Subclassesyii\authclient\signature\HmacSha1
Available since version2.1.3

HmacSha1 represents 'HMAC SHA' signature method.

Note: This class requires PHP "Hash" extension(http://php.net/manual/en/book.hash.php).

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$algorithm string Hash algorithm, e.g. sha1, sha256 and so on. yii\authclient\signature\HmacSha

Public Methods

Hide inherited methods

MethodDescriptionDefined By
generateSignature() Generates OAuth request signature. yii\authclient\signature\HmacSha
getName() Return the canonical name of the Signature Method. yii\authclient\signature\HmacSha
init() yii\authclient\signature\HmacSha
verify() Verifies given OAuth request. yii\authclient\signature\BaseMethod

Property Details

$algorithm public property

Hash algorithm, e.g. sha1, sha256 and so on.

See also http://php.net/manual/ru/function.hash-algos.php.

public string $algorithm null

Method Details

generateSignature() public method

Generates OAuth request signature.

public string generateSignature ( $baseString, $key )
$baseString string

Signature base string.

$key string

Signature key.

return string

Signature string.

getName() public method

Return the canonical name of the Signature Method.

public string getName ( )
return string

Method name.

init() public method

public void init ( )