sebastianbergmann/object-graph

Provides useful operations on PHP object graphs

Hi!

I am Sebastian Bergmann. If you develop software using the PHP programming language then you may have come across my name. I am the creator and maintainer of PHPUnit as well as many other libraries and tools that are commonly used.

---

👷 Check out what I'm currently working on

• sebastianbergmann/csv-parser - Library for type-safe parsing of CSV files (1 day ago)
• sebastianbergmann/phpunit - The PHP Unit Testing framework. (2 days ago)
• sebastianbergmann/phpunit-documentation-english - English Documentation for PHPUnit (1 week ago)
• sebastianbergmann/raytracer - Code written while reading the book "The Ray Tracer Challenge: A Test-Driven Guide to Your First 3D Renderer" by Jamis Buck. (1 month ago)
• sebastianbergmann/phpunit-website - https://phpunit.de/ (1 month ago)
• sebastianbergmann/cli-parser - Library for parsing CLI options (1 month ago)
• sebastianbergmann/exporter - Provides the functionality to export PHP variables for visualization (1 month ago)
• sebastianbergmann/code-unit - Collection of value objects that represent the PHP code units (1 month ago)
• sebastianbergmann/recursion-context - Provides functionality to recursively process PHP variables (1 month ago)
• sebastianbergmann/foal - Tool to find lines eliminated by OpCache's bytecode optimizer (1 month ago)

---

🔭 Latest releases I've contributed to

• sebastianbergmann/phpunit (11.1.3, 1 week ago) - The PHP Unit Testing framework.
• sebastianbergmann/foal (0.3.0, 1 month ago) - Tool to find lines eliminated by OpCache's bytecode optimizer
• sebastianbergmann/environment (7.1.0, 1 month ago) - Provides functionality that helps writing PHP code that has runtime-specific execution paths
• sebastianbergmann/php-code-coverage (11.0.3, 1 month ago) - Library that provides collection, processing, and rendering functionality for PHP code coverage information.
• sebastianbergmann/csv-parser (1.0.0, 1 month ago) - Library for type-safe parsing of CSV files
• phar-io/manifest (2.0.4, 2 months ago) - Component for reading phar.io manifest information from a PHP Archive (PHAR)
• theseer/tokenizer (1.2.3, 2 months ago) - A small library for converting tokenized PHP source code into XML (and potentially other formats)
• templado/engine (4.2.5, 2 months ago) - A pragmatic approach to templating for PHP 8.2+

---

📫 How to reach me

• Email: [email protected]
• Fediverse: @[email protected]

object-graph's Issues

Mention dot and graphviz

You should probably mention graphviz to actually make use of the dot file to generate a PNG from object_graph_dump() method.

People need e.g.

sudo apt install graphviz

and otherwise get sh: 1: dot: not found

Build automation

• Have Composer in tools/composer and managed through composer self-update (see update-tools target in build.xml
• Install Psalm using Phive as tools/psalm (phive install --copy psalm)
• Install PHP-CS-Fixer using Phive as tools/php-cs-fixer (phive install --copy php-cs-fixer)
• Create Psalm configuration
• Add Psalm build step to GitHub Actions-based CI workflow
• Add PHP-CS-Fixer build step to GitHub Actions-based CI workflow

DotWriter does not escape attribute values

Hello.

I'm debugging this in a docker container so I haven't got very far yet, but my experimentation is showing that if an object property contains a PHP tag then the rendering will fail.

Demo Script

<?php

require_once __DIR__ . '/../vendor/autoload.php';

use function SebastianBergmann\ObjectGraph\object_graph_dump;

class ExampleBreakage
{
    protected $property = '<?';
}

object_graph_dump(__DIR__ . '/graph.png', new ExampleBreakage());

exit(0);

Demo Script Output

Error: /tmp/object_graph_dumpYXT0TI: syntax error in line 8 near ''

Is it possible this tag is being parsed erroneously somehow? The script runs properly when I change the property value from <? to hello_world.

Support \SplObjectStorage like attributes expand

Demo code:

class Test
{
    protected $elements;
    
    public function __construct()
    {
        $this->elements = new \SplObjectStorage();
    }
    
    public function add($object, $info = [])
    {
        $this->elements->attach($object, $info);
    }
}

class Item { protected $name = 'name'; }

$test = new Test();
$test->add(new Item(), ['order' => 1]);
$test->add(new Item(), ['order' => 2]);

object_graph_dump('a.png', $test);

the result:

Maybe the \SplObjectStorage can be expanded to display is better 😄