Skip to content

Commit 26e20f4

Browse files
committed
Adjust phpdocs to clarify that streamPdfFromHtml never returns
This commit also includes phpdoc formating changes. Strict types have been left out on purpose to be compatible with the already existing implementation.
1 parent d1a764d commit 26e20f4

1 file changed

Lines changed: 6 additions & 3 deletions

File tree

library/Icinga/Application/Hook/PdfexportHook.php

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77

88
use Icinga\Application\Logger;
99
use Icinga\Exception\IcingaException;
10+
use ipl\Html\ValidHtml;
1011
use RuntimeException;
1112
use Throwable;
1213

@@ -49,15 +50,17 @@ public static function first()
4950
/**
5051
* Get whether PDF export is supported
5152
*
52-
* @return bool
53+
* @return bool
5354
*/
5455
abstract public function isSupported();
5556

5657
/**
5758
* Render the specified HTML to PDF and stream it to the client
5859
*
59-
* @param string $html The HTML to render to PDF
60-
* @param string $filename The filename for the generated PDF
60+
* @param ValidHtml $html The HTML to render to PDF
61+
* @param string $filename The filename for the generated PDF
62+
*
63+
* @return never
6164
*/
6265
abstract public function streamPdfFromHtml($html, $filename);
6366

0 commit comments

Comments
 (0)