Skip to content
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.

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

Fix parameter name of IMessage::setHtmlPart according to docComment #189

Merged
merged 1 commit into from
Aug 18, 2022
Merged

Fix parameter name of IMessage::setHtmlPart according to docComment #189

merged 1 commit into from
Aug 18, 2022

Conversation

stollr
Copy link
Contributor

@stollr stollr commented Feb 24, 2022

Currently the comment and signature of IMessage::setHtmlPart is

    /**
     * [...]
     * @param string $contentTypeCharset the charset to use as the text/html
     *        part's content-type header charset value.
     */
    public function setHtmlPart($resource, $charset = 'UTF-8');

Symfony's DeprecationErrorHandler thinks that in the next main version of the package there will be a new parameter for this function:

Remaining indirect deprecation notices (1)

1x: The "ZBateson\MailMimeParser\Message::setHtmlPart()" method will require a new "string $contentTypeCharset" argument in the next major version of its interface "ZBateson\MailMimeParser\IMessage", not defining it is deprecated.

So I propose to change the parameter's name in the interface according to the name in the php doc.

@stollr
Copy link
Contributor Author

stollr commented Aug 17, 2022

@zbateson ping

@zbateson zbateson merged commit 11e39a5 into zbateson:master Aug 18, 2022
@zbateson
Copy link
Owner

Thanks @Naitsirch

@stollr stollr deleted the fix_phpdoc_of_message branch August 18, 2022 20:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants