src/Debug/Dump/Html/AbstractObjectSection.php
<?php
/**
* This file is part of PHPDebugConsole
*
* @package PHPDebugConsole
* @author Brad Kent <bkfake-github@yahoo.com>
* @license http://opensource.org/licenses/MIT MIT
* @copyright 2014-2024 Brad Kent
* @version v3.1
*/
namespace bdk\Debug\Dump\Html;
use bdk\Debug\Abstraction\Abstracter;
use bdk\Debug\Abstraction\AbstractObject;
use bdk\Debug\Abstraction\Object\Abstraction as ObjectAbstraction;
use bdk\Debug\Dump\Html\Helper;
use bdk\Debug\Dump\Html\Value as ValDumper;
use bdk\Debug\Utility\Html as HtmlUtil;
/**
* Base class for dumping object constants/enum-cases/properties/methods
*/
abstract class AbstractObjectSection
{
/** @var Helper */
protected $helper;
/** @var HtmlUtil */
protected $html;
/** @var ValDumper */
protected $valDumper;
/**
* Constructor
*
* @param ValDumper $valDumper Html dumper
* @param Helper $helper Html dump helpers
* @param HtmlUtil $html Html methods
*/
public function __construct(ValDumper $valDumper, Helper $helper, HtmlUtil $html)
{
$this->valDumper = $valDumper;
$this->helper = $helper;
$this->html = $html;
}
/**
* Iterate over cases, constants, properties, or methods
*
* @param ObjectAbstraction $abs Object abstraction
* @param string $what 'cases', 'constants', 'properties', or 'methods'
* @param array $cfg config options
*
* @return string
*/
public function dumpItems(ObjectAbstraction $abs, $what, array $cfg)
{
$cfg = \array_merge(array(
'groupByInheritance' => \strpos($abs['sort'], 'inheritance') === 0,
'objClassName' => $abs['className'],
'phpDocOutput' => $abs['cfgFlags'] & AbstractObject::PHPDOC_OUTPUT,
'what' => $what,
), $cfg);
return $cfg['groupByInheritance']
? $this->dumpItemsByInheritance($abs, $cfg)
: $this->dumpItemsFiltered($abs, \array_keys($abs[$what]), $cfg);
}
/**
* Dump Property or Constant info as HTML
*
* @param string|Abstraction $name Property/constant name
* @param array $info Property/constant info
* @param array $cfg config options
*
* @return string html fragment
*/
protected function dumpItem($name, array $info, array $cfg)
{
return $this->html->buildTag(
'dd',
$this->getAttribs($info, $cfg),
$this->dumpItemInner($name, $info, $cfg)
);
}
/**
* Build property/constant/case inner html
*
* @param string|Abstraction $name Property name
* @param array $info Property info
* @param array $cfg options
*
* @return string html fragment
*/
protected function dumpItemInner($name, array $info, array $cfg)
{
$parts = \array_filter(array(
'1_modifiers' => $this->dumpModifiers($info),
'2_type' => isset($info['type'])
? $this->helper->markupType($info['type'])
: '',
'3_name' => $this->valDumper->dump($name, array(
'addQuotes' => \preg_match('#[\s\r\n]#u', $name) === 1 || $name === '',
'attribs' => array(
'class' => array('t_identifier'),
'title' => $cfg['phpDocOutput']
? $info['desc']
: '',
),
)),
'4_value' => $info['value'] !== Abstracter::UNDEFINED
? '<span class="t_operator">=</span> ' . $this->valDumper->dump($info['value'], $cfg)
: '',
));
return \implode(' ', $parts);
}
/**
* Iterate over cases, constants, properties, or methods
*
* @param ObjectAbstraction $abs ObjectAbstraction instance
* @param list<string> $keys keys/names of items to output
* @param array<string, mixed> $cfg Config options
*
* @return string
*/
private function dumpItemsFiltered(ObjectAbstraction $abs, array $keys, array $cfg)
{
$html = '';
$items = \array_intersect_key($abs[$cfg['what']], \array_flip($keys));
$items = $abs->sort($items, $abs['sort']);
$absKeys = $abs['keys'];
foreach ($items as $name => $info) {
$name = \preg_replace('/^debug\./', '', $name);
if (isset($absKeys[$name])) {
$name = $absKeys[$name];
}
$vis = (array) $info['visibility'];
$info = \array_merge(array(
'declaredLast' => null,
'declaredPrev' => null,
'objClassName' => $cfg['objClassName'], // used by Properties to determine "isDynamic"
), $info);
$info['isInherited'] = $info['declaredLast'] && $info['declaredLast'] !== $info['objClassName'];
$info['isPrivateAncestor'] = \in_array('private', $vis, true) && $info['isInherited'];
if ($info['isPrivateAncestor']) {
$info['isInherited'] = false;
}
$html .= $this->dumpItem($name, $info, $cfg) . "\n";
}
return $html;
}
/**
* group by inheritance... with headings
*
* @param ObjectAbstraction $abs ObjectAbstraction instance
* @param array<string, mixed> $cfg Config options
*
* @return string
*/
private function dumpItemsByInheritance(ObjectAbstraction $abs, array $cfg)
{
$html = '';
$className = $abs['className'];
$classes = $this->getInheritedClasses($abs, $abs['what']);
\array_unshift($classes, $className);
$items = $abs->sort($abs[$cfg['what']], $abs['sort']);
$itemCount = \count($items);
$itemOutCount = 0;
// stop looping over classes when we've output everything
// no sense in showing "inherited from" when no more inherited items
// Or, we could only display the heading when itemsFiltered non-empty
while ($classes && $itemOutCount < $itemCount) {
$classNameCur = \array_shift($classes);
$itemsFiltered = \array_filter($items, static function ($info) use ($classNameCur) {
return !isset($info['declaredLast']) || $info['declaredLast'] === $classNameCur;
});
$keys = \array_keys($itemsFiltered);
$items = \array_diff_key($items, $itemsFiltered);
$itemOutCount += \count($itemsFiltered);
$html .= \in_array($classNameCur, array($className, 'stdClass'), true) === false
? '<dd class="heading">Inherited from ' . $this->valDumper->markupIdentifier($classNameCur) . '</dd>' . "\n"
: '';
$html .= $this->dumpItemsFiltered($abs, $keys, $cfg);
}
return $html;
}
/**
* Dump "modifiers"
*
* @param array<string, mixed> $info Abstraction info
*
* @return string html fragment
*/
protected function dumpModifiers(array $info)
{
$modifiers = $this->getModifiers($info);
return \implode(' ', \array_map(static function ($modifier) {
return '<span class="t_modifier_' . $modifier . '">' . $modifier . '</span>';
}, $modifiers));
}
/**
* Get html attributes
*
* @param array<string, mixed> $info Abstraction info
* @param array<string, mixed> $cfg config options
*
* @return array<string, mixed>
*/
protected function getAttribs(array $info, array $cfg = array())
{
$attribs = array(
'class' => $this->getClasses($info),
'data-attributes' => $info['attributes'],
'data-chars' => $this->valDumper->findChars(\json_encode($info['attributes'], JSON_UNESCAPED_UNICODE)),
'data-declared-prev' => $info['declaredPrev'],
'data-inherited-from' => $info['declaredLast'],
);
$filter = \array_filter(array(
'class' => true,
'data-attributes' => $cfg['attributeOutput'] && $info['attributes'],
'data-chars' => $cfg['attributeOutput'],
'data-declared-prev' => empty($info['isInherited']) && !empty($info['declaredPrev']),
'data-inherited-from' => !empty($info['isInherited']) || $info['isPrivateAncestor'],
));
return \array_intersect_key($attribs, $filter);
}
/**
* Get classes
*
* @param array<string, mixed> $info Abstraction info
*
* @return string[]
*/
abstract protected function getClasses(array $info);
/**
* Get the extended classes we'll iterate over for "groupByInheritance"
*
* @param ObjectAbstraction $abs Object abstraction
* @param string $what 'cases', 'constants', 'properties', or 'methods'
*
* @return list<string>
*/
private function getInheritedClasses(ObjectAbstraction $abs, $what)
{
$classes = $abs['extends'];
if ($what !== 'constants') {
return $classes;
}
// constants can be defined in interface
$implements = $abs['implements'];
$implementsList = array();
while ($implements) {
$key = \key($implements);
$val = \array_shift($implements);
if (\is_array($val)) {
$implementsList[] = $key;
\array_splice($implements, 0, 0, $val);
continue;
}
$implementsList[] = $val;
}
return \array_merge($classes, $implementsList);
}
/**
* Get "modifiers" (final, readonly, static)
*
* @param array<string, mixed> $info Abstraction info
*
* @return string[]
*/
abstract protected function getModifiers(array $info);
/**
* Generate some info regarding the given method names
*
* @param array $methods method names
*
* @return string html fragment
*/
protected function magicMethodInfo($methods)
{
if (!$methods) {
return '';
}
$methods = \array_map(static function ($method) {
return '<code>' . $method . '</code>';
}, $methods);
$methods = \count($methods) === 1
? 'a ' . $methods[0] . ' method'
: \implode(' and ', $methods) . ' methods';
return '<dd class="info magic">This object has ' . $methods . '</dd>' . "\n";
}
}