AccountFlagsResponse
in package
Represents authorization flags set on an issuing account
Authorization flags control how an asset issuer manages trustlines to their issued assets. These flags determine whether holders need authorization and whether authorization can be revoked.
Flag meanings:
- AUTH_REQUIRED: Trustlines to this issuer's assets must be authorized
- AUTH_REVOCABLE: The issuer can revoke authorization of existing trustlines
- AUTH_IMMUTABLE: The issuer cannot change authorization flags in the future
- AUTH_CLAWBACK_ENABLED: The issuer can clawback assets from holders
This response is included in AccountResponse for asset issuing accounts.
Tags
Table of Contents
Methods
- fromJson() : AccountFlagsResponse
- Creates an AccountFlagsResponse instance from JSON data
- isAuthClawbackEnabled() : bool
- Checks if clawback is enabled for this account's issued assets
- isAuthImmutable() : bool
- Checks if authorization flags are immutable
- isAuthRequired() : bool
- Checks if the account requires authorization for trustlines
- isAuthRevocable() : bool
- Checks if the account can revoke authorization
- loadFromJson() : void
Methods
fromJson()
Creates an AccountFlagsResponse instance from JSON data
public
static fromJson(array<string|int, mixed> $json) : AccountFlagsResponse
Parameters
- $json : array<string|int, mixed>
-
The JSON array containing flag data from Horizon
Return values
AccountFlagsResponse —The parsed flags response
isAuthClawbackEnabled()
Checks if clawback is enabled for this account's issued assets
public
isAuthClawbackEnabled() : bool
When true, the issuer can clawback assets from holder accounts.
Return values
bool —True if clawback is enabled
isAuthImmutable()
Checks if authorization flags are immutable
public
isAuthImmutable() : bool
When true, the issuer cannot change authorization flags in the future.
Return values
bool —True if flags are immutable
isAuthRequired()
Checks if the account requires authorization for trustlines
public
isAuthRequired() : bool
When true, trustlines to this issuer's assets require explicit authorization.
Return values
bool —True if authorization is required
isAuthRevocable()
Checks if the account can revoke authorization
public
isAuthRevocable() : bool
When true, the issuer can revoke authorization from existing trustlines.
Return values
bool —True if authorization is revocable
loadFromJson()
protected
loadFromJson(array<string|int, mixed> $json) : void
Parameters
- $json : array<string|int, mixed>