xplo.re Medusa Core Framework 3.2
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Event
  • Todo
  • Download

Namespaces

  • Core
    • Authentication
      • Auto
        • Driver
      • Driver
    • Cache
      • Driver
    • Charset
      • Driver
    • Configuration
      • Driver
    • Controller
    • Converter
      • Driver
    • Decoder
      • Driver
    • Encoder
      • Driver
    • Env
      • Authentication
      • Locale
      • Proxy
      • Server
        • HTTP
        • Redirect
        • X
    • Exception
    • Exchange
      • Driver
    • Fault
      • Formatter
        • Driver
      • Incident
        • Exception
      • Reporter
        • Driver
    • Field
    • Filter
      • Driver
    • Formatter
      • Driver
        • coreuimarkup
          • Token
    • Hash
    • Loader
    • Locale
    • Log
      • Driver
    • Module
      • Dependency
        • Requirement
          • Core
          • PHP
      • Linkage
        • Driver
    • PDF
    • Plugin
    • Query
      • Driver
    • Server
      • Driver
    • Session
      • Driver
    • Set
    • Storage
      • Driver
      • Field
        • Element
    • Stream
      • Driver
    • String
    • Translation
      • Driver
      • Language
        • Driver
    • Type
    • URI
      • Driver
    • Version
    • View
      • Driver
        • coreui
          • Control
            • Button
            • Table
          • Element
        • htmlbuilder
          • Tags
        • yui
          • Modules
  • None
  • PHP

Classes

  • mailto
  • stdout

Class mailto

Render an email-based report and sends it out to a configured recipient.

Multiple email reports for different incidents during the same request are automatically grouped by the fault instance UUID (this should be done automatically by most email programs). For automatic processing, additional headers are embedded:

  • X-Medusa-Core-Fault-Reference Request reference identifier, usually used to communicate an incident, i.e. by giving to the user as a short reference.

  • X-Medusa-Core-Fault-Instance Contains the UUID of the fault instance (used to identify the request; if incidents are stored via another reporter, the request UUID should be stored along with them).

  • X-Medusa-Core-Fault-Host Hostname as returned by the Core\Fault\Reporter\Driver\mailto::senderHostname() method.

  • X-Medusa-Core-Fault-Index Incident counter value (index per request) at the time the mail was generated. Can be used to sort incidents within a single request. Format: *value* "/" *configured limit*.

  • X-Medusa-Core-Fault-Level Incident level counter value. If greater than 1, the reported incident occurred while another incident is already being handled. Format: *value* "/" *configured limit*.

  • X-Medusa-Core-Incident-Type Incident type being reported.

  • X-Medusa-Core-Incident-Code Code of incident being reported.

  • X-Medusa-Core-Incident-Recoverable YES, if reported incident is recoverable, otherwise NO.

  • X-Medusa-Core-Incident-Silent YES, if reported incident is silent, otherwise NO.

Core\Object implements Core\Chainable
Extended by Core\Set implements Core\Accessor
Extended by Core\Fault\Reporter
Extended by Core\Fault\Reporter\Driver\mailto
Namespace: Core\Fault\Reporter\Driver
Package: Core\Fault\Reporter
Since: 3.2
Requires: PHP 5.3
Version: 1.0
Located at Fault/Reporter/Driver/mailto.inc.php

Methods summary

public
# __construct( Core\URI $uri )

Driver initialisation.

Driver initialisation.

Parameters

$uri
Driver configuration URI.

Since

3.2

Overrides

Core\Fault\Reporter::__construct
protected string[]
# _renderIntroduction( Core\Fault\Incident $incident, array $formatters, string $title )

Parameters

$incident
$formatters
$title

Returns

string[]
public
# report( Core\Fault\Incident $incident )

Reports an incident.

Reports an incident.

Parameters

$incident
Incident to report.

Since

3.2
public string
# sender( )

Returns the formatted sender name of email reports.

Returns the formatted sender name of email reports.

Returns

string
Formatted sender name as used in From mail header.

Since

3.2
public string
# senderHostname( )

Derives a sender hostname from the environment.

Derives a sender hostname from the environment.

Returns

string

Sender hostname derived from the environment. Defaults to the server name and falls back to an encoded IP address if no server name is specified.

Since

3.2
public string
# subject( string $title )

Returns the subject line used by mail reports.

Returns the subject line used by mail reports.

Parameters

$title
Application title to format subject for.

Returns

string
Subject line as used by mail reports.

Since

3.2

Methods inherited from Core\Fault\Reporter

autocreate()

Methods inherited from Core\Set

__get(), __isset()

Methods inherited from Core\Object

__autocreateFactory(), __call(), __processParameters(), __toString(), attachMethod(), chain(), getValueForKey(), getValueForKeyPath(), getValueForUndefinedKey(), hash(), issetValueForKey(), setValueForKey(), setValueForKeyPath(), setValueForUndefinedKey(), uuid()

Constants summary

Constants inherited from Core\Object

AnyParameterType, AutochainParameterType, AutocreateParameterType, BooleanParameterType, CharParameterType, EnumParameterType, IntegerParameterType, RealParameterType, StringParameterType, UserParameterType

Properties summary

protected string $_v_recipient

Recipient from configuration URI.

Recipient from configuration URI.

Since

3.2
#

Magic properties inherited from Core\Object

$hash, $uuid

xplo.re Medusa Core Framework 3.2 API documentation generated by ApiGen