Plaisio\ErrorLogger\HtmlVarWriter

Complexity

Total Complexity

30

Size/Duplication

Total Lines	294
Duplicated Lines	0 %

Test Coverage

Coverage

85.6%

Importance

Changes	1
Bugs	0	Features	0

18 Methods

Rating	Name	Duplication	Size	Complexity
A	start()	0	3	1
A	writeArrayOpen()	0	12	2
A	writeObjectReference()	0	15	1
A	writeObjectClose()	0	7	2
A	stop()	0	3	1
A	writeString()	0	6	2
A	__construct()	0	3	1
A	writeResource()	0	3	1
A	writeBool()	0	3	2
A	writeScalar()	0	18	2
B	writeName()	0	41	6
A	writeInt()	0	3	1
A	writeArrayReference()	0	15	1
A	writeObjectOpen()	0	12	2
A	writeUninitialized()	0	3	1
A	writeArrayClose()	0	7	2
A	writeNull()	0	3	1
A	writeFloat()	0	3	1

<?php
declare(strict_types=1);

namespace Plaisio\ErrorLogger;

use Plaisio\Debug\VarWriter;
use Plaisio\Helper\Html;

/**
 * Writes a var dump in HTML to a stream.
 */
class HtmlVarWriter implements VarWriter
{
  //--------------------------------------------------------------------------------------------------------------------
  /**
   * The output handle.
   *
   * @var resource
   */
  protected $handle;

  //--------------------------------------------------------------------------------------------------------------------
  /**
   * Object constructor.
   *
   * @param resource $handle The handle to write the var dump to.
   */
  public function __construct($handle)
  {
    $this->handle = $handle;
  }

  //--------------------------------------------------------------------------------------------------------------------
  /**
   * Does nothing.
   */
  public function start(): void
  {
    fwrite($this->handle, '<table class="var-dump">');
  }

  //--------------------------------------------------------------------------------------------------------------------
  /**
   * Does nothing.
   */
  public function stop(): void
  {
    fwrite($this->handle, '</table>');
  }

  //--------------------------------------------------------------------------------------------------------------------
  /**
   * {@inheritdoc}
   */
  public function writeArrayClose(int $id, $name): void
  {
    if ($name!==null)
    {
      fwrite($this->handle, '</table>');
      fwrite($this->handle, '</td>');
      fwrite($this->handle, '</tr>');
    }
  }

  //--------------------------------------------------------------------------------------------------------------------
  /**
   * {@inheritdoc}
   */
  public function writeArrayOpen(int $id, $name): void
  {
    if ($name!==null)
    {
      fwrite($this->handle, '<tr>');
      $this->writeName($name, $id);
      fwrite($this->handle, '<td>');
      fwrite($this->handle, Html::htmlNested(['tag'  => 'div',
                                              'attr' => ['class' => 'array'],
                                              'text' => 'array']));
      fwrite($this->handle, '<br/>');
      fwrite($this->handle, '<table>');
    }
  }

  //--------------------------------------------------------------------------------------------------------------------
  /**
   * {@inheritdoc}
   */
  public function writeArrayReference(int $ref, $name): void
  {
    $html = Html::htmlNested(['tag'  => 'span',
                              'attr' => ['class' => 'array'],
                              'text' => 'array']);
    $html .= ', ';
    $html .= Html::htmlNested(['tag'  => 'a',
                               'attr' => ['href' => '#'.$ref],
                               'text' => 'see '.$ref]);

    fwrite($this->handle, '<tr>');
    $this->writeName($name);
    fwrite($this->handle, Html::htmlNested(['tag'  => 'td',
                                            'html' => $html]));
    fwrite($this->handle, '</tr>');
  }

  //--------------------------------------------------------------------------------------------------------------------
  /**
   * {@inheritdoc}
   */
  public function writeBool(?int $id, ?int $ref, bool &$value, $name): void
  {
    $this->writeScalar($id, $ref, $name, ($value) ? 'true' : 'false', 'keyword');
  }

  //--------------------------------------------------------------------------------------------------------------------
  /**
   * {@inheritdoc}
   */
  public function writeFloat(?int $id, ?int $ref, float &$value, $name): void
  {
    $this->writeScalar($id, $ref, $name, (string)$value, 'number');
  }

  //--------------------------------------------------------------------------------------------------------------------
  /**
   * {@inheritdoc}
   */
  public function writeInt(?int $id, ?int $ref, int &$value, $name): void
  {
    $this->writeScalar($id, $ref, $name, (string)$value, 'number');
  }

  //--------------------------------------------------------------------------------------------------------------------
  /**
   * {@inheritdoc}
   */
  public function writeNull(?int $id, ?int $ref, $name): void
  {
    $this->writeScalar($id, $ref, $name, 'null', 'keyword');
  }

  //--------------------------------------------------------------------------------------------------------------------
  /**
   * {@inheritdoc}
   */
  public function writeObjectClose(int $id, mixed $name, string $class): void
  {
    if ($name!==null)
    {
      fwrite($this->handle, '</table>');
      fwrite($this->handle, '</td>');
      fwrite($this->handle, '</tr>');
    }
  }

