Merge pull request #23767 from nextcloud/techdebt/noid/add-deprecated-tag-to-all-methods

Add deprecated tag also to methods of deprecated classes - OC\\Hooks\\Emitter namespace
This commit is contained in:
Morris Jobke 2020-10-29 09:03:52 +01:00 committed by GitHub
commit 3076eb4e9b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 9 additions and 0 deletions

View File

@ -39,6 +39,7 @@ interface Emitter {
* @param string $method
* @param callable $callback
* @return void
* @deprecated 18.0.0 use \OCP\EventDispatcher\IEventDispatcher::addListener
*/
public function listen($scope, $method, callable $callback);
@ -47,6 +48,7 @@ interface Emitter {
* @param string $method optional
* @param callable $callback optional
* @return void
* @deprecated 18.0.0 use \OCP\EventDispatcher\IEventDispatcher::removeListener
*/
public function removeListener($scope = null, $method = null, callable $callback = null);
}

View File

@ -24,6 +24,9 @@
namespace OC\Hooks;
/**
* @deprecated 18.0.0 use events and the \OCP\EventDispatcher\IEventDispatcher service
*/
trait EmitterTrait {
/**
@ -35,6 +38,7 @@ trait EmitterTrait {
* @param string $scope
* @param string $method
* @param callable $callback
* @deprecated 18.0.0 use \OCP\EventDispatcher\IEventDispatcher::addListener
*/
public function listen($scope, $method, callable $callback) {
$eventName = $scope . '::' . $method;
@ -50,6 +54,7 @@ trait EmitterTrait {
* @param string $scope optional
* @param string $method optional
* @param callable $callback optional
* @deprecated 18.0.0 use \OCP\EventDispatcher\IEventDispatcher::removeListener
*/
public function removeListener($scope = null, $method = null, callable $callback = null) {
$names = [];
@ -93,6 +98,7 @@ trait EmitterTrait {
* @param string $scope
* @param string $method
* @param array $arguments optional
* @deprecated 18.0.0 use \OCP\EventDispatcher\IEventDispatcher::dispatchTyped
*/
protected function emit($scope, $method, array $arguments = []) {
$eventName = $scope . '::' . $method;

View File

@ -33,6 +33,7 @@ class PublicEmitter extends BasicEmitter {
* @param string $scope
* @param string $method
* @param array $arguments optional
* @deprecated 18.0.0 use \OCP\EventDispatcher\IEventDispatcher::dispatchTyped
*
* @suppress PhanAccessMethodProtected
*/