1. class
  2. Cable8mm
  3. \
  4. PortonePhp
  5. \
  6. Client
  7. \
  8. AuthClient

AuthClient

final class AuthClient extends AbstractClient (View source)

인증 API 작업을 제공합니다.

Properties

protected RequestExecutor $executor from  AbstractClient

Methods

__construct(string $apiSecret, RequestExecutor|null $executor = null)

PortOne API Secret과 선택적으로 전달된 공용 요청 실행기로 클라이언트를 초기화합니다.

from  AbstractClient
array
__debugInfo()

인증 정보가 디버그 출력에 노출되지 않도록 빈 정보를 반환합니다.

from  AbstractClient
array
__serialize()

인증 정보가 직렬화되어 노출되지 않도록 직렬화를 거부합니다.

from  AbstractClient
void
__unserialize(array $data)

인증 정보가 포함된 객체의 역직렬화를 거부합니다.

from  AbstractClient
RequestExecutor
createExecutor(string $apiSecret)

No description

from  AbstractClient
object
callOperation(string $operation, string $method, string $path, array $parameters, string $responseClass, bool $requestBody)

No description

from  AbstractClient
Future
callOperationAsync(string $operation, string $method, string $path, array $parameters, string $responseClass, bool $requestBody)

No description

from  AbstractClient
object
callOperationWithQueryAndBody(string $operation, string $method, string $path, array $query, array $body, string $responseClass)

No description

from  AbstractClient
Future
callOperationWithQueryAndBodyAsync(string $operation, string $method, string $path, array $query, array $body, string $responseClass)

No description

from  AbstractClient
object
callOperationWithQueryRequestBody(string $operation, string $method, string $path, array $query, array $body, string $responseClass)

No description

from  AbstractClient
Future
callOperationWithQueryRequestBodyAsync(string $operation, string $method, string $path, array $query, array $body, string $responseClass)

No description

from  AbstractClient
string
callStringOperation(string $operation, string $method, string $path, array $options = [])

No description

from  AbstractClient
Future
callStringOperationAsync(string $operation, string $method, string $path, array $options = [])

No description

from  AbstractClient
string
callStringOperationWithQueryRequestBody(string $operation, string $method, string $path, array $query, array $body)

No description

from  AbstractClient
Future
callStringOperationWithQueryRequestBodyAsync(string $operation, string $method, string $path, array $query, array $body)

No description

from  AbstractClient
void
callUnitOperation(string $operation, string $method, string $path, array $options = [])

No description

from  AbstractClient
Future
callUnitOperationAsync(string $operation, string $method, string $path, array $options = [])

No description

from  AbstractClient
void
callUnitOperationWithQueryAndBody(string $operation, string $method, string $path, array $query, array $body)

No description

from  AbstractClient
Future
callUnitOperationWithQueryAndBodyAsync(string $operation, string $method, string $path, array $query, array $body)

No description

from  AbstractClient
void
callUnitOperationWithQuery(string $operation, string $method, string $path, array $query)

No description

from  AbstractClient
Future
callUnitOperationWithQueryAsync(string $operation, string $method, string $path, array $query)

No description

from  AbstractClient
LoginViaApiSecretResponse
loginViaApiSecret(string|null $apiSecret = null)

API secret 를 사용한 토큰 발급 기능입니다.

Future
loginViaApiSecretAsync(string|null $apiSecret = null)

API secret 를 사용한 토큰 발급 기능입니다.

RefreshTokenResponse
refreshToken(string|null $refreshToken = null)

토큰 갱신 기능입니다.

Future
refreshTokenAsync(string|null $refreshToken = null)

토큰 갱신 기능입니다.

Details

in AbstractClient at line 31
__construct(string $apiSecret, RequestExecutor|null $executor = null)

PortOne API Secret과 선택적으로 전달된 공용 요청 실행기로 클라이언트를 초기화합니다.

Parameters

string $apiSecret

PortOne V2 API 요청 인증에 사용하는 API Secret입니다.
RequestExecutor|null $executor

부모 클라이언트와 공유하는 요청 실행기입니다.

in AbstractClient at line 39
array __debugInfo()

인증 정보가 디버그 출력에 노출되지 않도록 빈 정보를 반환합니다.

Return Value

array

in AbstractClient at line 50
array __serialize()

인증 정보가 직렬화되어 노출되지 않도록 직렬화를 거부합니다.

Return Value

array

in AbstractClient at line 58
void __unserialize(array $data)

인증 정보가 포함된 객체의 역직렬화를 거부합니다.

Parameters

array $data

Return Value

void

in AbstractClient at line 63
protected RequestExecutor createExecutor(string $apiSecret)

No description

Parameters

string $apiSecret

Return Value

RequestExecutor

in AbstractClient at line 72
protected object callOperation(string $operation, string $method, string $path, array $parameters, string $responseClass, bool $requestBody)

No description

Parameters

string $operation
string $method
string $path
array $parameters
string $responseClass
bool $requestBody

