Class Mage_Oauth_Helper_Data

OAuth Helper

Mage_Oauth_Helper_Data

Package: Mage\Oauth
Category: Mage
Copyright: Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
License: Open Software License (OSL 3.0)
Author: Magento Core Team <core@magentocommerce.com>
Located at code/core/Mage/Oauth/Helper/Data.php

Methods summary
`protected string`	# `_generateRandomString( integer $length )` Generate random string for token or secret or verifier Generate random string for token or secret or verifier Parameters `$length` `integer` $length String length Returns `string`
`public string`	# `generateToken( )` Generate random string for token Generate random string for token Returns `string`
`public string`	# `generateTokenSecret( )` Generate random string for token secret Generate random string for token secret Returns `string`
`public string`	# `generateVerifier( )` Generate random string for verifier Generate random string for verifier Returns `string`
`public string`	# `generateConsumerKey( )` Generate random string for consumer key Generate random string for consumer key Returns `string`
`public string`	# `generateConsumerSecret( )` Generate random string for consumer secret Generate random string for consumer secret Returns `string`
`public boolean\|string`	# `getFullCallbackUrl( Mage_Oauth_Model_Token $token, boolean $rejected = false )` Return complete callback URL or boolean FALSE if no callback provided Return complete callback URL or boolean FALSE if no callback provided Parameters `$token` `Mage_Oauth_Model_Token` $token Token object `$rejected` `boolean` $rejected OPTIONAL Add user reject sign Returns `boolean\|string`
`public string`	# `getProtocolEndpointUrl( string $type )` Retrieve URL of specified endpoint. Retrieve URL of specified endpoint. Parameters `$type` `string` $type Endpoint type (one of ENDPOINT_ constants) Returns `string` Throws `Exception` Exception when endpoint not found
`public boolean`	# `isCleanupProbability( )` Calculate cleanup possibility for data with lifetime property Calculate cleanup possibility for data with lifetime property Returns `boolean`
`public integer`	# `getCleanupExpirationPeriod( )` Get cleanup expiration period value from system configuration in minutes Get cleanup expiration period value from system configuration in minutes Returns `integer`
`public`	# `sendNotificationOnTokenStatusChange( string $userEmail, string $userName, string $applicationName, string $status )` Send Email to Token owner Send Email to Token owner Parameters `$userEmail` `string` $userEmail `$userName` `string` $userName `$applicationName` `string` $applicationName `$status` `string` $status
`protected boolean`	# `_getIsSimple( )` Is current authorize page is simple Is current authorize page is simple Returns `boolean`
`public string`	# `getAuthorizeUrl( string $userType )` Get authorize endpoint url Get authorize endpoint url Parameters `$userType` `string` $userType Returns `string`
`public string\|null`	# `getOauthToken( )` Retrieve oauth_token param from request Retrieve oauth_token param from request Returns `string\|null`

Methods inherited from Mage_Core_Helper_Abstract
`__(), _cleanCache(), _getModuleName(), _getRequest(), _getUrl(), _loadCache(), _removeCache(), _saveCache(), escapeHtml(), escapeUrl(), getLayout(), isModuleEnabled(), isModuleOutputEnabled(), jsQuoteEscape(), quoteEscape(), removeTags(), setLayout(), stripTags(), translateArray(), urlDecode(), urlEncode()`

Constants summary
`string`	`ENDPOINT_AUTHORIZE_CUSTOMER`	`'oauth/authorize'`	# Endpoint types with appropriate routes Endpoint types with appropriate routes
`string`	`ENDPOINT_AUTHORIZE_ADMIN`	`'adminhtml/oauth_authorize'`	#
`string`	`ENDPOINT_AUTHORIZE_CUSTOMER_SIMPLE`	`'oauth/authorize/simple'`	#
`string`	`ENDPOINT_AUTHORIZE_ADMIN_SIMPLE`	`'adminhtml/oauth_authorize/simple'`	#
`string`	`ENDPOINT_INITIATE`	`'oauth/initiate'`	#
`string`	`ENDPOINT_TOKEN`	`'oauth/token'`	#
`string`	`XML_PATH_CLEANUP_PROBABILITY`	`'oauth/cleanup/cleanup_probability'`	# Cleanup xpath config settings Cleanup xpath config settings
`string`	`XML_PATH_CLEANUP_EXPIRATION_PERIOD`	`'oauth/cleanup/expiration_period'`	#
`string`	`XML_PATH_EMAIL_TEMPLATE`	`'oauth/email/template'`	# Email template Email template
`string`	`XML_PATH_EMAIL_IDENTITY`	`'oauth/email/identity'`	#
`integer`	`CLEANUP_EXPIRATION_PERIOD_DEFAULT`	`120`	# Cleanup expiration period in minutes Cleanup expiration period in minutes
`string`	`QUERY_PARAM_REJECTED`	`'rejected'`	# Query parameter as a sign that user rejects Query parameter as a sign that user rejects

Properties summary
`protected array`	`$_endpoints`	`array( self::ENDPOINT_AUTHORIZE_CUSTOMER, self::ENDPOINT_AUTHORIZE_ADMIN, self::ENDPOINT_AUTHORIZE_CUSTOMER_SIMPLE, self::ENDPOINT_AUTHORIZE_ADMIN_SIMPLE, self::ENDPOINT_INITIATE, self::ENDPOINT_TOKEN )`	# Available endpoints list Available endpoints list

Properties inherited from Mage_Core_Helper_Abstract
`$_layout, $_moduleName, $_request`

Packages

Classes

Class Mage_Oauth_Helper_Data

Parameters

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Throws

Returns

Returns

Parameters

Returns

Parameters

Returns

Returns