Class yii\authclient\signature\PlainText

All Classes | Properties | Methods

Inheritance	yii\authclient\signature\PlainText » yii\authclient\signature\BaseMethod » yii\base\BaseObject
Available since extension's version	2.0
Source Code	https://github.com/yiisoft/yii2-authclient/blob/master/src/signature/PlainText.php

PlainText represents 'PLAINTEXT' signature method.

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
$name	string	Method name.	yii\authclient\signature\PlainText

Public Methods

Hide inherited methods

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

Property Details

Hide inherited properties

$name public property

Method name.

public string $name = null

Method Details

Hide inherited methods

generateSignature() public method

Generates OAuth request signature.

public string generateSignature ( mixed $baseString, mixed $key )
$baseString	mixed	Signature base string.
$key	mixed	Signature key.
return	string	Signature string.

Source code

                public function generateSignature($baseString, $key)
{
    return $key;
}

getName() public method

Return the canonical name of the Signature Method.

public string getName ( )
return	string	Method name.

Source code

                public function getName()
{
    return 'PLAINTEXT';
}

verify() public method

Defined in: yii\authclient\signature\BaseMethod::verify()

Verifies given OAuth request.

public boolean verify ( string $signature, string $baseString, string $key )
$signature	string	Signature to be verified.
$baseString	string	Signature base string.
$key	string	Signature key.
return	boolean	Success.

Source code

                public function verify($signature, $baseString, $key)
{
    $expectedSignature = $this->generateSignature($baseString, $key);
    if (empty($signature) || empty($expectedSignature)) {
        return false;
    }
    return (strcmp($expectedSignature, $signature) === 0);
}