Home
Docs
GitHub
Pricing
Blog
Log In

Run Sandworm Audit for your App

Get started
Hold on, we're currently generating a fresh version of this report
Generated on May 17, 2024 via composer

symfony/deprecation-contracts v3.4.0

A generic function and convention to trigger deprecation notices
Package summary
Share
0
issues
1
license
1
MIT
Package created
8 Feb 2020
Version published
23 May 2023
Maintainers
1
Total deps
1
Direct deps
0
License
MIT

Issues

0
This package has no issues

Licenses

MIT License

Permissive
OSI Approved
This is a human-readable summary of (and not a substitute for) the license. Disclaimer.
Can
commercial-use
modify
distribute
sublicense
private-use
Cannot
hold-liable
Must
include-copyright
include-license
1 Packages, Including:
symfony/deprecation-contracts@v3.4.0
Disclaimer

This deed highlights only some of the key features and terms of the actual license. It is not a license and has no legal value. You should carefully review all of the terms and conditions of the actual license before using the licensed material.

Sandworm is not a law firm and does not provide legal services. Distributing, displaying, or linking to this deed or the license that it summarizes does not create a lawyer-client or any other relationship.

Direct Dependencies

0
All Dependencies CSV
β“˜ This is a list of symfony/deprecation-contracts 's direct dependencies. Data on all dependencies, including transitive ones, is available via CSV download.
NameVersionSizeLicenseTypeVulnerabilities

Visualizations

Frequently Asked Questions

What does symfony/deprecation-contracts do?

Symfony/Deprecation-Contracts is a valuable toolkit designed to trigger deprecation warnings in a consistent manner. The function provided by this package is a universal way to tackle the task of alerting users about deprecated features in your PHP applications. Thus, it serves as a bridge, ensuring both developers and users are aware of any functionality that is being phased out without disrupting the operational flow.

How do you use symfony/deprecation-contracts?

To implement the Symfony/Deprecation-Contracts function, you use trigger_deprecation(), a global function that triggers silenced deprecation notices. This function allows for granular expressions of deprecation, specifying the Composer package linked to the deprecation, the version in which the deprecation was introduced, and the message explaining the deprecation. Additional arguments can be defined for further detail, allowing printf() formatting in the message.

In an illustrative example:

trigger_deprecation('symfony/blockchain', '8.9', 'Using "%s" is deprecated, use "%s" instead.', 'bitcoin', 'fabcoin');

This code will generate a message indicating that usage of "bitcoin" has been deprecated in favor of "fabcoin" since version 8.9 of the symfony/blockchain package. To completely ignore deprecation notices (though not recommended), you can declare an empty function trigger_deprecation() {} in your application.

Where are the symfony/deprecation-contracts docs?

As per the information on the GitHub page, there doesn't appear to be an official dedicated documentation page for the symfony/deprecation-contracts. Developers are likely guided by the README provided on the GitHub repository, which contains essential details for understanding and using the package. However, for other components of the Symfony ecosystem, comprehensive documentation can usually be found on the official Symfony website.