8000 Implements render_progress event with PhpUnit tests by brunoinds · Pull Request #3451 · dompdf/dompdf · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Implements render_progress event with PhpUnit tests #3451

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Implements render_progress event with PhpUnit tests #3451

wants to merge 1 commit into from

Conversation

brunoinds
Copy link

This PR solves issue #3450, providing a new callback event to watch the render_progress and return the percentage for every stage of a frame being rendered.

use Dompdf\Dompdf;

$dompdf = new Dompdf();

$dompdf->setCallbacks([
    'render_progress' => [
        'event' => 'render_progress',
        'f' => function (float $percentage, int $renderedFrames, int $totalFrames) {
            var_dump($percentage, $renderedFrames, $totalFrames);
        }
    ]
]);

$dompdf->loadHtml('<h1>Hello world</h1>');
$dompdf->setPaper('A4', 'portrait');
$dompdf->render();

The idea is to, before rendering, count all the frames recursively in the tree and store that value. Then, every time a frame is rendered, increment a counter to compare how many frames have been rendered and how many are left to render, so we can calculate the progress percentage. All the counting and storage are being done inside the scope of the $dompdf->render() method execution, inside the $renderProgressData variable.

To avoid changes to the Dompdf class callbacks property style (array of ['event' => array(fn(), fn()...)]), we override the callback function of render_progress events only to receive $renderProgressData as a pointer. When a new frame is rendered, we can access $renderProgressData by passing a new array with the data and the original closure function as f, without the need to expose a variable globally or as a public property on the Dompdf class. Now we can track the changes using the private scope of the closure function.

@bsweeney bsweeney added this to the 3.1.0 milestone May 1, 2024
@bsweeney bsweeney linked an issue Dec 6, 2024 that may be closed by this pull request
Implement onRenderProgress callback #3450
Open
@bsweeney bsweeney modified the milestones: 3.1.0, 3.2.0 Jan 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
3.2.0
Development

Successfully merging this pull request may close these issues.

Implement onRenderProgress callback
2 participants
@brunoinds @bsweeney
0