Abstract Class yii\authclient\signature\BaseMethod
Inheritance | yii\authclient\signature\BaseMethod » yii\base\Object |
---|---|
Subclasses | yii\authclient\signature\HmacSha1, yii\authclient\signature\PlainText, yii\authclient\signature\RsaSha1 |
Available since version | 2.0 |
BaseMethod is a base class for the OAuth signature methods.
Public Methods
Method | Description | Defined By |
---|---|---|
generateSignature() | Generates OAuth request signature. | yii\authclient\signature\BaseMethod |
getName() | Return the canonical name of the Signature Method. | yii\authclient\signature\BaseMethod |
verify() | Verifies given OAuth request. | yii\authclient\signature\BaseMethod |
Method Details
Generates OAuth request signature.
public abstract string generateSignature ( $baseString, $key ) | ||
$baseString | string | Signature base string. |
$key | string | Signature key. |
return | string | Signature string. |
---|
Return the canonical name of the Signature Method.
public abstract string getName ( ) | ||
return | string | Method name. |
---|
Verifies given OAuth request.
public boolean verify ( $signature, $baseString, $key ) | ||
$signature | string | Signature to be verified. |
$baseString | string | Signature base string. |
$key | string | Signature key. |
return | boolean | Success. |
---|