AC_services_website_design/system/ThirdParty/Kint/Renderer/AbstractRenderer.php

176 lines
4.9 KiB
PHP
Raw Permalink Normal View History

2024-03-13 12:38:15 +00:00
<?php
declare(strict_types=1);
/*
* The MIT License (MIT)
*
* Copyright (c) 2013 Jonathan Vollebregt (jnvsor@gmail.com), Rokas Šleinius (raveren@gmail.com)
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of
* this software and associated documentation files (the "Software"), to deal in
* the Software without restriction, including without limitation the rights to
* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
* the Software, and to permit persons to whom the Software is furnished to do so,
* subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
namespace Kint\Renderer;
use Kint\Zval\InstanceValue;
use Kint\Zval\Value;
/**
* @psalm-type PluginMap array<string, class-string>
*
* @psalm-consistent-constructor
*/
abstract class AbstractRenderer implements RendererInterface
{
public const SORT_NONE = 0;
public const SORT_VISIBILITY = 1;
public const SORT_FULL = 2;
protected $call_info = [];
protected $statics = [];
protected $show_trace = true;
public function setCallInfo(array $info): void
{
if (!isset($info['modifiers']) || !\is_array($info['modifiers'])) {
$info['modifiers'] = [];
}
if (!isset($info['trace']) || !\is_array($info['trace'])) {
$info['trace'] = [];
}
$this->call_info = [
'params' => $info['params'] ?? null,
'modifiers' => $info['modifiers'],
'callee' => $info['callee'] ?? null,
'caller' => $info['caller'] ?? null,
'trace' => $info['trace'],
];
}
public function getCallInfo(): array
{
return $this->call_info;
}
public function setStatics(array $statics): void
{
$this->statics = $statics;
$this->setShowTrace(!empty($statics['display_called_from']));
}
public function getStatics(): array
{
return $this->statics;
}
public function setShowTrace(bool $show_trace): void
{
$this->show_trace = $show_trace;
}
public function getShowTrace(): bool
{
return $this->show_trace;
}
public function filterParserPlugins(array $plugins): array
{
return $plugins;
}
public function preRender(): string
{
return '';
}
public function postRender(): string
{
return '';
}
/**
* Returns the first compatible plugin available.
*
* @psalm-param PluginMap $plugins Array of hints to class strings
* @psalm-param string[] $hints Array of object hints
*
* @psalm-return PluginMap Array of hints to class strings filtered and sorted by object hints
*/
public function matchPlugins(array $plugins, array $hints): array
{
$out = [];
foreach ($hints as $key) {
if (isset($plugins[$key])) {
$out[$key] = $plugins[$key];
}
}
return $out;
}
public static function sortPropertiesFull(Value $a, Value $b): int
{
$sort = Value::sortByAccess($a, $b);
if ($sort) {
return $sort;
}
$sort = Value::sortByName($a, $b);
if ($sort) {
return $sort;
}
return InstanceValue::sortByHierarchy($a->owner_class, $b->owner_class);
}
/**
* Sorts an array of Value.
*
* @param Value[] $contents Object properties to sort
*
* @return Value[]
*/
public static function sortProperties(array $contents, int $sort): array
{
switch ($sort) {
case self::SORT_VISIBILITY:
// Containers to quickly stable sort by type
$containers = [
Value::ACCESS_PUBLIC => [],
Value::ACCESS_PROTECTED => [],
Value::ACCESS_PRIVATE => [],
Value::ACCESS_NONE => [],
];
foreach ($contents as $item) {
$containers[$item->access][] = $item;
}
return \call_user_func_array('array_merge', $containers);
case self::SORT_FULL:
\usort($contents, [self::class, 'sortPropertiesFull']);
// no break
default:
return $contents;
}
}
}