Skip to content

Improvements of phpdocs and fix phpstan reported errors #134

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 11 commits into
base: master
Choose a base branch
from
Open

Improvements of phpdocs and fix phpstan reported errors #134

wants to merge 11 commits into from
+144 −103

Conversation

@williamdes
Copy link
Contributor

@williamdes williamdes commented Sep 18, 2025

Ref: #133

Left over:

./vendor/bin/phpstan analyse --level=3 src/
 29/29 [▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓] 100%

 ------ ------------------------------------------------------------------------------------------- 
  Line   Svg/Style.php                                                                              
 ------ ------------------------------------------------------------------------------------------- 
  100    Argument of an invalid type Svg\Style supplied for foreach, only iterables are supported.  
         🪪  foreach.nonIterable                                                                    
 ------ ------------------------------------------------------------------------------------------- 

 ------ --------------------------------------------------------------------------------------------------- 
  Line   Svg/Surface/CPdf.php                                                                               
 ------ --------------------------------------------------------------------------------------------------- 
  609    Property Svg\Surface\CPdf::$catalogId (int) does not accept string.                                
         🪪  assign.propertyType                                                                            
  874    PHPDoc tag @throws with type FontLib\Exception\FontNotFoundException is not subtype of Throwable   
         🪪  throws.notThrowable                                                                            
  1056   PHPDoc tag @throws with type FontLib\Exception\FontNotFoundException is not subtype of Throwable   
         🪪  throws.notThrowable                                                                            
  1116   Variable $object in isset() is never defined.                                                      
         🪪  isset.variable                                                                                 
  1117   Undefined variable: $object                                                                        
         🪪  variable.undefined                                                                             
  1119   Undefined variable: $object                                                                        
         🪪  variable.undefined                                                                             
  1662   Property Svg\Surface\CPdf::$procsetObjectId (int) does not accept string.                          
         🪪  assign.propertyType                                                                            
  1702   Property Svg\Surface\CPdf::$infoObject (int) does not accept string.                               
         🪪  assign.propertyType                                                                            
  1923   Property Svg\Surface\CPdf::$currentPage (int) does not accept string.                              
         🪪  assign.propertyType                                                                            
  2082   Binary operation "+" between string and 1 results in an error.                                     
         🪪  binaryOp.invalid                                                                               
  2713   Property Svg\Surface\CPdf::$arc4_objnum (int) does not accept string.                              
         🪪  assign.propertyType                                                                            
  3429   Binary operation ">>" between non-empty-list<string>|non-falsy-string and 8 results in an error.   
         🪪  binaryOp.invalid                                                                               
  3430   Binary operation "&" between non-empty-list<string>|non-falsy-string and 255 results in an error.  
         🪪  binaryOp.invalid                                                                               
  3493   PHPDoc tag @throws with type FontLib\Exception\FontNotFoundException is not subtype of Throwable   
         🪪  throws.notThrowable                                                                            
  3651   Call to vsprintf contains 3 placeholders, 4 values given.                                          
         🪪  argument.vsprintf                                                                              
  3690   Call to vsprintf contains 3 placeholders, 4 values given.                                          
         🪪  argument.vsprintf                                                                              
  6091   Variable $errormsg might not be defined.                                                           
         🪪  variable.undefined                                                                             
  6106   Variable $idata might not be defined.                                                              
         🪪  variable.undefined                                                                             
  6108   Variable $pdata might not be defined.                                                              
         🪪  variable.undefined                                                                             
  6112   Variable $color might not be defined.                                                              
         🪪  variable.undefined                                                                             
  6113   Variable $ncolor might not be defined.                                                             
         🪪  variable.undefined                                                                             
 ------ --------------------------------------------------------------------------------------------------- 

 ------ ------------------------------------------------------- 
  Line   Svg/Surface/SurfaceCpdf.php                            
 ------ ------------------------------------------------------- 
  133    Call to an undefined method Svg\Surface\CPdf::clip().  
         🪪  method.notFound                                    
 ------ ------------------------------------------------------- 

 ------ ------------------------------------------------------------ 
  Line   Svg/Tag/AbstractTag.php                                     
 ------ ------------------------------------------------------------ 
  232    Variable $meetOrSlice on left side of ?? is never defined.  
         🪪  nullCoalesce.variable                                   
 ------ ------------------------------------------------------------ 

                                                                                                                        
 [ERROR] Found 24 errors

@williamdes
Allow phpunit 12
3feec64
@williamdes
Add GitHub workflow permissions
1121e24
@williamdes
Also allow null on the phpdoc, and improve a loose comparing
f02518c 
```
 ------ -----------------------------------------------------------------------------------
  Line   Svg/Document.php
 ------ -----------------------------------------------------------------------------------
  407    PHPDoc tag @var with type Svg\Tag\AbstractTag is not subtype of native type null.
         🪪  varTag.nativeType
 ------ -----------------------------------------------------------------------------------
```
@williamdes
Better define phpdoc stypes and fix return type of fromAttributes
02a5608
@williamdes
Fix renamed _convert_gif_bmp_to_png to _convert_to_png
ff2b451 
See: dompdf/dompdf@beb8984
@williamdes
Fix phpdoc signature of currentLineTransparency and currentFillTransp…
b08761c 
…arency
@williamdes
Fix phpdocs of FontNotFoundException
3f6ec49
@williamdes
Fix throws Exception phpdocs
64e522b
@williamdes
Allow default values in phpdocs
16f3714
@williamdes
Make sure variables always exist, reported by phpstan
aa7afe2 
For `$o` they always exist but phpstan can not detect it
@williamdes
Improve phpdocs for options and some params
052dce5
@bsweeney bsweeney added this to the 1.0.1 milestone Sep 18, 2025
@bsweeney bsweeney linked an issue Sep 23, 2025 that may be closed by this pull request
Address issues reported by phpstan #133
Open
bsweeney
bsweeney approved these changes Nov 15, 2025
View reviewed changes
bsweeney
bsweeney requested changes Nov 16, 2025
View reviewed changes
Copy link
Member

@bsweeney bsweeney left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Realized the change needs a bit of work before I can merge it.

src/Svg/Surface/CPdf.php
* @param $id
* @param $action
* @param string $options
* @param string $id
Copy link
Member

@bsweeney bsweeney Nov 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Documenting $id as a string (here and in every other method) is incorrect. $id should be an integer representing the object number. That's why you're getting "X does not accept a string" warnings from phpstan.

src/Svg/Surface/CPdf.php
* @param array $object_info
* @return array|false
* @throws FontNotFoundException
* @throws \FontLib\Exception\FontNotFoundException
Copy link
Member

@bsweeney bsweeney Nov 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In your comment about remaining issues phpstan is reporting this is not a subtype of Throwable, except it's a subtype of Exception so should be OK. Thoughts?

@bsweeney
Copy link
Member

bsweeney commented Nov 16, 2025

I'll make a few minor changes once you have a chance to review my comments and make any necessary changes.

I noted a few issues I'd like to address separately from this PR since most of these changes are documentary in nature. Namely:

  1. Add the missing clip method to Cpdf
  2. Add the missing _convert_to_png method to SurfaceCpdf

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@bsweeney bsweeney bsweeney requested changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

1.0.1

Development

Successfully merging this pull request may close these issues.

Address issues reported by phpstan

2 participants

@williamdes @bsweeney