DeprecatedSniff
in
Table of Contents
Methods
- getDeprecationMessage() : string
- Optionally provide an arbitrary custom message to display with the deprecation.
- getDeprecationVersion() : string
- Provide the version number in which the sniff was deprecated.
- getRemovalVersion() : string
- Provide the version number in which the sniff will be removed.
Methods
getDeprecationMessage()
Optionally provide an arbitrary custom message to display with the deprecation.
public
getDeprecationMessage() : string
Typically intended to allow for displaying information about what to replace the deprecated sniff with. Example: "Use the Stnd.Cat.SniffName sniff instead." Multi-line messages (containing new line characters) are supported.
An empty string can be returned if there is no replacement/no need for a custom message.
Return values
stringgetDeprecationVersion()
Provide the version number in which the sniff was deprecated.
public
getDeprecationVersion() : string
Recommended format for PHPCS native sniffs: "v3.3.0". Recommended format for external sniffs: "StandardName v3.3.0".
Return values
stringgetRemovalVersion()
Provide the version number in which the sniff will be removed.
public
getRemovalVersion() : string
Recommended format for PHPCS native sniffs: "v3.3.0". Recommended format for external sniffs: "StandardName v3.3.0".
If the removal version is not yet known, it is recommended to set this to: "a future version".