Return Value

object

in AbstractClient at line 91
protected Future callOperationAsync(string $operation, string $method, string $path, array $parameters, string $responseClass, bool $requestBody)

No description

Parameters

string $operation
string $method
string $path
array $parameters
string $responseClass
bool $requestBody

Return Value

Future

in AbstractClient at line 116
protected object callOperationWithQueryAndBody(string $operation, string $method, string $path, array $query, array $body, string $responseClass)

No description

Parameters

string $operation
string $method
string $path
array $query
array $body
string $responseClass

Return Value

object

in AbstractClient at line 136
protected Future callOperationWithQueryAndBodyAsync(string $operation, string $method, string $path, array $query, array $body, string $responseClass)

No description

Parameters

string $operation
string $method
string $path
array $query
array $body
string $responseClass

Return Value

Future

in AbstractClient at line 161
protected object callOperationWithQueryRequestBody(string $operation, string $method, string $path, array $query, array $body, string $responseClass)

No description

Parameters

string $operation
string $method
string $path
array $query
array $body
string $responseClass

Return Value

object

in AbstractClient at line 181
protected Future callOperationWithQueryRequestBodyAsync(string $operation, string $method, string $path, array $query, array $body, string $responseClass)

No description

Parameters

string $operation
string $method
string $path
array $query
array $body
string $responseClass

Return Value

Future

in AbstractClient at line 202
protected string callStringOperation(string $operation, string $method, string $path, array $options = [])

No description

Parameters

string $operation
string $method
string $path
array $options

Return Value

string

in AbstractClient at line 213
protected Future callStringOperationAsync(string $operation, string $method, string $path, array $options = [])

No description

Parameters

string $operation
string $method
string $path
array $options

Return Value

Future

in AbstractClient at line 230
protected string callStringOperationWithQueryRequestBody(string $operation, string $method, string $path, array $query, array $body)

No description

Parameters

string $operation
string $method
string $path
array $query
array $body

Return Value

string

in AbstractClient at line 239
protected Future callStringOperationWithQueryRequestBodyAsync(string $operation, string $method, string $path, array $query, array $body)

No description

Parameters

string $operation
string $method
string $path
array $query
array $body

Return Value

Future

in AbstractClient at line 245
protected void callUnitOperation(string $operation, string $method, string $path, array $options = [])

No description

Parameters

string $operation
string $method
string $path
array $options

Return Value

void

in AbstractClient at line 251
protected Future callUnitOperationAsync(string $operation, string $method, string $path, array $options = [])

No description

Parameters

string $operation
string $method
string $path
array $options

Return Value

Future

in AbstractClient at line 268
protected void callUnitOperationWithQueryAndBody(string $operation, string $method, string $path, array $query, array $body)

No description

Parameters

string $operation
string $method
string $path
array $query
array $body

Return Value

void

in AbstractClient at line 277
protected Future callUnitOperationWithQueryAndBodyAsync(string $operation, string $method, string $path, array $query, array $body)

No description

Parameters

string $operation
string $method
string $path
array $query
array $body

Return Value

Future

in AbstractClient at line 283
protected void callUnitOperationWithQuery(string $operation, string $method, string $path, array $query)

No description

Parameters

string $operation
string $method
string $path
array $query

Return Value

void

in AbstractClient at line 289
protected Future callUnitOperationWithQueryAsync(string $operation, string $method, string $path, array $query)

No description

Parameters

string $operation
string $method
string $path
array $query

Return Value

Future

at line 21
LoginViaApiSecretResponse loginViaApiSecret(string|null $apiSecret = null)

API secret 를 사용한 토큰 발급 기능입니다.

API secret 를 통해 API 인증에 사용할 토큰을 가져옵니다.

Parameters

string|null $apiSecret

발급받은 API secret

Return Value

LoginViaApiSecretResponse

at line 33
Future loginViaApiSecretAsync(string|null $apiSecret = null)

API secret 를 사용한 토큰 발급 기능입니다.

API secret 를 통해 API 인증에 사용할 토큰을 가져옵니다. 비동기 요청을 시작하며, 반환된 Future에서 결과를 기다릴 수 있습니다.

Parameters

string|null $apiSecret

발급받은 API secret

Return Value

Future

at line 44
RefreshTokenResponse refreshToken(string|null $refreshToken = null)

토큰 갱신 기능입니다.

리프레시 토큰을 사용해 유효기간이 연장된 새로운 토큰을 재발급합니다.

Parameters

string|null $refreshToken

리프레시 토큰

Return Value

RefreshTokenResponse

at line 56
Future refreshTokenAsync(string|null $refreshToken = null)

토큰 갱신 기능입니다.

리프레시 토큰을 사용해 유효기간이 연장된 새로운 토큰을 재발급합니다. 비동기 요청을 시작하며, 반환된 Future에서 결과를 기다릴 수 있습니다.

Parameters

string|null $refreshToken

리프레시 토큰

Return Value

Future