brainworxx/kreXX

<?php

/**
 * kreXX: Krumo eXXtended
 *
 * kreXX is a debugging tool, which displays structured information
 * about any PHP object. It is a nice replacement for print_r() or var_dump()
 * which are used by a lot of PHP developers.
 *
 * kreXX is a fork of Krumo, which was originally written by:
 * Kaloyan K. Tsvetkov <kaloyan@kaloyan.info>
 *
 * @author
 *   brainworXX GmbH <info@brainworxx.de>
 *
 * @license
 *   http://opensource.org/licenses/LGPL-2.1
 *
 *   GNU Lesser General Public License Version 2.1
 *
 *   kreXX Copyright (C) 2014-2024 Brainworxx GmbH
 *
 *   This library is free software; you can redistribute it and/or modify it
 *   under the terms of the GNU Lesser General Public License as published by
 *   the Free Software Foundation; either version 2.1 of the License, or (at
 *   your option) any later version.
 *   This library is distributed in the hope that it will be useful, but WITHOUT
 *   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 *   FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
 *   for more details.
 *   You should have received a copy of the GNU Lesser General Public License
 *   along with this library; if not, write to the Free Software Foundation,
 *   Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 */

declare(strict_types=1);

namespace Brainworxx\Krexx\View\Output;

use Brainworxx\Krexx\Service\Factory\Pool;
use Brainworxx\Krexx\Service\Misc\Cleanup;

/**
 * Defining what is needed for an output class.
 */
abstract class AbstractOutput
{
    /**
     * Here we store all relevant data.
     *
     * @var Pool
     */
    protected Pool $pool;

    /**
     * Deleting old chunks and logfiles.
     *
     * @var \Brainworxx\Krexx\Service\Misc\Cleanup
     */
    protected Cleanup $cleanupService;

    /**
     * [0] -> The chunkedup string, that we intend to send to
     *        the browser.
     * [1] -> Are we ignoring local settings?
     *
     * @var string[]
     *   An array of all chunk strings.
     *   A chunk string are:
     *   - header
     *   - messages
     *   - data part
     *   - footer
     *   This means, that every output is split in 4 parts
     */
    protected array $chunkStrings = [];

    /**
     * Injects the pool and register the shutdown function.
     *
     * @param Pool $pool
     *   The pool, where we store the classes we need.
     */
    public function __construct(Pool $pool)
    {
        $this->pool = $pool;
        $this->cleanupService = $pool->createClass(Cleanup::class);
    }

    /**
     * Cleanup stuff, after all is said and done.
     */
    protected function destruct(): void
    {
        $this->cleanupService->cleanupOldChunks();
    }

    /**
     * Adds output to our shutdown handler.
     *
     * @param string $chunkString
     *   The chunked output string.
     *
     * @return $this
     *   Return $this, for chaining.
     */
    public function addChunkString(string $chunkString): AbstractOutput
    {
        $this->chunkStrings[] = $chunkString;
        return $this;
    }

    /**
     * Tell the output service, that we are finished.
     */
    abstract public function finalize(): void;
}