vendor/netzmacht/contao-toolkit/src/Bundle/DependencyInjection/ContaoServicesFactory.php line 91

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. namespace Netzmacht\Contao\Toolkit\Bundle\DependencyInjection;
  7. use Contao\Backend;
  8. use Contao\BackendUser;
  9. use Contao\Config;
  10. use Contao\Controller;
  11. use Contao\CoreBundle\Framework\Adapter;
  12. use Contao\CoreBundle\Framework\ContaoFramework;
  13. use Contao\Dbafs;
  14. use Contao\Encryption;
  15. use Contao\Environment;
  16. use Contao\Frontend;
  17. use Contao\FrontendUser;
  18. use Contao\Image;
  19. use Contao\Input;
  20. use Contao\Message;
  21. use Contao\Model;
  22. use Contao\System;
  24. use function assert;
  26. /**
  27.  * @SuppressWarnings(PHPMD.TooManyPublicMethods)
  28.  */
  29. final class ContaoServicesFactory
  30. {
  31.     /**
  32.      * Contao framework.
  33.      *
  34.      * @var ContaoFramework
  35.      */
  36.     private $framework;
  38.     /**
  39.      * @param ContaoFramework $framework Contao framework.
  40.      */
  41.     public function __construct(ContaoFramework $framework)
  42.     {
  43.         $this->framework = $framework;
  44.     }
  46.     /**
  47.      * Create the backend adapter.
  48.      *
  49.      * @return Adapter<Backend>
  50.      */
  51.     public function createBackendAdapter(): Adapter
  52.     {
  53.         return $this->createAdapter(Backend::class);
  54.     }
  56.     /**
  57.      * Create input adapter.
  58.      *
  59.      * @return Adapter<Input>
  60.      */
  61.     public function createInputAdapter(): Adapter
  62.     {
  63.         return $this->createAdapter(Input::class);
  64.     }
  66.     /**
  67.      * Create the config adapter.
  68.      *
  69.      * @return Adapter<Config>
  70.      */
  71.     public function createConfigAdapter(): Adapter
  72.     {
  73.         return $this->createAdapter(Config::class);
  74.     }
  76.     /**
  77.      * Create the controller adapter.
  78.      *
  79.      * @return Adapter<Controller>
  80.      */
  81.     public function createControllerAdapter(): Adapter
  82.     {
  83.         return $this->createAdapter(Controller::class);
  84.     }
  86.     /**
  87.      * Create the system adapter.
  88.      *
  89.      * @return Adapter<System>
  90.      */
  91.     public function createSystemAdapter(): Adapter
  92.     {
  93.         return $this->createAdapter(System::class);
  94.     }
  96.     /**
  97.      * Create an environment adapter.
  98.      *
  99.      * @return Adapter<Environment>
  100.      */
  101.     public function createEnvironmentAdapter(): Adapter
  102.     {
  103.         return $this->createAdapter(Environment::class);
  104.     }
  106.     /**
  107.      * Create an encryption adapter.
  108.      *
  109.      * @return Adapter<Encryption>
  110.      */
  111.     public function createEncryptionAdapter(): Adapter
  112.     {
  113.         return $this->createAdapter(Encryption::class);
  114.     }
  116.     /**
  117.      * Create a frontend adapter.
  118.      *
  119.      * @return Adapter<Frontend>
  120.      */
  121.     public function createFrontendAdapter(): Adapter
  122.     {
  123.         return $this->createAdapter(Frontend::class);
  124.     }
  126.     /**
  127.      * Create an image adapter.
  128.      *
  129.      * @return Adapter<Image>
  130.      */
  131.     public function createImageAdapter(): Adapter
  132.     {
  133.         return $this->createAdapter(Image::class);
  134.     }
  136.     /**
  137.      * Create backend user instance.
  138.      */
  139.     public function createBackendUserInstance(): BackendUser
  140.     {
  141.         return $this->createInstance(BackendUser::class);
  142.     }
  144.     /**
  145.      * Frontend user.
  146.      */
  147.     public function createFrontendUserInstance(): FrontendUser
  148.     {
  149.         return $this->createInstance(FrontendUser::class);
  150.     }
  152.     /**
  153.      * Create a model adapter.
  154.      *
  155.      * @return Adapter<Model>
  156.      */
  157.     public function createModelAdapter(): Adapter
  158.     {
  159.         return $this->createAdapter(Model::class);
  160.     }
  162.     /**
  163.      * Create a message adapter.
  164.      *
  165.      * @return Adapter<Message>
  166.      */
  167.     public function createMessageAdapter(): Adapter
  168.     {
  169.         return $this->createAdapter(Message::class);
  170.     }
  172.     /**
  173.      * Create a message adapter.
  174.      *
  175.      * @return Adapter<Dbafs>
  176.      */
  177.     public function createDbafsAdapter(): Adapter
  178.     {
  179.         return $this->createAdapter(Dbafs::class);
  180.     }
  182.     // phpcs:disable SlevomatCodingStandard.Commenting.DocCommentSpacing.IncorrectOrderOfAnnotationsGroup
  184.     /**
  185.      * Create an adapter for a specific class.
  186.      *
  187.      * @template T
  188.      *
  189.      * @param class-string<T> $class Class name.
  190.      *
  191.      * @return Adapter<T>
  192.      */
  193.     private function createAdapter(string $class): Adapter
  194.     {
  195.         $this->framework->initialize();
  197.         return $this->framework->getAdapter($class);
  198.     }
  200.     /**
  201.      * Create an adapter for a specific class.
  202.      *
  203.      * @template T
  204.      *
  205.      * @param class-string<T> $class Class name.
  206.      *
  207.      * @return T
  208.      */
  209.     private function createInstance(string $class): object
  210.     {
  211.         $this->framework->initialize();
  213.         $instance = $this->framework->createInstance($class);
  214.         assert($instance instanceof $class);
  216.         return $instance;
  217.     }
  219.     // phpcs:enable SlevomatCodingStandard.Commenting.DocCommentSpacing.IncorrectOrderOfAnnotationsGroup
  220. }