Andrew Nicols
59 lines
2.1 KiB
PHP
59 lines
2.1 KiB
PHP
<?php
|
|
// This file is part of Moodle - http://moodle.org/
|
|
//
|
|
// Moodle is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// Moodle is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
namespace core\attribute;
|
|
|
|
/**
|
|
* Attribute to describe a deprecated item which contains a reference to the owning feature.
|
|
*
|
|
* @package core
|
|
* @copyright 2023 Andrew Lyons <andrew@nicols.co.uk>
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class deprecated_with_reference extends deprecated {
|
|
/**
|
|
* A deprecated item which also includes a reference to the owning feature.
|
|
*
|
|
* This attribute is not expected to be used more generally. It is an internal feature.
|
|
*
|
|
* @param string $owner The code which owns the usage
|
|
* @param null|string $replacement Any replacement for the deprecated thing
|
|
* @param null|string $since When it was deprecated
|
|
* @param null|string $reason Why it was deprecated
|
|
* @param null|string $mdl Link to the Moodle Tracker issue for more information
|
|
* @param bool $final Whether this is a final deprecation
|
|
* @param bool $emit Whether to emit a deprecation warning
|
|
*/
|
|
public function __construct(
|
|
public readonly string $owner,
|
|
?string $replacement,
|
|
?string $since,
|
|
?string $reason,
|
|
?string $mdl,
|
|
bool $final,
|
|
bool $emit,
|
|
) {
|
|
parent::__construct(
|
|
replacement: $replacement,
|
|
since: $since,
|
|
reason: $reason,
|
|
mdl: $mdl,
|
|
final: $final,
|
|
emit: $emit,
|
|
);
|
|
}
|
|
}
|