summaryrefslogtreecommitdiff
path: root/vendor/symfony/deprecation-contracts
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/symfony/deprecation-contracts')
-rw-r--r--vendor/symfony/deprecation-contracts/CHANGELOG.md5
-rw-r--r--vendor/symfony/deprecation-contracts/LICENSE19
-rw-r--r--vendor/symfony/deprecation-contracts/README.md26
-rw-r--r--vendor/symfony/deprecation-contracts/composer.json35
-rw-r--r--vendor/symfony/deprecation-contracts/function.php27
5 files changed, 112 insertions, 0 deletions
diff --git a/vendor/symfony/deprecation-contracts/CHANGELOG.md b/vendor/symfony/deprecation-contracts/CHANGELOG.md
new file mode 100644
index 0000000..7932e26
--- /dev/null
+++ b/vendor/symfony/deprecation-contracts/CHANGELOG.md
@@ -0,0 +1,5 @@
1CHANGELOG
2=========
3
4The changelog is maintained for all Symfony contracts at the following URL:
5https://github.com/symfony/contracts/blob/main/CHANGELOG.md
diff --git a/vendor/symfony/deprecation-contracts/LICENSE b/vendor/symfony/deprecation-contracts/LICENSE
new file mode 100644
index 0000000..0ed3a24
--- /dev/null
+++ b/vendor/symfony/deprecation-contracts/LICENSE
@@ -0,0 +1,19 @@
1Copyright (c) 2020-present Fabien Potencier
2
3Permission is hereby granted, free of charge, to any person obtaining a copy
4of this software and associated documentation files (the "Software"), to deal
5in the Software without restriction, including without limitation the rights
6to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7copies of the Software, and to permit persons to whom the Software is furnished
8to do so, subject to the following conditions:
9
10The above copyright notice and this permission notice shall be included in all
11copies or substantial portions of the Software.
12
13THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
19THE SOFTWARE.
diff --git a/vendor/symfony/deprecation-contracts/README.md b/vendor/symfony/deprecation-contracts/README.md
new file mode 100644
index 0000000..9814864
--- /dev/null
+++ b/vendor/symfony/deprecation-contracts/README.md
@@ -0,0 +1,26 @@
1Symfony Deprecation Contracts
2=============================
3
4A generic function and convention to trigger deprecation notices.
5
6This package provides a single global function named `trigger_deprecation()` that triggers silenced deprecation notices.
7
8By using a custom PHP error handler such as the one provided by the Symfony ErrorHandler component,
9the triggered deprecations can be caught and logged for later discovery, both on dev and prod environments.
10
11The function requires at least 3 arguments:
12 - the name of the Composer package that is triggering the deprecation
13 - the version of the package that introduced the deprecation
14 - the message of the deprecation
15 - more arguments can be provided: they will be inserted in the message using `printf()` formatting
16
17Example:
18```php
19trigger_deprecation('symfony/blockchain', '8.9', 'Using "%s" is deprecated, use "%s" instead.', 'bitcoin', 'fabcoin');
20```
21
22This will generate the following message:
23`Since symfony/blockchain 8.9: Using "bitcoin" is deprecated, use "fabcoin" instead.`
24
25While not recommended, the deprecation notices can be completely ignored by declaring an empty
26`function trigger_deprecation() {}` in your application.
diff --git a/vendor/symfony/deprecation-contracts/composer.json b/vendor/symfony/deprecation-contracts/composer.json
new file mode 100644
index 0000000..ceb6c07
--- /dev/null
+++ b/vendor/symfony/deprecation-contracts/composer.json
@@ -0,0 +1,35 @@
1{
2 "name": "symfony/deprecation-contracts",
3 "type": "library",
4 "description": "A generic function and convention to trigger deprecation notices",
5 "homepage": "https://symfony.com",
6 "license": "MIT",
7 "authors": [
8 {
9 "name": "Nicolas Grekas",
10 "email": "p@tchwork.com"
11 },
12 {
13 "name": "Symfony Community",
14 "homepage": "https://symfony.com/contributors"
15 }
16 ],
17 "require": {
18 "php": ">=8.1"
19 },
20 "autoload": {
21 "files": [
22 "function.php"
23 ]
24 },
25 "minimum-stability": "dev",
26 "extra": {
27 "branch-alias": {
28 "dev-main": "3.5-dev"
29 },
30 "thanks": {
31 "name": "symfony/contracts",
32 "url": "https://github.com/symfony/contracts"
33 }
34 }
35}
diff --git a/vendor/symfony/deprecation-contracts/function.php b/vendor/symfony/deprecation-contracts/function.php
new file mode 100644
index 0000000..2d56512
--- /dev/null
+++ b/vendor/symfony/deprecation-contracts/function.php
@@ -0,0 +1,27 @@
1<?php
2
3/*
4 * This file is part of the Symfony package.
5 *
6 * (c) Fabien Potencier <fabien@symfony.com>
7 *
8 * For the full copyright and license information, please view the LICENSE
9 * file that was distributed with this source code.
10 */
11
12if (!function_exists('trigger_deprecation')) {
13 /**
14 * Triggers a silenced deprecation notice.
15 *
16 * @param string $package The name of the Composer package that is triggering the deprecation
17 * @param string $version The version of the package that introduced the deprecation
18 * @param string $message The message of the deprecation
19 * @param mixed ...$args Values to insert in the message using printf() formatting
20 *
21 * @author Nicolas Grekas <p@tchwork.com>
22 */
23 function trigger_deprecation(string $package, string $version, string $message, mixed ...$args): void
24 {
25 @trigger_error(($package || $version ? "Since $package $version: " : '').($args ? vsprintf($message, $args) : $message), \E_USER_DEPRECATED);
26 }
27}