n2n Page Rocket 1 API

n2n\log4php\pattern

­Pattern­Converter

abstract PatternConverter
Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to You under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Property summary

Modifier and Type Property
public PatternConverter next
protected FormattingInfo formattingInfo
protected array option

Methods summary

Modifier and Type Method
public __construct ( FormattingInfo formattingInfo = null , array option = null )
public activateOptions ( )
public convert ( LoggingEvent event )
public format ( LoggingEvent event )

Properties in detail

  • next

    public ­ ­ PatternConverter ­ next
    Next converter in the converter chain.
    var
    PatternConverter

  • formattingInfo

    protected ­ ­ FormattingInfo ­ formattingInfo
    Formatting information, parsed from pattern modifiers.
    var
    FormattingInfo

  • option

    protected ­ ­ array ­ option
    Converter-specific formatting options.
    var
    array

Methods in detail

  • __construct

    public __construct ( FormattingInfo formattingInfo = null , array option = null )
    Constructor
    param
    array option

  • activateOptions

    public activateOptions ( )
    Called in constructor. Converters which need to process the options can override this method.

  • convert

    public convert ( LoggingEvent event )
    Converts the logging event to the desired format. Derived pattern converters must implement this method.

  • format

    public format ( LoggingEvent event )
    Converts the event and formats it according to setting in the Formatting information object.
    param
    string &$sbuf &$sbuf string buffer to write to
    LoggingEvent Event to be formatted.