• 홈
• yii
• authclient
• OpenId

PHP 클래스 yii\authclient\OpenId

Supports Yadis and HTML discovery. Usage: ~~~ use yii\authclient\OpenId; $client = new OpenId(); $client->authUrl = 'https://open.id.provider.url'; // Setup provider endpoint $url = $client->buildAuthUrl(); // Get authentication URL return Yii::$app->getResponse()->redirect($url); // Redirect to authentication URL After user returns at our site: if ($client->validate()) { // validate response $userAttributes = $client->getUserAttributes(); // get account info ... } ~~~ AX and SREG extensions are supported. To use them, specify [[requiredAttributes]] and/or [[optionalAttributes]]. 파일 보기 프로젝트 열기: yiisoft/yii2-authclient 1 사용 예제들

공개 프로퍼티들

프로퍼티	타입	설명
$authUrl		authentication base URL, which should be used to compose actual authentication URL by OpenId::buildAuthUrl method.
$axToSregMap		map of matches between AX and SREG attribute names in format: axAttributeName => sregAttributeName
$cainfo		the name of a file holding one or more certificates to verify the peer with. This value will take effect only if [[verifyPeer]] is set.
$capath		directory that holds multiple CA certificates. This value will take effect only if [[verifyPeer]] is set.
$data		data, which should be used to retrieve the OpenID response. If not set combination of GET and POST will be used.
$optionalAttributes		list of attributes, which could be returned from server. Attribute names should be always specified in AX format. For example: php ['namePerson/first', 'namePerson/last']
$requiredAttributes		list of attributes, which always should be returned from server. Attribute names should be always specified in AX format. For example: php ['namePerson/friendly', 'contact/email']
$verifyPeer		whether to verify the peer's certificate.

공개 메소드들

메소드	설명
buildAuthUrl ( boolean $identifierSelect = null ) : string	Returns authentication URL. Usually, you want to redirect your user to it.
discover ( string $url ) : array	Performs Yadis and HTML discovery.
fetchAttributes ( ) : array	Gets AX/SREG attributes provided by OP. Should be used only after successful validation.
getClaimedId ( ) : string
getReturnUrl ( ) : string
getTrustRoot ( ) : string
hostExists ( string $url ) : boolean	Checks if the server specified in the url exists.
init ( )
setClaimedId ( string $claimedId )
setReturnUrl ( string $returnUrl )
setTrustRoot ( string $value )
validate ( boolean $validateRequiredAttributes = true ) : boolean	Performs OpenID verification with the OP.

보호된 메소드들

메소드	설명
buildAuthUrlV1 ( array $serverInfo ) : string	Builds authentication URL for the protocol version 1.
buildAuthUrlV2 ( array $serverInfo ) : string	Builds authentication URL for the protocol version 2.
buildAxParams ( ) : array	Composes AX request parameters.
buildSregParams ( ) : array	Composes SREG request parameters.
buildUrl ( string $baseUrl, string | array $additionalUrl ) : string	Combines given URLs into single one.
compareUrl ( string $expectedUrl, string $actualUrl ) : boolean	Compares 2 URLs taking in account possible GET parameters order miss match and URL encoding inconsistencies.
defaultRequestOptions ( )
defaultReturnUrl ( ) : string	Generates default [[returnUrl]] value.
extractHtmlTagValue ( string $content, string $tag, string $matchAttributeName, string $matchAttributeValue, string $valueAttributeName ) : string | boolean	Scans content for / tags and extract information from them.
fetchAxAttributes ( ) : array	Gets AX attributes provided by OP.
fetchSregAttributes ( ) : array	Gets SREG attributes provided by OP. SREG names will be mapped to AX names.
initUserAttributes ( )
sendRequest ( string $url, string $method = 'GET', array $params = [] ) : array | string	Sends request to the server
validateRequiredAttributes ( ) : boolean	Checks if all required attributes are present in the server response.

메소드 상세

프로퍼티 상세