n2n Page Rocket 1 API

n2n\log4php

­Logger­Filter

abstract LoggerFilter extends LoggerConfigurable
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.

Constant summary

Property summary

Modifier and Type Property
protected LoggerFilter next

Methods summary

Modifier and Type Method
public activateOptions ( )
public integer decide ( LoggingEvent event )
public addNext ( unknown filter )
public the getNext ( )

Constants in detail

  • ACCEPT

    ­ const ACCEPT ­
    The log event must be logged immediately without consulting with the remaining filters, if any, in the chain.

  • NEUTRAL

    ­ const NEUTRAL ­
    This filter is neutral with respect to the log event. The remaining filters, if any, should be consulted for a final decision.

  • DENY

    ­ const DENY ­
    The log event must be dropped immediately without consulting with the remaining filters, if any, in the chain.

Properties in detail

Methods in detail

  • activateOptions

    public activateOptions ( )
    Usually filters options become active when set. We provide a default do-nothing implementation for convenience.

  • decide

    integer public decide ( LoggingEvent event )
    Decide what to do. <p>If the decision is LoggerFilter::DENY, then the event will be dropped. If the decision is LoggerFilter::NEUTRAL, then the next filter, if any, will be invoked. If the decision is LoggerFilter::ACCEPT then the event will be logged without consulting with other filters in the chain.
    param
    LoggingEvent The LoggingEvent to decide upon.
    return
    integer

  • addNext

    public addNext ( unknown filter )
    Adds a new filter to the filter chain this filter is a part of. If this filter has already and follow up filter, the param filter is passed on until it is the last filter in chain.
    param
    $filter - - the filter to add to this chain

  • getNext

    the public getNext ( )
    Returns the next filter in this chain
    return
    n2n\log4php\the