Configuration

Global configuration is performed by setting properties directly on the \Files\Files class.

Configuration Options

Auto Paginate

Auto-fetch all pages when results span multiple pages. The default value is true.

Example setting

\Files\Files::$autoPaginate = false

Base URL

Set this to the full https:// URL of your Files.com subdomain (e.g. https://MY-SUBDOMAIN.files.com). This is not required in most cases, but one benefit of setting it is that it ensures that authentication failures will be logged to your site's API logs. Without setting this, we won't know which site to associate the authentication failure with, and it won't be logged to your site's API logs. This is always required if your site is configured to disable global acceleration. This can also be set to use a mock server in development or CI.

Example setting

\Files\Files::setBaseUrl('https://MY-SUBDOMAIN.files.com');

Log Level

Supported values:

  • \Files\LogLevel::NONE
  • \Files\LogLevel::ERROR
  • \Files\LogLevel::WARN
  • \Files\LogLevel::INFO (default)
  • \Files\LogLevel::DEBUG

Example setting

\Files\Files::$logLevel = \Files\LogLevel::DEBUG

Debug Requests

Enable debug logging of API requests. The default value is false.

Example setting

\Files\Files::$debugRequest = true

Debug Response Headers

Enable debug logging of API response headers. The default value is false.

Example setting

\Files\Files::$debugResponseHeaders = true

Connect Timeout

Network connect timeout in seconds. The default value is 30.0.

Example setting

\Files\Files::$connectTimeout = 20.0

Read Timeout

Network read timeout in seconds. The default value is 60.0.

Example setting

\Files\Files::$readTimeout = 60

Minimum Retry Delay

Minimum network delay in seconds before retrying. The default value is 0.5.

Example setting

\Files\Files::$minNetworkRetryDelay = 1.0

Maximum Retry Delay

Maximum network delay in seconds before retrying. The default value is 1.5.

Example setting

\Files\Files::$maxNetworkRetryDelay = 3.0

Maximum Network Retries

Maximum number of retries. The default value is 3.

Example setting

\Files\Files::$maxNetworkRetries = 5