1. class
  2. Intacct
  3. QueryClient

QueryClient

class QueryClient extends AbstractClient

Constants

PROFILE_ENV_NAME

Profile environment name
DEFAULT_MAX_TOTAL_COUNT

Methods

__construct(array $params = array())

Initializes the class with the given parameters.

from AbstractClient
string
generateRandomControlId()

Generate a version 4 (random) UUID

from AbstractClient
int
getMaxTotalCount()

No description

setMaxTotalCount(int $maxTotalCount)

No description

ArrayIterator
executeQuery(ReadByQuery $query, int $maxTotalCount = self::DEFAULT_MAX_TOTAL_COUNT, array $params = array())

No description

Details

in AbstractClient at line line 71
__construct(array $params = array())

Initializes the class with the given parameters.

The constructor accepts the following options:

  • profile_name (string, default=string "default") Profile name to use
  • profile_file (string) Profile file to load from
  • sender_id (string) Intacct sender ID
  • sender_password (string) Intacct sender password
  • session_id (string) Intacct session ID
  • endpoint_url (string) Endpoint URL
  • company_id (string) Intacct company ID
  • user_id (string) Intacct user ID
  • user_password (string) Intacct user password
  • max_retries (int, default=int(5)) Max number of retries
  • no_retry_server_error_codes (int[], default=array(524)) HTTP server error codes to abort retrying if one occurs
  • verify_ssl (bool, default=bool(true)) Verify SSL certificate of response
  • logger (Psr\Log\LoggerInterface)
  • log_formatter (Intacct\Logging\MessageFormatter) Log formatter
  • log_level (int, default=int(400)) Log level
  • mock_handler (GuzzleHttp\Handler\MockHandler) Mock handler for unit tests

Parameters

array $params Client configuration options

in AbstractClient at line line 139
string generateRandomControlId()

Generate a version 4 (random) UUID

Return Value

string

at line line 38
int getMaxTotalCount()

Return Value

int

at line line 46
setMaxTotalCount(int $maxTotalCount)

Parameters

int $maxTotalCount

at line line 59
ArrayIterator executeQuery(ReadByQuery $query, int $maxTotalCount = self::DEFAULT_MAX_TOTAL_COUNT, array $params = array())

Parameters

ReadByQuery $query
int $maxTotalCount
array $params Overriding params

Return Value

ArrayIterator

Exceptions

ResultException