yii\authclient\signature\BaseMethod - Yii2 类参考手册

Abstract Class yii\authclient\signature\BaseMethod

Inheritanceyii\authclient\signature\BaseMethod » yii\base\BaseObject
Implementsyii\base\Configurable
Subclassesyii\authclient\signature\HmacSha, yii\authclient\signature\HmacSha1, yii\authclient\signature\PlainText, yii\authclient\signature\RsaSha, yii\authclient\signature\RsaSha1
Available since version2.0

BaseMethod is a base class for the OAuth signature methods.

Public Properties

隐藏继承的属性 Hide inherited properties

属性Property类型 Type简介 Description定义在 Defined By
$name string Method name. yii\authclient\signature\BaseMethod

Public Methods

隐藏继承的方法 Hide inherited methods

方法 Method简介 Description定义在 Defined By
__call() Calls the named method which is not a class method. yii\base\BaseObject
__construct() Constructor. yii\base\BaseObject
__get() Returns the value of an object property. yii\base\BaseObject
__isset() Checks if a property is set, i.e. defined and not null. yii\base\BaseObject
__set() Sets value of an object property. yii\base\BaseObject
__unset() Sets an object property to null. yii\base\BaseObject
canGetProperty() Returns a value indicating whether a property can be read. yii\base\BaseObject
canSetProperty() Returns a value indicating whether a property can be set. yii\base\BaseObject
className() Returns the fully qualified name of this class. yii\base\BaseObject
generateSignature() Generates OAuth request signature. yii\authclient\signature\BaseMethod
getName() Return the canonical name of the Signature Method. yii\authclient\signature\BaseMethod
hasMethod() Returns a value indicating whether a method is defined. yii\base\BaseObject
hasProperty() Returns a value indicating whether a property is defined. yii\base\BaseObject
init() Initializes the object. yii\base\BaseObject
verify() Verifies given OAuth request. yii\authclient\signature\BaseMethod

属性详情 Property Details

$name public read-only property

Method name.

public abstract string getName ( )

方法详情 Method Details

generateSignature() public abstract method

Generates OAuth request signature.

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

Signature base string.

$key string

Signature key.

return string

Signature string.

getName() public abstract method

Return the canonical name of the Signature Method.

public abstract string getName ( )
return string

Method name.

verify() public method

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.