Sage Intacct SDK for PHP
MessageFormatter Class Reference
Inheritance diagram for MessageFormatter:

Public Member Functions

 __construct ($template=self::DEBUG)
 
 format (RequestInterface $request, ResponseInterface $response=null, \Exception $error=null)
 

Data Fields

const CLF = "{hostname} {req_header_User-Agent} - [{date_common_log}] \"{method} {target} HTTP/{version}\" {code} {res_header_Content-Length}"
 
const DEBUG = ">>>>>>>>\n{request}\n<<<<<<<<\n{response}\n--------\n{error}"
 
const SHORT = '[{ts}] "{method} {target} HTTP/{version}" {code}'
 

Constructor & Destructor Documentation

◆ __construct()

__construct (   $template = self::DEBUG)

Formats log messages using variable substitutions for requests, responses, and other transactional data.

Parameters
string$templateThe following variable substitutions are supported:
  • {request}: Full HTTP request message
  • {response}: Full HTTP response message
  • {ts}: ISO 8601 date in GMT
  • {date_iso_8601}: ISO 8601 date in GMT
  • {date_common_log}: Apache common log date using the configured timezone.
  • {host}: Host of the request
  • {method}: Method of the request
  • {uri}: URI of the request
  • {host}: Host of the request
  • {version}: Protocol version
  • {target}: Request target of the request (path + query + fragment)
  • {hostname}: Hostname of the machine that sent the request
  • {code}: Status code of the response (if available)
  • {phrase}: Reason phrase of the response (if available)
  • {error}: Any error messages (if available)
  • {req_header_*}: Replace * with the lowercased name of a request header to add to the message
  • {res_header_*}: Replace * with the lowercased name of a response header to add to the message
  • {req_headers}: Request headers
  • {res_headers}: Response headers
  • {req_body}: Request body
  • {res_body}: Response body

Member Function Documentation

◆ format()

format ( RequestInterface  $request,
ResponseInterface  $response = null,
\Exception  $error = null 
)

Field Documentation

◆ CLF

const CLF = "{hostname} {req_header_User-Agent} - [{date_common_log}] \"{method} {target} HTTP/{version}\" {code} {res_header_Content-Length}"

◆ DEBUG

const DEBUG = ">>>>>>>>\n{request}\n<<<<<<<<\n{response}\n--------\n{error}"

◆ SHORT

const SHORT = '[{ts}] "{method} {target} HTTP/{version}" {code}'