src/Core/Hooks/Capabilities/ICanRegisterInstances.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2023, the Friendica project
   4  *
   5  * @license GNU AGPL version 3 or any later version
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU Affero General Public License as
   9  * published by the Free Software Foundation, either version 3 of the
  10  * License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU Affero General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  19  *
  20  */
  21
  22 namespace Friendica\Core\Hooks\Capabilities;
  23
  24 use Friendica\Core\Hooks\Exceptions\HookRegisterArgumentException;
  25
  26 /**
  27  * Register strategies for given classes
  28  */
  29 interface ICanRegisterInstances
  30 {
  31         /**
  32          * Register a class(strategy) for a given interface with a unique name.
  33          *
  34          * @see https://refactoring.guru/design-patterns/strategy
  35          *
  36          * @param string  $interface The interface, which the given class implements
  37          * @param string  $class     The fully-qualified given class name
  38          *                           A placeholder for dependencies is possible as well
  39          * @param ?string $name      An arbitrary identifier for the given class, which will be used for factories, dependency injections etc.
  40          *
  41          * @return $this This interface for chain-calls
  42          *
  43          * @throws HookRegisterArgumentException in case the given class for the interface isn't valid or already set
  44          */
  45         public function registerStrategy(string $interface, string $class, ?string $name = null): self;
  46 }