vendor/jackalope/jackalope-doctrine-dbal/src/Jackalope/RepositoryFactoryDoctrineDBAL.php line 94

  1. <?php
  3. namespace Jackalope;
  5. use Doctrine\DBAL\ColumnCase;
  6. use Doctrine\DBAL\Connection;
  7. use Doctrine\DBAL\Platforms\OraclePlatform;
  8. use Doctrine\DBAL\Portability\Middleware as PortabilityMiddleware;
  9. use Doctrine\DBAL\Portability\Connection as PortabilityConnection;
  10. use Jackalope\Transport\DoctrineDBAL\CachedClient;
  11. use Jackalope\Transport\DoctrineDBAL\Client;
  12. use Jackalope\Transport\DoctrineDBAL\LoggingClient;
  13. use PHPCR\ConfigurationException;
  14. use PHPCR\RepositoryFactoryInterface;
  16. /**
  17.  * This factory creates repositories with the Doctrine DBAL transport
  18.  *
  19.  * Use repository factory based on parameters (the parameters below are examples):
  20.  *
  21.  * <pre>
  22.  *    $parameters = array('jackalope.doctrine_dbal_connection' => $dbConn);
  23.  *    $factory = new \Jackalope\RepositoryFactoryDoctrineDBAL();
  24.  *    $repository = $factory->getRepository($parameters);
  25.  * </pre>
  26.  *
  27.  * @license http://www.apache.org/licenses Apache License Version 2.0, January 2004
  28.  * @license http://opensource.org/licenses/MIT MIT License
  29.  *
  30.  * @api
  31.  */
  32. class RepositoryFactoryDoctrineDBAL implements RepositoryFactoryInterface
  33. {
  34.     /**
  35.      * List of required parameters for doctrine dbal.
  36.      *
  37.      * TODO: would be nice if alternatively one could also specify the parameters to let the factory build the connection
  38.      *
  39.      * @var array
  40.      */
  41.     private static $required = [
  42.         'jackalope.doctrine_dbal_connection' => 'Doctrine\\DBAL\\Connection (required): connection instance',
  43.     ];
  45.     /**
  46.      * List of optional parameters for doctrine dbal.
  47.      *
  48.      * @var array
  49.      */
  50.     private static $optional = [
  51.         'jackalope.factory' => 'string or object: Use a custom factory class for Jackalope objects',
  52.         'jackalope.check_login_on_server' => 'boolean: if set to empty or false, skip initial check whether repository exists. Enabled by default, disable to gain a few milliseconds off each repository instantiation.',
  53.         'jackalope.disable_transactions' => 'boolean: if set and not empty, transactions are disabled, otherwise transactions are enabled. If transactions are enabled but not actively used, every save operation is wrapped into a transaction.',
  54.         'jackalope.disable_stream_wrapper' => 'boolean: if set and not empty, stream wrapper is disabled, otherwise the stream wrapper is enabled and streams are only fetched when reading from for the first time. If your code always uses all binary properties it reads, you can disable this for a small performance gain.',
  55.         'jackalope.data_caches' => 'array: an array of \Doctrine\Common\Cache\Cache instances. keys can be "meta" and "nodes", should be separate namespaces for best performance.',
  56.         'jackalope.logger' => 'Psr\Log\LoggerInterface: Use the LoggingClient to wrap the default transport Client',
  57.         Session::OPTION_AUTO_LASTMODIFIED => 'boolean: Whether to automatically update nodes having mix:lastModified. Defaults to true.',
  58.     ];
  60.     /**
  61.      * Get a repository connected to the backend with the provided doctrine
  62.      * dbal connection.
  63.      *
  64.      * {@inheritDoc}
  65.      *
  66.      * DoctrineDBAL repositories have no default repository, passing null as
  67.      * parameters will always return null.
  68.      *
  69.      * @api
  70.      */
  71.     public function getRepository(array $parameters = null)
  72.     {
  73.         if (null === $parameters) {
  74.             throw new ConfigurationException('Jackalope-doctrine-dbal needs parameters');
  75.         }
  77.         if (count(array_diff_key(self::$required, $parameters))) {
  78.             throw new ConfigurationException('A required parameter is missing: ' . implode(', ', array_keys(array_diff_key(self::$required, $parameters))));
  79.         }
  81.         if (count(array_diff_key($parameters, self::$required, self::$optional))) {
  82.             throw new ConfigurationException('Additional unknown parameters found: ' . implode(', ', array_keys(array_diff_key($parameters, self::$required, self::$optional))));
  83.         }
  85.         if (isset($parameters['jackalope.factory'])) {
  86.             $factory = $parameters['jackalope.factory'] instanceof FactoryInterface
  87.                 ? $parameters['jackalope.factory'] : new $parameters['jackalope.factory'];
  88.         } else {
  89.             $factory = new Factory();
  90.         }
  92.         $dbConn = $parameters['jackalope.doctrine_dbal_connection'];
  93.         \assert($dbConn instanceof Connection);
  94.         if ($dbConn->getDatabasePlatform() instanceof OraclePlatform) {
  95.             $this->ensureLowerCaseMiddleware($dbConn);
  96.         }
  98.         $transport = isset($parameters['jackalope.data_caches'])
  99.             ? $factory->get(CachedClient::class, [$dbConn, $parameters['jackalope.data_caches']])
  100.             : $factory->get(Client::class, [$dbConn]);
  102.         if (isset($parameters['jackalope.check_login_on_server'])) {
  103.             $transport->setCheckLoginOnServer($parameters['jackalope.check_login_on_server']);
  104.         }
  106.         if (isset($parameters['jackalope.uuid_generator'])) {
  107.             $transport->setUuidGenerator($parameters['jackalope.uuid_generator']);
  108.         }
  110.         if (isset($parameters['jackalope.logger'])) {
  111.             $transport = $factory->get(LoggingClient::class, [$transport, $parameters['jackalope.logger']]);
  112.         }
  114.         $options['transactions'] = empty($parameters['jackalope.disable_transactions']);
  115.         $options['stream_wrapper'] = empty($parameters['jackalope.disable_stream_wrapper']);
  116.         if (isset($parameters[Session::OPTION_AUTO_LASTMODIFIED])) {
  117.             $options[Session::OPTION_AUTO_LASTMODIFIED] = $parameters[Session::OPTION_AUTO_LASTMODIFIED];
  118.         }
  120.         return new Repository($factory, $transport, $options);
  121.     }
  123.     /**
  124.      * {@inheritDoc}
  125.      *
  126.      * @api
  127.      */
  128.     public function getConfigurationKeys()
  129.     {
  130.         return array_merge(self::$required, self::$optional);
  131.     }
  133.     /**
  134.      * Add the lowercase portability middleware if it is not already part of the configuration.
  135.      */
  136.     private function ensureLowerCaseMiddleware(Connection $dbConn): void
  137.     {
  138.         $configuration = $dbConn->getConfiguration();
  139.         if (!$configuration) {
  140.             return;
  141.         }
  142.         foreach ($configuration->getMiddlewares() as $middleware) {
  143.             if ($middleware instanceof PortabilityMiddleware) {
  144.                 return;
  145.             }
  146.         }
  147.         $middlewares = $configuration->getMiddlewares();
  148.         $middlewares[] = new PortabilityMiddleware(PortabilityConnection::PORTABILITY_FIX_CASE, ColumnCase::LOWER);
  149.         $configuration->setMiddlewares($middlewares);
  150.     }
  151. }