Skip to content

[Contributing] [Standards] Add note about trigger_error() and deprecation messages #5840

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

Merged
merged 1 commit into from
Dec 28, 2015
Merged

[Contributing] [Standards] Add note about trigger_error() and deprecation messages #5840

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion contributing/code/standards.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,18 @@ example containing most features described below:
$this->fooBar = $this->transformText($dummy);
}

/**
* @return string
*
* @deprecated
*/
public function someDeprecatedMethod()
{
@trigger_error(sprintf('The %s() method is deprecated since version 2.8 and will be removed in 3.0. Use Acme\Baz::someMethod() instead.', __METHOD__), E_USER_DEPRECATED);
Copy link
Member

Choose a reason for hiding this comment

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

Afaik, sprintf isn't used for deprecations in the code, is it?

Copy link
Member

Choose a reason for hiding this comment

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

It's mixed. Sometimes we use it, sometimes we don't.

@symfony/deciders What do you think? Should we advise to use sprintf()?

Copy link
Member

Choose a reason for hiding this comment

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

👍 to use sprintf, it is coherent with our recommandation for exception messages.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It would be nice to normalize all the calls in some point.


return Baz::someMethod();
}

/**
* Transforms the input given as first argument.
*
Expand Down Expand Up @@ -151,7 +163,11 @@ Structure
* Use parentheses when instantiating classes regardless of the number of
arguments the constructor has;

* Exception message strings should be concatenated using :phpfunction:`sprintf`.
* Exception and error message strings should be concatenated using :phpfunction:`sprintf`.

* Calls to :phpfunction:`trigger_error` with type ``E_USER_DEPRECATED`` should be
switched to opt-in via ``@`` operator.
Copy link
Member

Choose a reason for hiding this comment

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

Just FYI, this line break will not be visible.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sure @xabbuh, it's just my soft limit. Thanks.

Read more at :ref:`contributing-code-conventions-deprecations`;

Naming Conventions
------------------
Expand Down