Joomla! Issue Tracker | Joomla! CMS #42598 - [4.4] fix return type in phpdoc

bug PR-4.4-dev b/c break

Pending
Medium
Build: 4.4-dev
# 42598
Diff
heelc29:4.4/mailer-interface/return-docs

Pending

Pending continuous-integration/drone/pr Build is pending Details

User tests: Successful: Unsuccessful:

heelc29
3 Jan 2024

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

    
               /** 
        
                * Send the mail 
        
                * 
        
                * @return  boolean  Boolean true if successful, false if exception throwing is disabled. 
        
                * 
        
                * @since   1.7.0 
        
                * 
        
                * @throws  MailDisabledException  if the mail function is disabled 
        
                * @throws  phpmailerException     if sending failed 
        
                */ 
        
               public function Send()

interface: void

joomla-cms/libraries/src/Mail/MailerInterface.php

Lines 23 to 32 in a31a19c

    
               /** 
        
                * Send the mail. Throws an exception when something goes wrong. 
        
                * 
        
                * @return  void 
        
                * 
        
                * @since   4.4.0 
        
                * 
        
                * @throws  \RuntimeException 
        
                */ 
        
               public function send();

class contains return statement:

joomla-cms/libraries/src/Mail/Mail.php

Line 179 in a31a19c

return $result;

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

670eff1 3 Jan 2024

[4.4] fix return type in phpdoc

heelc29 - open - 3 Jan 2024

heelc29 - change - 3 Jan 2024

Status

New

⇒

Pending

joomla-cms-bot - change - 3 Jan 2024

Category

⇒

Libraries

cbe8d3e 28 Jan 2024

Merge branch '4.4-dev' into 4.4/mailer-interface/return-docs

heelc29 - change - 28 Jan 2024

Labels

Added: PR-4.4-dev

272708a 24 Mar 2024

Merge branch '4.4-dev' into 4.4/mailer-interface/return-docs

HLeithner - comment - 24 Apr 2024

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?

heelc29 - comment - 1 Sep 2024

In my opinion this is a docblock error introduced with 4.4 (#40560) so it should be a bugfix against 4.4

c29f264 1 Sep 2024

Merge branch '4.4-dev' into 4.4/mailer-interface/return-docs

heelc29 - change - 1 Sep 2024

Labels

Added: bug b/c break

Add a Comment

Older
Newer

Joomla! Issue Tracker - CMS

[#42598] - [4.4] fix return type in phpdoc

Summary of Changes

Testing Instructions

Actual result BEFORE applying this Pull Request

Expected result AFTER applying this Pull Request

Link to documentations

Add a Comment

	/**
	* Send the mail
	*
	* @return boolean Boolean true if successful, false if exception throwing is disabled.
	*
	* @since 1.7.0
	*
	* @throws MailDisabledException if the mail function is disabled
	* @throws phpmailerException if sending failed
	*/
	public function Send()

	/**
	* Send the mail. Throws an exception when something goes wrong.
	*
	* @return void
	*
	* @since 4.4.0
	*
	* @throws \RuntimeException
	*/
	public function send();