init

eeeeee/vendor/cakephp/datasource/Locator/AbstractLocator.php

@@ -0,0 +1,118 @@
+<?php
+declare(strict_types=1);
+
+/**
+ * CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
+ * Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
+ *
+ * Licensed under The MIT License
+ * For full copyright and license information, please see the LICENSE.txt
+ * Redistributions of files must retain the above copyright notice.
+ *
+ * @copyright     Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
+ * @link          https://cakephp.org CakePHP(tm) Project
+ * @since         4.1.0
+ * @license       https://opensource.org/licenses/mit-license.php MIT License
+ */
+namespace Cake\Datasource\Locator;
+
+use Cake\Core\Exception\CakeException;
+use Cake\Datasource\RepositoryInterface;
+
+/**
+ * Provides an abstract registry/factory for repository objects.
+ *
+ * @template TRepo of \Cake\Datasource\RepositoryInterface
+ * @implements \Cake\Datasource\Locator\LocatorInterface<TRepo>
+ */
+abstract class AbstractLocator implements LocatorInterface
+{
+    /**
+     * Instances that belong to the registry.
+     *
+     * @var array<string, TRepo>
+     */
+    protected array $instances = [];
+
+    /**
+     * Contains a list of options that were passed to get() method.
+     *
+     * @var array<string, array>
+     */
+    protected array $options = [];
+
+    /**
+     * {@inheritDoc}
+     *
+     * @param string $alias The alias name you want to get.
+     * @param array<string, mixed> $options The options you want to build the table with.
+     * @return TRepo
+     * @throws \Cake\Core\Exception\CakeException When trying to get alias for which instance
+     *   has already been created with different options.
+     */
+    public function get(string $alias, array $options = []): RepositoryInterface
+    {
+        $storeOptions = $options;
+        unset($storeOptions['allowFallbackClass']);
+
+        if (isset($this->instances[$alias])) {
+            if ($storeOptions && isset($this->options[$alias]) && $this->options[$alias] !== $storeOptions) {
+                throw new CakeException(sprintf(
+                    'You cannot configure `%s`, it already exists in the registry.',
+                    $alias,
+                ));
+            }
+
+            return $this->instances[$alias];
+        }
+
+        $this->options[$alias] = $storeOptions;
+
+        return $this->instances[$alias] = $this->createInstance($alias, $options);
+    }
+
+    /**
+     * Create an instance of a given classname.
+     *
+     * @param string $alias Repository alias.
+     * @param array<string, mixed> $options The options you want to build the instance with.
+     * @return TRepo
+     */
+    abstract protected function createInstance(string $alias, array $options): RepositoryInterface;
+
+    /**
+     * @inheritDoc
+     */
+    public function set(string $alias, RepositoryInterface $repository): RepositoryInterface
+    {
+        return $this->instances[$alias] = $repository;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function exists(string $alias): bool
+    {
+        return isset($this->instances[$alias]);
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function remove(string $alias): void
+    {
+        unset(
+            $this->instances[$alias],
+            $this->options[$alias],
+        );
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function clear(): void
+    {
+        $this->instances = [];
+        $this->options = [];
+    }
+}

eeeeee/vendor/cakephp/datasource/Locator/LocatorInterface.php

@@ -0,0 +1,70 @@
+<?php
+declare(strict_types=1);
+
+/**
+ * CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
+ * Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
+ *
+ * Licensed under The MIT License
+ * For full copyright and license information, please see the LICENSE.txt
+ * Redistributions of files must retain the above copyright notice.
+ *
+ * @copyright     Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
+ * @link          https://cakephp.org CakePHP(tm) Project
+ * @since         4.1.0
+ * @license       https://opensource.org/licenses/mit-license.php MIT License
+ */
+namespace Cake\Datasource\Locator;
+
+use Cake\Datasource\RepositoryInterface;
+
+/**
+ * Registries for repository objects should implement this interface.
+ *
+ * @template TRepo of \Cake\Datasource\RepositoryInterface
+ */
+interface LocatorInterface
+{
+    /**
+     * Get a repository instance from the registry.
+     *
+     * @param string $alias The alias name you want to get.
+     * @param array<string, mixed> $options The options you want to build the table with.
+     * @return TRepo
+     * @throws \RuntimeException When trying to get alias for which instance
+     *   has already been created with different options.
+     */
+    public function get(string $alias, array $options = []): RepositoryInterface;
+
+    /**
+     * Set a repository instance.
+     *
+     * @param string $alias The alias to set.
+     * @param TRepo $repository The repository to set.
+     * @return TRepo
+     */
+    public function set(string $alias, RepositoryInterface $repository): RepositoryInterface;
+
+    /**
+     * Check to see if an instance exists in the registry.
+     *
+     * @param string $alias The alias to check for.
+     * @return bool
+     */
+    public function exists(string $alias): bool;
+
+    /**
+     * Removes an repository instance from the registry.
+     *
+     * @param string $alias The alias to remove.
+     * @return void
+     */
+    public function remove(string $alias): void;
+
+    /**
+     * Clears the registry of configuration and instances.
+     *
+     * @return void
+     */
+    public function clear(): void;
+}