nextcloud/lib/private/Hooks/EmitterTrait.php

106 lines
2.7 KiB
PHP
Raw Normal View History

2015-05-07 14:37:38 +03:00
<?php
/**
2016-07-21 18:07:57 +03:00
* @copyright Copyright (c) 2016, ownCloud, Inc.
*
* @author Christoph Wurst <christoph@winzerhof-wurst.at>
* @author Morris Jobke <hey@morrisjobke.de>
2016-07-21 19:13:36 +03:00
* @author Robin Appelman <robin@icewind.nl>
2015-05-07 14:37:38 +03:00
*
* @license AGPL-3.0
*
* This code is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* This program 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 Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License, version 3,
* along with this program. If not, see <http://www.gnu.org/licenses/>
2015-05-07 14:37:38 +03:00
*
*/
namespace OC\Hooks;
trait EmitterTrait {
/**
* @var callable[][] $listeners
2015-05-07 14:37:38 +03:00
*/
protected $listeners = [];
2015-05-07 14:37:38 +03:00
/**
* @param string $scope
* @param string $method
* @param callable $callback
*/
2015-05-08 14:51:32 +03:00
public function listen($scope, $method, callable $callback) {
2015-05-07 14:37:38 +03:00
$eventName = $scope . '::' . $method;
if (!isset($this->listeners[$eventName])) {
$this->listeners[$eventName] = [];
2015-05-07 14:37:38 +03:00
}
2015-05-08 14:51:32 +03:00
if (array_search($callback, $this->listeners[$eventName], true) === false) {
2015-05-07 14:37:38 +03:00
$this->listeners[$eventName][] = $callback;
}
}
/**
* @param string $scope optional
* @param string $method optional
* @param callable $callback optional
*/
2015-05-08 14:51:32 +03:00
public function removeListener($scope = null, $method = null, callable $callback = null) {
$names = [];
2015-05-07 14:37:38 +03:00
$allNames = array_keys($this->listeners);
if ($scope and $method) {
$name = $scope . '::' . $method;
if (isset($this->listeners[$name])) {
$names[] = $name;
}
} elseif ($scope) {
foreach ($allNames as $name) {
$parts = explode('::', $name, 2);
if ($parts[0] == $scope) {
$names[] = $name;
}
}
} elseif ($method) {
foreach ($allNames as $name) {
$parts = explode('::', $name, 2);
if ($parts[1] == $method) {
$names[] = $name;
}
}
} else {
$names = $allNames;
}
foreach ($names as $name) {
if ($callback) {
2015-05-08 14:51:32 +03:00
$index = array_search($callback, $this->listeners[$name], true);
2015-05-07 14:37:38 +03:00
if ($index !== false) {
unset($this->listeners[$name][$index]);
}
} else {
$this->listeners[$name] = [];
2015-05-07 14:37:38 +03:00
}
}
}
/**
* @param string $scope
* @param string $method
* @param array $arguments optional
*/
protected function emit($scope, $method, array $arguments = []) {
2015-05-07 14:37:38 +03:00
$eventName = $scope . '::' . $method;
if (isset($this->listeners[$eventName])) {
foreach ($this->listeners[$eventName] as $callback) {
call_user_func_array($callback, $arguments);
}
}
}
}