[#42598] - [5.2] fix return type in phpdoc
- Pending
- Medium
- Build: 4.4-dev
- # 42598
- Diff
- heelc29:4.4/mailer-interface/return-docs
- Pending continuous-integration/drone/pr Build is pending Details
User tests: Successful: Unsuccessful:
Summary of Changes
return type of send() function between class and interface do not match
class: boolean
joomla-cms/libraries/src/Mail/Mail.php
Lines 124 to 134 in a31a19c
interface: void
joomla-cms/libraries/src/Mail/MailerInterface.php
Lines 23 to 32 in a31a19c
class contains return statement:
joomla-cms/libraries/src/Mail/Mail.php
Line 179 in a31a19c
Testing Instructions
code review
Actual result BEFORE applying this Pull Request
phan warning:
libraries/src/Mail/Mail.php:134 PhanParamSignatureMismatch Declaration of function Send() : bool should be compatible with function send() : void defined in libraries/src/Mail/MailerInterface.php:32
Expected result AFTER applying this Pull Request
return type of class and interface match (warning in phan disappear)
Link to documentations
Please select:
- No documentation changes for docs.joomla.org needed
- No documentation changes for manual.joomla.org needed
| Status | New | ⇒ | Pending |
joomla-cms-bot
- | Category | ⇒ | Libraries |
| Labels |
Added:
PR-4.4-dev
|
||
| Labels |
Added:
bug
b/c break
|
||
This pull request has been automatically rebased to 5.2-dev.
| Title |
|
||||||
| Labels |
Added:
PR-5.2-dev
|
||
Sorry,missed this. Correctly the send function should return nothing and only throw an exception when something fails.
So libraries/src/Mail/Mail.php should be updated? Is there a b/c break free option?
Changing the interface is a b/c break but Implemented code says it returns a boolean... @laoneo @MacJoom what would you like to do? move to 6.0? or merge to 4.4?