feat: Add structured HTML output with document tree and inner content#77
Open
dawsmith06 wants to merge 1 commit intoueberdosis:mainfrom
Open
feat: Add structured HTML output with document tree and inner content#77dawsmith06 wants to merge 1 commit intoueberdosis:mainfrom
dawsmith06 wants to merge 1 commit intoueberdosis:mainfrom
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR adds structured HTML output capabilities to the DOMSerializer, allowing consumers to get both the rendered HTML and a structured representation of the document tree. This is particularly useful for applications that need to process or analyze the document structure programmatically.
New Features
processStructured(array $value): arrayReturns a structured array representation of the document with each node containing:
type: The node type (e.g., 'table', 'paragraph', 'heading')html: The complete rendered HTML including outer tagsinnerHtml: The inner content HTML without outer tags (for nodes with children)children: Array of child nodes with the same structurestructuredHtml($node): arrayInternal method that processes individual nodes recursively to build the structured tree.
Use Cases
This feature enables:
Example Output
Breaking Changes
None. This is a purely additive feature that doesn't affect existing functionality.
Testing
The feature has been tested with a variety of document structures, including tables, lists, and nested content. The structured output accurately preserves the document hierarchy and provides both complete and inner HTML representations. Unit tests have also been added to ensure reliability.