  //--------------------------------------------------------------------------------------------------------------------
  /**
   * {@inheritdoc}
   */
  public function writeObjectOpen(int $id, mixed $name, string $class): void
  {
    if ($name!==null)
    {
      fwrite($this->handle, '<tr>');
      $this->writeName($name, $id);
      fwrite($this->handle, '<td>');
      fwrite($this->handle, Html::htmlNested(['tag'  => 'div',
                                              'attr' => ['class' => 'class'],
                                              'text' => $class]));
      fwrite($this->handle, '<br/>');
      fwrite($this->handle, '<table>');
    }
  }

  //--------------------------------------------------------------------------------------------------------------------
  /**
   * {@inheritdoc}
   */
  public function writeObjectReference(int $ref, mixed $name, string $class): void
  {
    $html = Html::htmlNested(['tag'  => 'span',
                              'attr' => ['class' => 'class'],
                              'text' => $class]);
    $html .= ', ';
    $html .= Html::htmlNested(['tag'  => 'a',
                               'attr' => ['href' => '#'.$ref],
                               'text' => 'see '.$ref]);

    fwrite($this->handle, '<tr>');
    $this->writeName($name);
    fwrite($this->handle, Html::htmlNested(['tag'  => 'td',
                                            'html' => $html]));
    fwrite($this->handle, '</tr>');
  }

  //--------------------------------------------------------------------------------------------------------------------
  /**
   * {@inheritdoc}
   */
  public function writeResource(?int $id, ?int $ref, mixed $name, string $type): void
  {
    $this->writeScalar($id, $ref, $name, $type, 'keyword');
  }

  //--------------------------------------------------------------------------------------------------------------------
  /**
   * {@inheritdoc}
   */
  public function writeString(?int $id, ?int $ref, string &$value, mixed $name): void
  {
    $text  = mb_strimwidth($value, 0, 80, '...');
    $title = ($text!=$value) ? mb_strimwidth($value, 0, 512, '...') : null;

    $this->writeScalar($id, $ref, $name, $text, 'string', $title);
  }

  //--------------------------------------------------------------------------------------------------------------------
  /**
   * {@inheritdoc}
   */
  public function writeUninitialized(mixed $name): void
  {
    $this->writeScalar(null, null, $name, 'uninitialized', 'uninitialized');
  }

  //--------------------------------------------------------------------------------------------------------------------
  /**
   * Writes the name of a variable.
   *
   * @param string|int|null $name The name of the variable.
   * @param int|null        $id   The ID of the value.
   */
  private function writeName(mixed $name, ?int $id = null): void
  {
    if ($name===null || $name==='')
    {
      fwrite($this->handle, Html::htmlNested(['tag'  => 'th',
                                              'attr' => ['class' => 'id',
                                                         'id'    => $id],
                                              'text' => $id]));
    }
    else
    {
      $title = null;

      if (is_int($name))
      {
        $text  = (string)$name;
        $class = 'number';
      }
      elseif (is_string($name))
      {
        $class = 'string';
        $text  = mb_strimwidth((string)$name, 0, 20, '...');
        if ($text!=$name)
        {
          $title = mb_strimwidth((string)$name, 0, 512, '...');
        }
      }
      else
      {
        throw new \InvalidArgumentException(sprintf('$name has unexpected type %s', gettype($name)));
      }

      fwrite($this->handle, Html::htmlNested(['tag'  => 'th',
                                              'attr' => ['class' => 'id'],
                                              'text' => $id]));

      fwrite($this->handle, Html::htmlNested(['tag'  => 'th',
                                              'attr' => ['class' => $class,
                                                         'id'    => $id,
                                                         'title' => $title],
                                              'text' => $text]));
    }
  }

  //--------------------------------------------------------------------------------------------------------------------
  /**
   * Dumps a scalar value.
   *
   * @param int|null        $id    The ID of the value.
   * @param int|null        $ref   The ID of the value if the variable is a reference to a value that has been dumped
   *                               already.
   * @param string|int|null $name  The name of the variable.
   * @param string          $text  The text for displaying the value.
   * @param string          $class The class of the value.
   * @param string|null     $title The title for the value.
   */
  private function writeScalar(?int $id, ?int $ref, mixed $name, string $text, string $class, ?string $title = null)
  {
    $html = Html::htmlNested(['tag'  => 'span',
                              'attr' => ['class' => $class, 'title' => $title],
                              'text' => $text]);
    if ($ref!==null)
    {
      $html .= ', ';
      $html .= Html::htmlNested(['tag'  => 'a',
                                 'attr' => ['href' => '#'.$ref],
                                 'text' => 'see '.$ref]);
    }

    fwrite($this->handle, '<tr>');
    $this->writeName($name, $id);
    fwrite($this->handle, Html::htmlNested(['tag'  => 'td',
                                            'html' => $html]));
    fwrite($this->handle, '</tr>');
  }
}

//----------------------------------------------------------------------------------------------------------------------