From 4cebb0618de4e9d433a28bada9e09bcde84728a7 Mon Sep 17 00:00:00 2001 From: erikn69 Date: Thu, 4 May 2023 14:22:10 -0500 Subject: [PATCH] Fix phpstan analysis --- phpstan.neon | 2 -- src/Facade/Pdf.php | 41 ++++++++++++++++++++++++----------------- src/PDF.php | 36 +++++++++++++++++++++++++----------- 3 files changed, 49 insertions(+), 30 deletions(-) diff --git a/phpstan.neon b/phpstan.neon index 885fe04..6441fc7 100644 --- a/phpstan.neon +++ b/phpstan.neon @@ -11,5 +11,3 @@ parameters: # This is a global alias that cannot be detected by Larastan. - '#Call to static method loadHtml\(\) on an unknown class PDF\.#' - '#Call to static method loadHtml\(\) on an unknown class Pdf\.#' - # This is a magic method that cannot be detected by Larastan. - - '#Call to an undefined method Dompdf\\Dompdf::loadView\(\)\.#' diff --git a/src/Facade/Pdf.php b/src/Facade/Pdf.php index 2994604..3740e58 100644 --- a/src/Facade/Pdf.php +++ b/src/Facade/Pdf.php @@ -2,26 +2,33 @@ namespace Barryvdh\DomPDF\Facade; +use Barryvdh\DomPDF\PDF as BasePDF; use Illuminate\Support\Facades\Facade as IlluminateFacade; /** - * @method static \Barryvdh\DomPDF\PDF setPaper($paper, $orientation = 'portrait') - * @method static \Barryvdh\DomPDF\PDF setBaseHost(string $baseHost) - * @method static \Barryvdh\DomPDF\PDF setProtocol(string $protocol) - * @method static \Barryvdh\DomPDF\PDF setHttpContext($httpContext) - * @method static \Barryvdh\DomPDF\PDF setCallbacks(array $callbacks) - * @method static \Barryvdh\DomPDF\PDF setWarnings($warnings) - * @method static \Barryvdh\DomPDF\PDF setOption(array|string $attribute, $value = null) - * @method static \Barryvdh\DomPDF\PDF setOptions(array $options) - * @method static \Barryvdh\DomPDF\PDF loadView($view, $data = array(), $mergeData = array(), $encoding = null) - * @method static \Barryvdh\DomPDF\PDF loadHTML($string, $encoding = null) - * @method static \Barryvdh\DomPDF\PDF loadFile($file) - * @method static \Barryvdh\DomPDF\PDF addInfo($info) - * @method static string output($options = []) - * @method static \Barryvdh\DomPDF\PDF save() - * @method static \Illuminate\Http\Response download($filename = 'document.pdf') - * @method static \Illuminate\Http\Response stream($filename = 'document.pdf') - * + * @method static BasePDF setBaseHost(string $baseHost) + * @method static BasePDF setBasePath(string $basePath) + * @method static BasePDF setCanvas(\Dompdf\Canvas $canvas) + * @method static BasePDF setCallbacks(array $callbacks) + * @method static BasePDF setCss(\Dompdf\Css\Stylesheet $css) + * @method static BasePDF setDefaultView(string $defaultView, array $options) + * @method static BasePDF setDom(\DOMDocument $dom) + * @method static BasePDF setFontMetrics(\Dompdf\FontMetrics $fontMetrics) + * @method static BasePDF setHttpContext(resource|array $httpContext) + * @method static BasePDF setPaper(string|float[] $paper, string $orientation = 'portrait') + * @method static BasePDF setProtocol(string $protocol) + * @method static BasePDF setTree(\Dompdf\Frame\FrameTree $tree) + * @method static BasePDF setWarnings(bool $warnings) + * @method static BasePDF setOption(array|string $attribute, $value = null) + * @method static BasePDF setOptions(array $options) + * @method static BasePDF loadView(string $view, array $data = [], array $mergeData = [], ?string $encoding = null) + * @method static BasePDF loadHTML(string $string, ?string $encoding = null) + * @method static BasePDF loadFile(string $file) + * @method static BasePDF addInfo(array $info) + * @method static string output(array $options = []) + * @method static BasePDF save() + * @method static \Illuminate\Http\Response download(string $filename = 'document.pdf') + * @method static \Illuminate\Http\Response stream(string $filename = 'document.pdf') */ class Pdf extends IlluminateFacade { diff --git a/src/PDF.php b/src/PDF.php index 3be98fd..2b68b94 100644 --- a/src/PDF.php +++ b/src/PDF.php @@ -18,7 +18,31 @@ * @package laravel-dompdf * @author Barry vd. Heuvel * - * @mixin \Dompdf\Dompdf + * @method PDF setBaseHost(string $baseHost) + * @method PDF setBasePath(string $basePath) + * @method PDF setCanvas(\Dompdf\Canvas $canvas) + * @method PDF setCallbacks(array $callbacks) + * @method PDF setCss(\Dompdf\Css\Stylesheet $css) + * @method PDF setDefaultView(string $defaultView, array $options) + * @method PDF setDom(\DOMDocument $dom) + * @method PDF setFontMetrics(\Dompdf\FontMetrics $fontMetrics) + * @method PDF setHttpContext(resource|array $httpContext) + * @method PDF setPaper(string|float[] $paper, string $orientation = 'portrait') + * @method PDF setProtocol(string $protocol) + * @method PDF setTree(\Dompdf\Frame\FrameTree $tree) + * @method string getBaseHost() + * @method string getBasePath() + * @method \Dompdf\Canvas getCanvas() + * @method array getCallbacks() + * @method \Dompdf\Css\Stylesheet getCss() + * @method \DOMDocument getDom() + * @method \Dompdf\FontMetrics getFontMetrics() + * @method resource getHttpContext() + * @method Options getOptions() + * @method \Dompdf\Frame\FrameTree getTree() + * @method string getPaperOrientation() + * @method float[] getPaperSize() + * @method string getProtocol() */ class PDF { @@ -43,12 +67,6 @@ class PDF /** @var string */ protected $public_path; - /** - * @param Dompdf $dompdf - * @param \Illuminate\Contracts\Config\Repository $config - * @param \Illuminate\Filesystem\Filesystem $files - * @param \Illuminate\Contracts\View\Factory $view - */ public function __construct(Dompdf $dompdf, ConfigRepository $config, Filesystem $files, ViewFactory $view) { $this->dompdf = $dompdf; @@ -61,8 +79,6 @@ public function __construct(Dompdf $dompdf, ConfigRepository $config, Filesystem /** * Get the DomPDF instance - * - * @return Dompdf */ public function getDomPDF(): Dompdf { @@ -104,7 +120,6 @@ public function loadFile(string $file): self /** * Add metadata info * @param array $info - * @return static */ public function addInfo(array $info): self { @@ -131,7 +146,6 @@ public function loadView(string $view, array $data = [], array $mergeData = [], * * @param array|string $attribute * @param null|mixed $value - * @return $this */ public function setOption($attribute, $value = null): self {