Storage::isShared()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 3
Code Lines 1

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
cc 1
eloc 1
c 1
b 0
f 0
nc 1
nop 0
dl 0
loc 3
rs 10
1
<?php
2
3
/**
4
 * Platine Container
5
 *
6
 * Platine Container is the implementation of PSR 11
7
 *
8
 * This content is released under the MIT License (MIT)
9
 *
10
 * Copyright (c) 2020 Platine Container
11
 * Copyright (c) 2019 Dion Chaika
12
 *
13
 * Permission is hereby granted, free of charge, to any person obtaining a copy
14
 * of this software and associated documentation files (the "Software"), to deal
15
 * in the Software without restriction, including without limitation the rights
16
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
17
 * copies of the Software, and to permit persons to whom the Software is
18
 * furnished to do so, subject to the following conditions:
19
 *
20
 * The above copyright notice and this permission notice shall be included in all
21
 * copies or substantial portions of the Software.
22
 *
23
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
24
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
25
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
26
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
27
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
28
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
29
 * SOFTWARE.
30
 */
31
32
/**
33
 *  @file Storage.php
34
 *
35
 *  This class is the storage used by the container
36
 *
37
 *  @package    Platine\Container
38
 *  @author Platine Developers Team
39
 *  @copyright  Copyright (c) 2020
40
 *  @license    http://opensource.org/licenses/MIT  MIT License
41
 *  @link   https://www.platine-php.com
42
 *  @version 1.0.0
43
 *  @filesource
44
 */
45
46
declare(strict_types=1);
47
48
namespace Platine\Container;
49
50
use Closure;
51
use Platine\Container\ContainerInterface;
52
use Platine\Container\Parameter;
53
use Platine\Container\ParameterCollection;
54
use Platine\Container\StorageInterface;
55
56
/**
57
 * @class Storage
58
 * @package Platine\Container
59
 */
60
class Storage implements StorageInterface
61
{
62
    /**
63
     * The storage name
64
     * @var string
65
     */
66
    protected string $name;
67
68
    /**
69
     * The storage closure
70
     * @var Closure
71
     */
72
    protected Closure $closure;
73
74
    /**
75
     * Whether the instance is shared
76
     * @var bool
77
     */
78
    protected bool $shared;
79
80
    /**
81
     * The container parameter collection instance
82
     * @var ParameterCollection
83
     */
84
    protected ParameterCollection $parameters;
85
86
    /**
87
     * Create new parameter
88
     *
89
     * @param string $name  the name of the storage
90
     * @param Closure $closure
91
     * @param bool $shared
92
     * @param ParameterCollection $parameters
93
     */
94
    public function __construct(
95
        string $name,
96
        Closure $closure,
97
        bool $shared = false,
98
        ?ParameterCollection $parameters = null
99
    ) {
100
        $this->name = $name;
101
        $this->closure = $closure;
102
        $this->shared = $shared;
103
        $this->parameters = $parameters ?? new ParameterCollection();
104
    }
105
106
    /**
107
     * {@inheritdoc}
108
     */
109
    public function getName(): string
110
    {
111
        return $this->name;
112
    }
113
114
    /**
115
     * {@inheritdoc}
116
     */
117
    public function isShared(): bool
118
    {
119
        return $this->shared;
120
    }
121
122
    /**
123
     * {@inheritdoc}
124
     */
125
    public function getInstance(ContainerInterface $container): mixed
126
    {
127
        return ($this->closure)($container, $this->parameters);
128
    }
129
130
    /**
131
     * Set the managed instance as shared
132
     *
133
     * @return self
134
     */
135
    public function share(): self
136
    {
137
        $this->shared = true;
138
        return $this;
139
    }
140
141
    /**
142
     * Return the container parameter collection instance
143
     * @return ParameterCollection
144
     */
145
    public function getParameters(): ParameterCollection
146
    {
147
        return $this->parameters;
148
    }
149
150
    /**
151
     * Bind the parameter to use for the managed instance
152
     *
153
     * @param string $name  the name of parameter
154
     * @param mixed $value the parameter value
155
     *
156
     * @return $this
157
     */
158
    public function bindParameter(string $name, mixed $value): self
159
    {
160
        $this->parameters->add(new Parameter($name, $value));
161
        return $this;
162
    }
163
}
164