PHP 클래스 Pheal\Pheal

파일 보기 프로젝트 열기: 3rdpartyeve/phealng 1 사용 예제들

공개 프로퍼티들

프로퍼티 타입 설명
$scope string ..)
$xml String Result of the last XML request, so application can use the raw xml data

공개 메소드들

메소드 설명
__call ( String $name, array $arguments ) : Pheal\Core\Result Magic __call method, will translate all function calls to object to API requests
__construct ( integer $userid = null, string $key = null, string $scope = 'account' ) creates new Pheal API object
__get ( string $name ) : Pheal | null Magic __get method used to set scope
clearAccess ( ) : void clear+reset keyType/accessMask
detectAccess ( ) : boolean | Pheal\Core\Result if userid+key is given it automatically detects (api call) the keyinfo and set the correct access level for futher checks.
setAccess ( string $keyType = null, integer $accessMask ) : void Set keyType/accessMask

비공개 메소드들

메소드 설명
requestXml ( string $scope, string $name, array $opts = [] ) : Pheal\Core\Result method will ask caching class for valid xml, if non valid available will make API call, and return the appropriate result

메소드 상세

__call() 공개 메소드

Magic __call method, will translate all function calls to object to API requests
public __call ( String $name, array $arguments ) : Pheal\Core\Result
$name String name of the function
$arguments array an array of arguments
리턴 Pheal\Core\Result

__construct() 공개 메소드

creates new Pheal API object
public __construct ( integer $userid = null, string $key = null, string $scope = 'account' )
$userid integer the EVE userid/keyID
$key string the EVE apikey/vCode
$scope string to use, defaults to account. can be changed during runtime by modifying attribute "scope"

__get() 공개 메소드

Magic __get method used to set scope
public __get ( string $name ) : Pheal | null
$name string name of the scope e.g. "mapScope"
리턴 Pheal | null

clearAccess() 공개 메소드

clear+reset keyType/accessMask
public clearAccess ( ) : void
리턴 void

detectAccess() 공개 메소드

Keep in mind this method will make an api request to account/APIKeyInfo based on the given \Pheal\Core\Config settings with the given key credentials. More important! This method will throw Exceptions on invalid keys or networks errors So place this call into your try statement
public detectAccess ( ) : boolean | Pheal\Core\Result
리턴 boolean | Pheal\Core\Result

setAccess() 공개 메소드

Set keyType/accessMask
public setAccess ( string $keyType = null, integer $accessMask ) : void
$keyType string must be Account/Character/Corporation or null
$accessMask integer must be integer or 0
리턴 void

프로퍼티 상세

$scope 공개적으로 프로퍼티

..)
public string $scope
리턴 string

$xml 공개적으로 프로퍼티

Result of the last XML request, so application can use the raw xml data
public String $xml
리턴 String