library/log4php/LoggerThrowableInformation.php
author Markus Bröker <broeker.markus@googlemail.com>
Thu, 12 Nov 2015 14:39:16 +0100
changeset 0 4869aea77e21
permissions -rw-r--r--
Bröker-Framework BFW-1

<?php
/**
 * 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.
 *
 * @package log4php
 */

/**
 * The internal representation of throwables.
 *
 * @package log4php
 * @since 2.1
 */
class LoggerThrowableInformation {

    /** @var Exception Throwable to log */
    private $throwable;

    /** @var array Array of throwable messages */
    private $throwableArray;

    /**
     * Create a new instance
     *
     * @param $throwable - a throwable as a exception
     * @param $logger - Logger reference
     */
    public function __construct(Exception $throwable) {
        $this->throwable = $throwable;
    }

    /**
     * Return source exception
     *
     * @return Exception
     */
    public function getThrowable() {
        return $this->throwable;
    }

    /**
     * @desc Returns string representation of throwable
     *
     * @return array
     */
    public function getStringRepresentation() {
        if (!is_array($this->throwableArray)) {
            $renderer = new LoggerRendererException();

            $this->throwableArray = explode("\n", $renderer->render($this->throwable));
        }

        return $this->throwableArray;
    }
}