src/Core/Hooks/Capabilities/ICanCreateInstances.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 /**
  25  * creates special instances for given classes
  26  */
  27 interface ICanCreateInstances
  28 {
  29         /**
  30          * Returns a new instance of a given class for the corresponding name
  31          *
  32          * The instance will be build based on the registered strategy and the (unique) name
  33          *
  34          * @param string $class     The fully-qualified name of the given class or interface which will get returned
  35          * @param string $name      An arbitrary identifier to find a concrete instance strategy.
  36          * @param array  $arguments Additional arguments, which can be passed to the constructor of "$class" at runtime
  37          *
  38          * @return object The concrete instance of the type "$class"
  39          */
  40         public function create(string $class, string $name, array $arguments = []): object;
  41 }