zend-cache/src/PatternFactory.php at c29ee81cc31983cee383e3d2e3678a42697ce4e1 · zendframework/zend-cache · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
<?php
/**
 * Zend Framework (http://framework.zend.com/)
 *
 * @link      http://github.com/zendframework/zf2 for the canonical source repository
 * @copyright Copyright (c) 2005-2016 Zend Technologies USA Inc. (http://www.zend.com)
 * @license   http://framework.zend.com/license/new-bsd New BSD License
 */

namespace Zend\Cache;

use Traversable;
use Zend\Stdlib\ArrayUtils;
use Zend\ServiceManager\ServiceManager;

/**
 * @deprecated static factories are deprecated as of zendframework 2.9 and may be removed in future major versions.
 */
abstract class PatternFactory
{

    /**
     * The pattern manager
     *
     * @var null|PatternPluginManager
     */
    protected static $plugins = null;

    /**
     * Instantiate a cache pattern
     *
     * @param  string|Pattern\PatternInterface          $patternName
     * @param  array|Traversable|Pattern\PatternOptions $options
     *
     * @return Pattern\PatternInterface
     * @throws Exception\InvalidArgumentException
     * @deprecated static factories are deprecated as of zendframework 2.9 and may be removed in future major versions.
     */
    public static function factory($patternName, $options = [])
    {
        trigger_error(sprintf(
            '%s is deprecated; please use %s::get instead',
            __METHOD__,
            PatternPluginManager::class
        ), E_USER_DEPRECATED);

        if ($options instanceof Pattern\PatternOptions) {
            $options = $options->toArray();
        }

        if ($options instanceof Traversable) {
            $options = ArrayUtils::iteratorToArray($options);
        }

        if (! is_array($options)) {
            throw new Exception\InvalidArgumentException(sprintf(
                '%s expects an array, Traversable object, or %s\Pattern\PatternOptions object; received "%s"',
                __METHOD__,
                __NAMESPACE__,
                (is_object($options) ? get_class($options) : gettype($options))
            ));
        }

        if ($patternName instanceof Pattern\PatternInterface) {
            $patternName->setOptions(new Pattern\PatternOptions($options));

            return $patternName;
        }

        return static::getPluginManager()->get($patternName, $options);
    }

    /**
     * Get the pattern plugin manager
     *
     * @return PatternPluginManager
     * @deprecated static factories are deprecated as of zendframework 2.9 and may be removed in future major versions.
     */
    public static function getPluginManager()
    {
        trigger_error(sprintf(
            '%s is deprecated',
            __METHOD__
        ), E_USER_DEPRECATED);

        if (static::$plugins === null) {
            static::$plugins = new PatternPluginManager(new ServiceManager);
        }

        return static::$plugins;
    }

    /**
     * Set the pattern plugin manager
     *
     * @param  PatternPluginManager $plugins
     *
     * @return void
     * @deprecated static factories are deprecated as of zendframework 2.9 and may be removed in future major versions.
     */
    public static function setPluginManager(PatternPluginManager $plugins)
    {
        trigger_error(sprintf(
            '%s is deprecated',
            __METHOD__
        ), E_USER_DEPRECATED);

        static::$plugins = $plugins;
    }

    /**
     * Reset pattern plugin manager to default
     *
     * @return void
     * @deprecated static factories are deprecated as of zendframework 2.9 and may be removed in future major versions.
     */
    public static function resetPluginManager()
    {
        trigger_error(sprintf(
            '%s is deprecated',
            __METHOD__
        ), E_USER_DEPRECATED);

        static::$plugins = null;
    }
}