Merge pull request #22 from 123inkt/update_doc_block_with_IppRequestException

RubenKluft · web-flow · commit 4116b4ec6637 · 2025-12-02T10:08:33.000+01:00
Add IppRequestException to the appropriate docblocks
diff --git a/src/Client/CupsIppHttpClient.php b/src/Client/CupsIppHttpClient.php
@@ -23,7 +23,7 @@ public function __construct(private readonly IppServer $server, private readonly
     /**
      * @param IppOperation $operation
      *
-     * @throws ClientExceptionInterface
+     * @throws ClientExceptionInterface|IppRequestException
      */
     public function sendRequest(IppOperation $operation): ResponseInterface
     {
diff --git a/src/Client/IppHttpClientInterface.php b/src/Client/IppHttpClientInterface.php
@@ -11,7 +11,7 @@
 interface IppHttpClientInterface
 {
     /**
-     * @throws ClientExceptionInterface
+     * @throws ClientExceptionInterface|IppRequestException
      */
     public function sendRequest(IppOperation $operation): ResponseInterface;
 }
diff --git a/src/Ipp.php b/src/Ipp.php
@@ -6,6 +6,7 @@
 
 use DR\Ipp\Client\CupsIppHttpClient;
 use DR\Ipp\Client\IppHttpClientInterface;
+use DR\Ipp\Client\IppRequestException;
 use DR\Ipp\Entity\IppJob;
 use DR\Ipp\Entity\IppPrinter;
 use DR\Ipp\Entity\IppPrintFile;
@@ -66,7 +67,7 @@ public function printerAdministration(): PrinterAdminService
     }
 
     /**
-     * @throws ClientExceptionInterface
+     * @throws ClientExceptionInterface|IppRequestException
      */
     public function print(IppPrinter $printer, IppPrintFile $file): IppResponseInterface
     {
@@ -76,7 +77,7 @@ public function print(IppPrinter $printer, IppPrintFile $file): IppResponseInter
     }
 
     /**
-     * @throws ClientExceptionInterface
+     * @throws ClientExceptionInterface|IppRequestException
      */
     public function getJobAttributes(IppJob $job): IppResponseInterface
     {
@@ -87,7 +88,7 @@ public function getJobAttributes(IppJob $job): IppResponseInterface
 
     /**
      * Requests a list of printer attributes for the specified printer
-     * @throws ClientExceptionInterface
+     * @throws ClientExceptionInterface|IppRequestException
      */
     public function getPrinterAttributes(IppPrinter $printer): IppResponseInterface
     {
@@ -97,7 +98,7 @@ public function getPrinterAttributes(IppPrinter $printer): IppResponseInterface
     }
 
     /**
-     * @throws ClientExceptionInterface
+     * @throws ClientExceptionInterface|IppRequestException
      */
     public function getJobs(IppPrinter $printer, bool $completed = false): IppResponseInterface
     {
@@ -107,7 +108,7 @@ public function getJobs(IppPrinter $printer, bool $completed = false): IppRespon
     }
 
     /**
-     * @throws ClientExceptionInterface
+     * @throws ClientExceptionInterface|IppRequestException
      */
     public function cancelJob(IppJob $job): IppResponseInterface
     {
@@ -117,7 +118,7 @@ public function cancelJob(IppJob $job): IppResponseInterface
     }
 
     /**
-     * @throws ClientExceptionInterface
+     * @throws ClientExceptionInterface|IppRequestException
      */
     public function validatePrintJob(IppPrinter $printer, IppPrintFile $file): IppResponseInterface
     {
diff --git a/src/Operations/CancelJobOperation.php b/src/Operations/CancelJobOperation.php
@@ -5,6 +5,7 @@
 namespace DR\Ipp\Operations;
 
 use DR\Ipp\Client\IppHttpClientInterface;
+use DR\Ipp\Client\IppRequestException;
 use DR\Ipp\Entity\IppJob;
 use DR\Ipp\Entity\Response\IppResponseInterface;
 use DR\Ipp\Enum\IppOperationEnum;
@@ -24,7 +25,7 @@ public function __construct(private readonly IppHttpClientInterface $client, pri
     }
 
     /**
-     * @throws ClientExceptionInterface
+     * @throws ClientExceptionInterface|IppRequestException
      */
     public function cancel(IppJob $job): IppResponseInterface
     {
diff --git a/src/Operations/CreatePrinterInterface.php b/src/Operations/CreatePrinterInterface.php
@@ -4,14 +4,15 @@
 
 namespace DR\Ipp\Operations;
 
+use DR\Ipp\Client\IppRequestException;
 use DR\Ipp\Entity\IppPrinter;
 use DR\Ipp\Entity\Response\IppResponseInterface;
 use Psr\Http\Client\ClientExceptionInterface;
 
 interface CreatePrinterInterface
 {
     /**
-     * @throws ClientExceptionInterface
+     * @throws ClientExceptionInterface|IppRequestException
      */
     public function create(IppPrinter $printer): IppResponseInterface;
 }
diff --git a/src/Operations/Cups/CupsCreatePrinter.php b/src/Operations/Cups/CupsCreatePrinter.php
@@ -5,6 +5,7 @@
 namespace DR\Ipp\Operations\Cups;
 
 use DR\Ipp\Client\IppHttpClientInterface;
+use DR\Ipp\Client\IppRequestException;
 use DR\Ipp\Entity\IppPrinter;
 use DR\Ipp\Entity\IppServer;
 use DR\Ipp\Entity\Response\IppResponseInterface;
@@ -31,7 +32,7 @@ public function __construct(
     }
 
     /**
-     * @throws ClientExceptionInterface
+     * @throws ClientExceptionInterface|IppRequestException
      */
     public function create(IppPrinter $printer): IppResponseInterface
     {
diff --git a/src/Operations/Cups/CupsDeletePrinter.php b/src/Operations/Cups/CupsDeletePrinter.php
@@ -5,6 +5,7 @@
 namespace DR\Ipp\Operations\Cups;
 
 use DR\Ipp\Client\IppHttpClientInterface;
+use DR\Ipp\Client\IppRequestException;
 use DR\Ipp\Entity\IppPrinter;
 use DR\Ipp\Entity\IppServer;
 use DR\Ipp\Entity\Response\IppResponseInterface;
@@ -29,7 +30,7 @@ public function __construct(
     }
 
     /**
-     * @throws ClientExceptionInterface
+     * @throws ClientExceptionInterface|IppRequestException
      */
     public function delete(IppPrinter $printer): IppResponseInterface
     {
diff --git a/src/Operations/Cups/CupsGetPrinters.php b/src/Operations/Cups/CupsGetPrinters.php
@@ -5,6 +5,7 @@
 namespace DR\Ipp\Operations\Cups;
 
 use DR\Ipp\Client\IppHttpClientInterface;
+use DR\Ipp\Client\IppRequestException;
 use DR\Ipp\Entity\Response\IppResponseInterface;
 use DR\Ipp\Enum\IppOperationEnum;
 use DR\Ipp\Enum\IppTypeEnum;
@@ -28,7 +29,7 @@ public function __construct(private readonly IppHttpClientInterface $client, pri
     }
 
     /**
-     * @throws ClientExceptionInterface
+     * @throws ClientExceptionInterface|IppRequestException
      */
     public function get(): IppResponseInterface
     {
diff --git a/src/Operations/DeletePrinterInterface.php b/src/Operations/DeletePrinterInterface.php
@@ -4,14 +4,15 @@
 
 namespace DR\Ipp\Operations;
 
+use DR\Ipp\Client\IppRequestException;
 use DR\Ipp\Entity\IppPrinter;
 use DR\Ipp\Entity\Response\IppResponseInterface;
 use Psr\Http\Client\ClientExceptionInterface;
 
 interface DeletePrinterInterface
 {
     /**
-     * @throws ClientExceptionInterface
+     * @throws ClientExceptionInterface|IppRequestException
      */
     public function delete(IppPrinter $printer): IppResponseInterface;
 }
diff --git a/src/Operations/GetJobAttributesOperation.php b/src/Operations/GetJobAttributesOperation.php
@@ -5,6 +5,7 @@
 namespace DR\Ipp\Operations;
 
 use DR\Ipp\Client\IppHttpClientInterface;
+use DR\Ipp\Client\IppRequestException;
 use DR\Ipp\Entity\IppJob;
 use DR\Ipp\Entity\Response\IppResponseInterface;
 use DR\Ipp\Enum\IppOperationEnum;
@@ -24,7 +25,7 @@ public function __construct(private readonly IppHttpClientInterface $client, pri
     }
 
     /**
-     * @throws ClientExceptionInterface
+     * @throws ClientExceptionInterface|IppRequestException
      */
     public function getJob(IppJob $job): IppResponseInterface
     {
diff --git a/src/Operations/GetJobsOperation.php b/src/Operations/GetJobsOperation.php
@@ -5,6 +5,7 @@
 namespace DR\Ipp\Operations;
 
 use DR\Ipp\Client\IppHttpClientInterface;
+use DR\Ipp\Client\IppRequestException;
 use DR\Ipp\Entity\IppPrinter;
 use DR\Ipp\Entity\IppServer;
 use DR\Ipp\Entity\Response\IppResponseInterface;
@@ -28,7 +29,7 @@ public function __construct(
     }
 
     /**
-     * @throws ClientExceptionInterface
+     * @throws ClientExceptionInterface|IppRequestException
      */
     public function getJobList(IppPrinter $printer, bool $completed = false): IppResponseInterface
     {
diff --git a/src/Operations/GetPrinterAttributesOperation.php b/src/Operations/GetPrinterAttributesOperation.php
@@ -5,6 +5,7 @@
 namespace DR\Ipp\Operations;
 
 use DR\Ipp\Client\IppHttpClientInterface;
+use DR\Ipp\Client\IppRequestException;
 use DR\Ipp\Entity\IppPrinter;
 use DR\Ipp\Entity\IppServer;
 use DR\Ipp\Entity\Response\IppResponseInterface;
@@ -28,7 +29,7 @@ public function __construct(
     }
 
     /**
-     * @throws ClientExceptionInterface
+     * @throws ClientExceptionInterface|IppRequestException
      */
     public function getAttributes(IppPrinter $printer): IppResponseInterface
     {
diff --git a/src/Operations/GetPrintersInterface.php b/src/Operations/GetPrintersInterface.php
@@ -4,13 +4,14 @@
 
 namespace DR\Ipp\Operations;
 
+use DR\Ipp\Client\IppRequestException;
 use DR\Ipp\Entity\Response\IppResponseInterface;
 use Psr\Http\Client\ClientExceptionInterface;
 
 interface GetPrintersInterface
 {
     /**
-     * @throws ClientExceptionInterface
+     * @throws ClientExceptionInterface|IppRequestException
      */
     public function get(): IppResponseInterface;
 }
diff --git a/src/Operations/PrintOperation.php b/src/Operations/PrintOperation.php
@@ -5,6 +5,7 @@
 namespace DR\Ipp\Operations;
 
 use DR\Ipp\Client\IppHttpClientInterface;
+use DR\Ipp\Client\IppRequestException;
 use DR\Ipp\Entity\IppPrinter;
 use DR\Ipp\Entity\IppPrintFile;
 use DR\Ipp\Entity\IppServer;
@@ -35,7 +36,7 @@ public function __construct(
     }
 
     /**
-     * @throws ClientExceptionInterface
+     * @throws ClientExceptionInterface|IppRequestException
      */
     public function print(IppPrinter $printer, IppPrintFile $file, bool $dryRun = false): IppResponseInterface
     {

Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ public function __construct(private readonly IppServer $server, private readonly`
`23`	`23`	`/**`
`24`	`24`	`* @param IppOperation $operation`
`25`	`25`	`*`
`26`		`- * @throws ClientExceptionInterface`
	`26`	`+ * @throws ClientExceptionInterface\|IppRequestException`
`27`	`27`	`*/`
`28`	`28`	`public function sendRequest(IppOperation $operation): ResponseInterface`
`29`	`29`	`{`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@`
`11`	`11`	`interface IppHttpClientInterface`
`12`	`12`	`{`
`13`	`13`	`/**`
`14`		`- * @throws ClientExceptionInterface`
	`14`	`+ * @throws ClientExceptionInterface\|IppRequestException`
`15`	`15`	`*/`
`16`	`16`	`public function sendRequest(IppOperation $operation): ResponseInterface;`
`17`	`17`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,7 @@`
`6`	`6`
`7`	`7`	`use DR\Ipp\Client\CupsIppHttpClient;`
`8`	`8`	`use DR\Ipp\Client\IppHttpClientInterface;`
	`9`	`+use DR\Ipp\Client\IppRequestException;`
`9`	`10`	`use DR\Ipp\Entity\IppJob;`
`10`	`11`	`use DR\Ipp\Entity\IppPrinter;`
`11`	`12`	`use DR\Ipp\Entity\IppPrintFile;`
`@@ -66,7 +67,7 @@ public function printerAdministration(): PrinterAdminService`
`66`	`67`	`}`
`67`	`68`
`68`	`69`	`/**`
`69`		`- * @throws ClientExceptionInterface`
	`70`	`+ * @throws ClientExceptionInterface\|IppRequestException`
`70`	`71`	`*/`
`71`	`72`	`public function print(IppPrinter $printer, IppPrintFile $file): IppResponseInterface`
`72`	`73`	`{`
`@@ -76,7 +77,7 @@ public function print(IppPrinter $printer, IppPrintFile $file): IppResponseInter`
`76`	`77`	`}`
`77`	`78`
`78`	`79`	`/**`
`79`		`- * @throws ClientExceptionInterface`
	`80`	`+ * @throws ClientExceptionInterface\|IppRequestException`
`80`	`81`	`*/`
`81`	`82`	`public function getJobAttributes(IppJob $job): IppResponseInterface`
`82`	`83`	`{`
`@@ -87,7 +88,7 @@ public function getJobAttributes(IppJob $job): IppResponseInterface`
`87`	`88`
`88`	`89`	`/**`
`89`	`90`	`* Requests a list of printer attributes for the specified printer`
`90`		`- * @throws ClientExceptionInterface`
	`91`	`+ * @throws ClientExceptionInterface\|IppRequestException`
`91`	`92`	`*/`
`92`	`93`	`public function getPrinterAttributes(IppPrinter $printer): IppResponseInterface`
`93`	`94`	`{`
`@@ -97,7 +98,7 @@ public function getPrinterAttributes(IppPrinter $printer): IppResponseInterface`
`97`	`98`	`}`
`98`	`99`
`99`	`100`	`/**`
`100`		`- * @throws ClientExceptionInterface`
	`101`	`+ * @throws ClientExceptionInterface\|IppRequestException`
`101`	`102`	`*/`
`102`	`103`	`public function getJobs(IppPrinter $printer, bool $completed = false): IppResponseInterface`
`103`	`104`	`{`
`@@ -107,7 +108,7 @@ public function getJobs(IppPrinter $printer, bool $completed = false): IppRespon`
`107`	`108`	`}`
`108`	`109`
`109`	`110`	`/**`
`110`		`- * @throws ClientExceptionInterface`
	`111`	`+ * @throws ClientExceptionInterface\|IppRequestException`
`111`	`112`	`*/`
`112`	`113`	`public function cancelJob(IppJob $job): IppResponseInterface`
`113`	`114`	`{`
`@@ -117,7 +118,7 @@ public function cancelJob(IppJob $job): IppResponseInterface`
`117`	`118`	`}`
`118`	`119`
`119`	`120`	`/**`
`120`		`- * @throws ClientExceptionInterface`
	`121`	`+ * @throws ClientExceptionInterface\|IppRequestException`
`121`	`122`	`*/`
`122`	`123`	`public function validatePrintJob(IppPrinter $printer, IppPrintFile $file): IppResponseInterface`
`123`	`124`	`{`
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@`
`5`	`5`	`namespace DR\Ipp\Operations;`
`6`	`6`
`7`	`7`	`use DR\Ipp\Client\IppHttpClientInterface;`
	`8`	`+use DR\Ipp\Client\IppRequestException;`
`8`	`9`	`use DR\Ipp\Entity\IppJob;`
`9`	`10`	`use DR\Ipp\Entity\Response\IppResponseInterface;`
`10`	`11`	`use DR\Ipp\Enum\IppOperationEnum;`
`@@ -24,7 +25,7 @@ public function __construct(private readonly IppHttpClientInterface $client, pri`
`24`	`25`	`}`
`25`	`26`
`26`	`27`	`/**`
`27`		`- * @throws ClientExceptionInterface`
	`28`	`+ * @throws ClientExceptionInterface\|IppRequestException`
`28`	`29`	`*/`
`29`	`30`	`public function cancel(IppJob $job): IppResponseInterface`
`30`	`31`	`{`
Original file line number	Diff line number	Diff line change
`@@ -4,14 +4,15 @@`
`4`	`4`
`5`	`5`	`namespace DR\Ipp\Operations;`
`6`	`6`
	`7`	`+use DR\Ipp\Client\IppRequestException;`
`7`	`8`	`use DR\Ipp\Entity\IppPrinter;`
`8`	`9`	`use DR\Ipp\Entity\Response\IppResponseInterface;`
`9`	`10`	`use Psr\Http\Client\ClientExceptionInterface;`
`10`	`11`
`11`	`12`	`interface CreatePrinterInterface`
`12`	`13`	`{`
`13`	`14`	`/**`
`14`		`- * @throws ClientExceptionInterface`
	`15`	`+ * @throws ClientExceptionInterface\|IppRequestException`
`15`	`16`	`*/`
`16`	`17`	`public function create(IppPrinter $printer): IppResponseInterface;`
`17`	`18`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@`
`5`	`5`	`namespace DR\Ipp\Operations\Cups;`
`6`	`6`
`7`	`7`	`use DR\Ipp\Client\IppHttpClientInterface;`
	`8`	`+use DR\Ipp\Client\IppRequestException;`
`8`	`9`	`use DR\Ipp\Entity\IppPrinter;`
`9`	`10`	`use DR\Ipp\Entity\IppServer;`
`10`	`11`	`use DR\Ipp\Entity\Response\IppResponseInterface;`
`@@ -31,7 +32,7 @@ public function __construct(`
`31`	`32`	`}`
`32`	`33`
`33`	`34`	`/**`
`34`		`- * @throws ClientExceptionInterface`
	`35`	`+ * @throws ClientExceptionInterface\|IppRequestException`
`35`	`36`	`*/`
`36`	`37`	`public function create(IppPrinter $printer): IppResponseInterface`
`37`	`38`	`{`