Documentation

ElasticaFormatter extends NormalizerFormatter
in package

Format a log message into an Elastica Document

Tags
author

Jelle Vink jelle.vink@gmail.com

Table of Contents

Constants

SIMPLE_DATE  = "Y-m-d H:i:s"

Properties

$dateFormat  : mixed
$index  : string
$type  : string

Methods

__construct()  : mixed
format()  : mixed
Formats a log record.
formatBatch()  : mixed
Formats a set of log records.
getIndex()  : string
Getter index
getType()  : string
Getter type
getDocument()  : Document
Convert a log message into an Elastica Document
normalize()  : mixed
normalizeException()  : mixed
toJson()  : string
Return the JSON representation of a value

Constants

Properties

Methods

__construct()

public __construct(string $index, string $type) : mixed
Parameters
$index : string

Elastic Search index name

$type : string

Elastic Search document type

format()

Formats a log record.

public format(array<string|int, mixed> $record) : mixed
Parameters
$record : array<string|int, mixed>

A record to format

Return values
mixed

The formatted record

formatBatch()

Formats a set of log records.

public formatBatch(array<string|int, mixed> $records) : mixed
Parameters
$records : array<string|int, mixed>

A set of records to format

Return values
mixed

The formatted set of records

getDocument()

Convert a log message into an Elastica Document

protected getDocument(array<string|int, mixed> $record) : Document
Parameters
$record : array<string|int, mixed>

Log message

Return values
Document

normalize()

protected normalize(mixed $data[, mixed $depth = 0 ]) : mixed
Parameters
$data : mixed
$depth : mixed = 0

normalizeException()

protected normalizeException(mixed $e) : mixed
Parameters
$e : mixed

toJson()

Return the JSON representation of a value

protected toJson(mixed $data[, bool $ignoreErrors = false ]) : string
Parameters
$data : mixed
$ignoreErrors : bool = false
Tags
throws
RuntimeException

if encoding fails and errors are not ignored

Return values
string

        
On this page

Search results