PHP Класс Gpf_Api_Session

Наследование: extends Gpf_Object

Показать файл Открыть проект Примеры использования класса

Открытые методы

Метод	Описание
__construct ( $url )
getAPIVersion ( $fileName = __FILE__ ) : String
getAppVersion ( ) : string	Get version of installed application
getDebug ( )
getMessage ( )
getRoleType ( )
getSessionId ( )
getUrl ( )
getUrlWithSessionInfo ( $url )
login ( $username, $password, $roleType = self::MERCHANT, $languageCode = null ) : boolean
loginWithAuthToken ( $authtoken, $roleType = self::MERCHANT, $languageCode = null ) : boolean
setDebug ( $debug = true )
setSessionId ( $sessionId, $roleType = self::MERCHANT )

Защищенные методы

Метод	Описание
checkApiVersion ( Gpf_Rpc_Form $form )	Check API version (has to be protected because of Drupal integration)
getAuthenticateClassName ( )

Приватные методы

Метод	Описание
authenticateRequest ( $username, $password, $authtoken, $roleType = self::MERCHANT, $languageCode = null ) : boolean
setMessage ( $msg )

Описание методов

__construct() публичный Метод

public __construct ( $url )

checkApiVersion() защищенный Метод

Check API version (has to be protected because of Drupal integration)

protected checkApiVersion ( Gpf_Rpc_Form $form )
$form	Gpf_Rpc_Form

getAPIVersion() публичный статический Метод

public static getAPIVersion ( $fileName = __FILE__ ) : String
Результат	String

getAppVersion() публичный Метод

Get version of installed application

public getAppVersion ( ) : string
Результат	string	version of installed application

getAuthenticateClassName() защищенный Метод

protected getAuthenticateClassName ( )

getDebug() публичный Метод

public getDebug ( )

getMessage() публичный Метод

public getMessage ( )

getRoleType() публичный Метод

public getRoleType ( )

getSessionId() публичный Метод

public getSessionId ( )

getUrl() публичный Метод

public getUrl ( )

getUrlWithSessionInfo() публичный Метод

public getUrlWithSessionInfo ( $url )

login() публичный Метод

public login ( $username, $password, $roleType = self::MERCHANT, $languageCode = null ) : boolean
$username
$password
$roleType		Gpf_Api_Session::MERCHANT or Gpf_Api_Session::AFFILIATE
$languageCode		language code (e.g. en-US, de-DE, sk, cz, du, ...)
Результат	boolean	true if user was successfully logged

loginWithAuthToken() публичный Метод

public loginWithAuthToken ( $authtoken, $roleType = self::MERCHANT, $languageCode = null ) : boolean
$authtoken
$roleType		Gpf_Api_Session::MERCHANT or Gpf_Api_Session::AFFILIATE
$languageCode		language code (e.g. en-US, de-DE, sk, cz, du, ...)
Результат	boolean	true if user was successfully logged

setDebug() публичный Метод

public setDebug ( $debug = true )

setSessionId() публичный Метод

public setSessionId ( $sessionId, $roleType = self::MERCHANT )