2023-01-15 22:31:19 +01:00
|
|
|
<?php
|
|
|
|
/**
|
|
|
|
* @copyright Copyright (C) 2010-2023, the Friendica project
|
|
|
|
*
|
|
|
|
* @license GNU AGPL version 3 or any later version
|
|
|
|
*
|
|
|
|
* This program is free software: you can redistribute it and/or modify
|
|
|
|
* it under the terms of the GNU Affero General Public License as
|
|
|
|
* published by the Free Software Foundation, either version 3 of the
|
|
|
|
* License, or (at your option) any later version.
|
|
|
|
*
|
|
|
|
* 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
|
|
|
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
2023-07-23 03:21:41 +02:00
|
|
|
namespace Friendica\Core\Hooks\Capability;
|
2023-01-15 22:31:19 +01:00
|
|
|
|
|
|
|
use Friendica\Core\Hooks\Exceptions\HookRegisterArgumentException;
|
|
|
|
|
|
|
|
/**
|
2023-07-17 00:10:15 +02:00
|
|
|
* Register strategies for given classes
|
2023-01-15 22:31:19 +01:00
|
|
|
*/
|
2023-07-21 22:41:36 +02:00
|
|
|
interface ICanRegisterStrategies
|
2023-01-15 22:31:19 +01:00
|
|
|
{
|
|
|
|
/**
|
|
|
|
* Register a class(strategy) for a given interface with a unique name.
|
|
|
|
*
|
|
|
|
* @see https://refactoring.guru/design-patterns/strategy
|
|
|
|
*
|
2023-07-02 23:56:56 +02:00
|
|
|
* @param string $interface The interface, which the given class implements
|
|
|
|
* @param string $class The fully-qualified given class name
|
|
|
|
* A placeholder for dependencies is possible as well
|
2023-07-21 22:41:36 +02:00
|
|
|
* @param ?string $name An arbitrary identifier for the given strategy, which will be used for factories, dependency injections etc.
|
2023-01-15 22:31:19 +01:00
|
|
|
*
|
|
|
|
* @return $this This interface for chain-calls
|
|
|
|
*
|
|
|
|
* @throws HookRegisterArgumentException in case the given class for the interface isn't valid or already set
|
|
|
|
*/
|
2023-07-02 23:56:56 +02:00
|
|
|
public function registerStrategy(string $interface, string $class, ?string $name = null): self;
|
2023-01-15 22:31:19 +01:00
|
|
|
}
|