Skip to content

Commit ea33590

Browse files
committed
Clarify that streamPdfFromHtml never returns
This commit also includes phpdoc formating changes
1 parent dfcf15c commit ea33590

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
@@ -8,6 +8,7 @@
88
use Icinga\Application\Hook;
99
use Icinga\Application\Logger;
1010
use Icinga\Exception\IcingaException;
11+
use ipl\Html\ValidHtml;
1112
use RuntimeException;
1213
use Throwable;
1314

@@ -43,15 +44,17 @@ public static function first()
4344
/**
4445
* Get whether PDF export is supported
4546
*
46-
* @return bool
47+
* @return bool
4748
*/
4849
abstract public function isSupported();
4950

5051
/**
5152
* Render the specified HTML to PDF and stream it to the client
5253
*
53-
* @param string $html The HTML to render to PDF
54-
* @param string $filename The filename for the generated PDF
54+
* @param ValidHtml $html The HTML to render to PDF
55+
* @param string $filename The filename for the generated PDF
56+
*
57+
* @return never
5558
*/
5659
abstract public function streamPdfFromHtml($html, $filename);
5760
}

0 commit comments

Comments
 (0)