Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
n/a
0 / 0
n/a
0 / 0
CRAP
n/a
0 / 0
RedisFactory
n/a
0 / 0
n/a
0 / 0
4
n/a
0 / 0
 __invoke
n/a
0 / 0
n/a
0 / 0
2
 getConnection
n/a
0 / 0
n/a
0 / 0
2
1<?php
2
3/**
4 * Generic factory for instantiating session handlers
5 *
6 * PHP version 8
7 *
8 * Copyright (C) Villanova University 2019.
9 *
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License version 2,
12 * as published by the Free Software Foundation.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
22 *
23 * @category VuFind
24 * @package  Session_Handlers
25 * @author   Demian Katz <demian.katz@villanova.edu>
26 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
27 * @link     https://vufind.org/wiki/development Wiki
28 */
29
30namespace VuFind\Session;
31
32use Laminas\ServiceManager\Exception\ServiceNotCreatedException;
33use Laminas\ServiceManager\Exception\ServiceNotFoundException;
34use Laminas\ServiceManager\Factory\FactoryInterface;
35use Psr\Container\ContainerExceptionInterface as ContainerException;
36use Psr\Container\ContainerInterface;
37
38/**
39 * Generic factory for instantiating session handlers
40 *
41 * @category VuFind
42 * @package  Session_Handlers
43 * @author   Demian Katz <demian.katz@villanova.edu>
44 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
45 * @link     https://vufind.org/wiki/development Wiki
46 *
47 * @codeCoverageIgnore
48 */
49class RedisFactory implements FactoryInterface
50{
51    /**
52     * Create an object
53     *
54     * @param ContainerInterface $container     Service manager
55     * @param string             $requestedName Service being created
56     * @param null|array         $options       Extra options (optional)
57     *
58     * @return object
59     *
60     * @throws ServiceNotFoundException if unable to resolve the service.
61     * @throws ServiceNotCreatedException if an exception is raised when
62     * creating a service.
63     * @throws ContainerException&\Throwable if any other error occurs
64     */
65    public function __invoke(
66        ContainerInterface $container,
67        $requestedName,
68        array $options = null
69    ) {
70        if (!empty($options)) {
71            throw new \Exception('Unexpected options passed to factory.');
72        }
73
74        $config = $container->get(\VuFind\Config\PluginManager::class)
75            ->get('config')->Session ?? null;
76        return new $requestedName($this->getConnection($config), $config);
77    }
78
79    /**
80     * Given a configuration, build the client object.
81     *
82     * @param \Laminas\Config\Config $config Session configuration
83     *
84     * @return \Credis_Client
85     */
86    protected function getConnection(\Laminas\Config\Config $config)
87    {
88        // Set defaults if nothing set in config file.
89        $host = $config->redis_host ?? 'localhost';
90        $port = $config->redis_port ?? 6379;
91        $timeout = $config->redis_connection_timeout ?? 0.5;
92        $password = $config->redis_auth ?? null;
93        $username = $config->redis_user ?? null;
94        $redisDb = $config->redis_db ?? 0;
95
96        // Create Credis client, the connection is established lazily
97        $client = new \Credis_Client(
98            $host,
99            $port,
100            $timeout,
101            '',
102            $redisDb,
103            $password,
104            $username
105        );
106        if ((bool)($config->redis_standalone ?? true)) {
107            $client->forceStandalone();
108        }
109        return $client;
110    }
111}