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\Analyse\Scalar;

use Brainworxx\Krexx\Analyse\Scalar\String\Base64;
use Brainworxx\Krexx\Analyse\Scalar\String\Callback;
use Brainworxx\Krexx\Analyse\Scalar\String\ClassName;
use Brainworxx\Krexx\Analyse\Scalar\String\FilePath;
use Brainworxx\Krexx\Analyse\Scalar\String\Json;
use Brainworxx\Krexx\Analyse\Scalar\String\Serialized;
use Brainworxx\Krexx\Analyse\Scalar\String\TimeStamp;
use Brainworxx\Krexx\Analyse\Scalar\String\Xml;
use Brainworxx\Krexx\Analyse\Model;
use Brainworxx\Krexx\Service\Factory\Pool;
use Brainworxx\Krexx\Service\Plugin\SettingsGetter;

/**
 * Deeper analyses methods for strings.
 *
 * We also inject a callback for a deeper analysis for more complex stuff.
 *   - callback
 *   - absolute file path
 *   - json
 *   - xml
 */
class ScalarString extends AbstractScalar
{
    /**
     * The list of analysis classes, that we use.
     *
     * @var \Brainworxx\Krexx\Analyse\Scalar\String\AbstractScalarAnalysis[]
     */
    protected array $classList = [];

    /**
     * Get the additional analysis classes from the plugins.
     *
     * @param \Brainworxx\Krexx\Service\Factory\Pool $pool
     */
    public function __construct(Pool $pool)
    {
        $classList = [
            Callback::class,
            FilePath::class,
            Json::class,
            Xml::class,
            TimeStamp::class,
            Serialized::class,
            Base64::class,
            ClassName::class
        ];

        $classList = [...$classList, ...SettingsGetter::getAdditionalScalarString()];

        foreach ($classList as $className) {
            if ($className::isActive()) {
                $this->classList[$className] = $pool->createClass($className);
            }
        }

        parent::__construct($pool);
    }

    /**
     * Doing special analysis with strings.
     *
     * @param Model $model
     *   The model, so far.
     *
     * @param string $originalData
     *   The original string, unprocessed and unescaped.
     *
     * @return Model
     *   The adjusted model.
     */
    public function handle(Model $model, string $originalData): Model
    {
        foreach ($this->classList as $className => $analyser) {
            if ($analyser->canHandle($originalData, $model)) {
                return $model->injectCallback($analyser)
                    ->setDomid($this->generateDomId($originalData, $className));
            }
        }

        return $model;
    }
}