schmittjoh /
metadata
| Conditions | 1 |
| Paths | 1 |
| Total Lines | 6 |
| Code Lines | 4 |
| Lines | 0 |
| Ratio | 0 % |
| Changes | 3 | ||
| Bugs | 0 | Features | 1 |
| Metric | Value |
|---|---|
| c | 3 |
| b | 0 |
| f | 1 |
| dl | 0 |
| loc | 6 |
| rs | 9.4285 |
| cc | 1 |
| eloc | 4 |
| nc | 1 |
| nop | 3 |
| 1 | <?php |
||
| 2 | |||
| 3 | /* |
||
|
0 ignored issues
–
show
introduced
by
Loading history...
|
|||
| 4 | * Copyright 2011 Johannes M. Schmitt <[email protected]> |
||
| 5 | * |
||
| 6 | * Licensed under the Apache License, Version 2.0 (the "License"); |
||
| 7 | * you may not use this file except in compliance with the License. |
||
| 8 | * You may obtain a copy of the License at |
||
| 9 | * |
||
| 10 | * http://www.apache.org/licenses/LICENSE-2.0 |
||
| 11 | * |
||
| 12 | * Unless required by applicable law or agreed to in writing, software |
||
| 13 | * distributed under the License is distributed on an "AS IS" BASIS, |
||
| 14 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
||
| 15 | * See the License for the specific language governing permissions and |
||
| 16 | * limitations under the License. |
||
| 17 | */ |
||
| 18 | |||
| 19 | namespace Metadata; |
||
| 20 | |||
| 21 | use Metadata\Driver\AdvancedDriverInterface; |
||
| 22 | use Metadata\Driver\DriverInterface; |
||
| 23 | use Metadata\Cache\CacheInterface; |
||
| 24 | |||
| 25 | class MetadataFactory implements AdvancedMetadataFactoryInterface |
||
|
0 ignored issues
–
show
|
|||
| 26 | { |
||
| 27 | private $driver; |
||
|
0 ignored issues
–
show
|
|||
| 28 | private $cache; |
||
|
0 ignored issues
–
show
|
|||
| 29 | private $loadedMetadata = array(); |
||
|
0 ignored issues
–
show
|
|||
| 30 | private $loadedClassMetadata = array(); |
||
|
0 ignored issues
–
show
|
|||
| 31 | private $hierarchyMetadataClass; |
||
|
0 ignored issues
–
show
|
|||
| 32 | private $includeInterfaces = false; |
||
|
0 ignored issues
–
show
|
|||
| 33 | private $debug; |
||
|
0 ignored issues
–
show
|
|||
| 34 | |||
| 35 | /** |
||
|
0 ignored issues
–
show
|
|||
| 36 | * @param DriverInterface $driver |
||
|
0 ignored issues
–
show
|
|||
| 37 | * @param string $hierarchyMetadataClass |
||
|
0 ignored issues
–
show
|
|||
| 38 | * @param boolean $debug |
||
|
0 ignored issues
–
show
|
|||
| 39 | */ |
||
|
0 ignored issues
–
show
|
|||
| 40 | public function __construct(DriverInterface $driver, $hierarchyMetadataClass = 'Metadata\ClassHierarchyMetadata', $debug = false) |
||
|
0 ignored issues
–
show
|
|||
| 41 | { |
||
|
0 ignored issues
–
show
|
|||
| 42 | $this->driver = $driver; |
||
|
0 ignored issues
–
show
|
|||
| 43 | $this->hierarchyMetadataClass = $hierarchyMetadataClass; |
||
|
0 ignored issues
–
show
|
|||
| 44 | $this->debug = (Boolean) $debug; |
||
|
0 ignored issues
–
show
|
|||
| 45 | } |
||
|
0 ignored issues
–
show
|
|||
| 46 | |||
| 47 | /** |
||
|
0 ignored issues
–
show
|
|||
| 48 | * @param boolean $include |
||
|
0 ignored issues
–
show
|
|||
| 49 | */ |
||
|
0 ignored issues
–
show
|
|||
| 50 | public function setIncludeInterfaces($include) |
||
|
0 ignored issues
–
show
|
|||
| 51 | { |
||
|
0 ignored issues
–
show
|
|||
| 52 | $this->includeInterfaces = (Boolean) $include; |
||
|
0 ignored issues
–
show
|
|||
| 53 | } |
||
|
0 ignored issues
–
show
|
|||
| 54 | |||
| 55 | public function setCache(CacheInterface $cache) |
||
|
0 ignored issues
–
show
|
|||
| 56 | { |
||
|
0 ignored issues
–
show
|
|||
| 57 | $this->cache = $cache; |
||
|
0 ignored issues
–
show
|
|||
| 58 | } |
||
|
0 ignored issues
–
show
|
|||
| 59 | |||
| 60 | /** |
||
|
0 ignored issues
–
show
|
|||
| 61 | * @param string $className |
||
|
0 ignored issues
–
show
|
|||
| 62 | * |
||
|
0 ignored issues
–
show
|
|||
| 63 | * @return ClassHierarchyMetadata|MergeableClassMetadata|null |
||
|
0 ignored issues
–
show
|
|||
| 64 | */ |
||
|
0 ignored issues
–
show
|
|||
| 65 | public function getMetadataForClass($className) |
||
|
0 ignored issues
–
show
|
|||
| 66 | { |
||
|
0 ignored issues
–
show
|
|||
| 67 | if (isset($this->loadedMetadata[$className])) { |
||
|
0 ignored issues
–
show
|
|||
| 68 | return $this->filterNullMetadata($this->loadedMetadata[$className]); |
||
|
0 ignored issues
–
show
|
|||
| 69 | } |
||
|
0 ignored issues
–
show
|
|||
| 70 | |||
| 71 | $metadata = null; |
||
|
0 ignored issues
–
show
|
|||
| 72 | foreach ($this->getClassHierarchy($className) as $class) { |
||
|
0 ignored issues
–
show
|
|||
| 73 | if (isset($this->loadedClassMetadata[$name = $class->getName()])) { |
||
|
0 ignored issues
–
show
|
|||
| 74 | if (null !== $classMetadata = $this->filterNullMetadata($this->loadedClassMetadata[$name])) { |
||
|
0 ignored issues
–
show
|
|||
| 75 | $this->addClassMetadata($metadata, $classMetadata); |
||
|
0 ignored issues
–
show
|
|||
| 76 | } |
||
|
0 ignored issues
–
show
|
|||
| 77 | continue; |
||
|
0 ignored issues
–
show
|
|||
| 78 | } |
||
|
0 ignored issues
–
show
|
|||
| 79 | |||
| 80 | // check the cache |
||
|
0 ignored issues
–
show
|
|||
| 81 | if (null !== $this->cache) { |
||
|
0 ignored issues
–
show
|
|||
| 82 | if (($classMetadata = $this->cache->loadClassMetadataFromCache($class)) instanceof NullMetadata) { |
||
|
0 ignored issues
–
show
|
|||
| 83 | $this->loadedClassMetadata[$name] = $classMetadata; |
||
|
0 ignored issues
–
show
|
|||
| 84 | continue; |
||
|
0 ignored issues
–
show
|
|||
| 85 | } |
||
|
0 ignored issues
–
show
|
|||
| 86 | |||
| 87 | if (null !== $classMetadata) { |
||
|
0 ignored issues
–
show
|
|||
| 88 | if ( ! $classMetadata instanceof ClassMetadata) { |
||
|
0 ignored issues
–
show
|
|||
| 89 | throw new \LogicException(sprintf('The cache must return instances of ClassMetadata, but got %s.', var_export($classMetadata, true))); |
||
|
0 ignored issues
–
show
|
|||
| 90 | } |
||
|
0 ignored issues
–
show
|
|||
| 91 | |||
| 92 | if ($this->debug && !$classMetadata->isFresh()) { |
||
|
0 ignored issues
–
show
|
|||
| 93 | $this->cache->evictClassMetadataFromCache($classMetadata->reflection); |
||
|
0 ignored issues
–
show
|
|||
| 94 | } else { |
||
|
0 ignored issues
–
show
|
|||
| 95 | $this->loadedClassMetadata[$name] = $classMetadata; |
||
|
0 ignored issues
–
show
|
|||
| 96 | $this->addClassMetadata($metadata, $classMetadata); |
||
|
0 ignored issues
–
show
|
|||
| 97 | continue; |
||
|
0 ignored issues
–
show
|
|||
| 98 | } |
||
|
0 ignored issues
–
show
|
|||
| 99 | } |
||
|
0 ignored issues
–
show
|
|||
| 100 | } |
||
|
0 ignored issues
–
show
|
|||
| 101 | |||
| 102 | // load from source |
||
|
0 ignored issues
–
show
|
|||
| 103 | if (null !== $classMetadata = $this->driver->loadMetadataForClass($class)) { |
||
|
0 ignored issues
–
show
|
|||
| 104 | $this->loadedClassMetadata[$name] = $classMetadata; |
||
|
0 ignored issues
–
show
|
|||
| 105 | $this->addClassMetadata($metadata, $classMetadata); |
||
|
0 ignored issues
–
show
|
|||
| 106 | |||
| 107 | if (null !== $this->cache) { |
||
|
0 ignored issues
–
show
|
|||
| 108 | $this->cache->putClassMetadataInCache($classMetadata); |
||
|
0 ignored issues
–
show
|
|||
| 109 | } |
||
|
0 ignored issues
–
show
|
|||
| 110 | |||
| 111 | continue; |
||
|
0 ignored issues
–
show
|
|||
| 112 | } |
||
|
0 ignored issues
–
show
|
|||
| 113 | |||
| 114 | if (null !== $this->cache && !$this->debug) { |
||
|
0 ignored issues
–
show
|
|||
| 115 | $this->cache->putClassMetadataInCache(new NullMetadata($class->getName())); |
||
|
0 ignored issues
–
show
|
|||
| 116 | } |
||
|
0 ignored issues
–
show
|
|||
| 117 | } |
||
|
0 ignored issues
–
show
|
|||
| 118 | |||
| 119 | if (null === $metadata) { |
||
|
0 ignored issues
–
show
|
|||
| 120 | $metadata = new NullMetadata($className); |
||
|
0 ignored issues
–
show
|
|||
| 121 | } |
||
|
0 ignored issues
–
show
|
|||
| 122 | |||
| 123 | return $this->filterNullMetadata($this->loadedMetadata[$className] = $metadata); |
||
|
0 ignored issues
–
show
$this->loadedMetadata[$className] = $metadata is of type object<Metadata\ClassMetadata>, but the function expects a object<Metadata\NullMetadata>|null.
It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { }
$x = '123'; // string "123"
// Instead of
acceptsInteger($x);
// we recommend to use
acceptsInteger((integer) $x);
Loading history...
|
|||
| 124 | } |
||
|
0 ignored issues
–
show
|
|||
| 125 | |||
| 126 | /** |
||
|
0 ignored issues
–
show
|
|||
| 127 | * {@inheritDoc} |
||
|
0 ignored issues
–
show
|
|||
| 128 | */ |
||
|
0 ignored issues
–
show
|
|||
| 129 | public function getAllClassNames() |
||
|
0 ignored issues
–
show
|
|||
| 130 | { |
||
|
0 ignored issues
–
show
|
|||
| 131 | if (!$this->driver instanceof AdvancedDriverInterface) { |
||
|
0 ignored issues
–
show
|
|||
| 132 | throw new \RuntimeException( |
||
|
0 ignored issues
–
show
|
|||
| 133 | sprintf('Driver "%s" must be an instance of "AdvancedDriverInterface".', get_class($this->driver)) |
||
|
0 ignored issues
–
show
|
|||
| 134 | ); |
||
|
0 ignored issues
–
show
|
|||
| 135 | } |
||
|
0 ignored issues
–
show
|
|||
| 136 | |||
| 137 | return $this->driver->getAllClassNames(); |
||
|
0 ignored issues
–
show
|
|||
| 138 | } |
||
|
0 ignored issues
–
show
|
|||
| 139 | |||
| 140 | /** |
||
|
0 ignored issues
–
show
|
|||
| 141 | * @param ClassMetadata|null $metadata |
||
|
0 ignored issues
–
show
|
|||
| 142 | * @param ClassMetadata $toAdd |
||
|
0 ignored issues
–
show
|
|||
| 143 | */ |
||
|
0 ignored issues
–
show
|
|||
| 144 | private function addClassMetadata(&$metadata, $toAdd) |
||
|
0 ignored issues
–
show
|
|||
| 145 | { |
||
|
0 ignored issues
–
show
|
|||
| 146 | if ($toAdd instanceof MergeableInterface) { |
||
|
0 ignored issues
–
show
|
|||
| 147 | if (null === $metadata) { |
||
|
0 ignored issues
–
show
|
|||
| 148 | $metadata = clone $toAdd; |
||
|
0 ignored issues
–
show
|
|||
| 149 | } else { |
||
|
0 ignored issues
–
show
|
|||
| 150 | $metadata->merge($toAdd); |
||
|
0 ignored issues
–
show
It seems like you code against a specific sub-type and not the parent class
Metadata\ClassMetadata as the method merge() does only exist in the following sub-classes of Metadata\ClassMetadata: Metadata\MergeableClassMetadata. Maybe you want to instanceof check for one of these explicitly?
Let’s take a look at an example: abstract class User
{
/** @return string */
abstract public function getPassword();
}
class MyUser extends User
{
public function getPassword()
{
// return something
}
public function getDisplayName()
{
// return some name.
}
}
class AuthSystem
{
public function authenticate(User $user)
{
$this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
// do something.
}
}
In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes
Note: PHP Analyzer uses reverse abstract interpretation to narrow down the types
inside the if block in such a case.
Loading history...
|
|||
| 151 | } |
||
|
0 ignored issues
–
show
|
|||
| 152 | } else { |
||
|
0 ignored issues
–
show
|
|||
| 153 | if (null === $metadata) { |
||
|
0 ignored issues
–
show
|
|||
| 154 | $metadata = new $this->hierarchyMetadataClass; |
||
|
0 ignored issues
–
show
|
|||
| 155 | } |
||
|
0 ignored issues
–
show
|
|||
| 156 | |||
| 157 | $metadata->addClassMetadata($toAdd); |
||
|
0 ignored issues
–
show
|
|||
| 158 | } |
||
|
0 ignored issues
–
show
|
|||
| 159 | } |
||
|
0 ignored issues
–
show
|
|||
| 160 | |||
| 161 | /** |
||
|
0 ignored issues
–
show
|
|||
| 162 | * @param string $class |
||
|
0 ignored issues
–
show
|
|||
| 163 | */ |
||
|
0 ignored issues
–
show
|
|||
| 164 | private function getClassHierarchy($class) |
||
|
0 ignored issues
–
show
|
|||
| 165 | { |
||
|
0 ignored issues
–
show
|
|||
| 166 | $classes = array(); |
||
|
0 ignored issues
–
show
|
|||
| 167 | $refl = new \ReflectionClass($class); |
||
|
0 ignored issues
–
show
|
|||
| 168 | |||
| 169 | do { |
||
|
0 ignored issues
–
show
|
|||
| 170 | $classes[] = $refl; |
||
|
0 ignored issues
–
show
|
|||
| 171 | $refl = $refl->getParentClass(); |
||
|
0 ignored issues
–
show
|
|||
| 172 | } while (false !== $refl); |
||
|
0 ignored issues
–
show
|
|||
| 173 | |||
| 174 | $classes = array_reverse($classes, false); |
||
|
0 ignored issues
–
show
|
|||
| 175 | |||
| 176 | if (!$this->includeInterfaces) { |
||
|
0 ignored issues
–
show
|
|||
| 177 | return $classes; |
||
|
0 ignored issues
–
show
|
|||
| 178 | } |
||
|
0 ignored issues
–
show
|
|||
| 179 | |||
| 180 | $addedInterfaces = array(); |
||
|
0 ignored issues
–
show
|
|||
| 181 | $newHierarchy = array(); |
||
|
0 ignored issues
–
show
|
|||
| 182 | |||
| 183 | foreach ($classes as $class) { |
||
|
0 ignored issues
–
show
|
|||
| 184 | foreach ($class->getInterfaces() as $interface) { |
||
|
0 ignored issues
–
show
|
|||
| 185 | if (isset($addedInterfaces[$interface->getName()])) { |
||
|
0 ignored issues
–
show
|
|||
| 186 | continue; |
||
|
0 ignored issues
–
show
|
|||
| 187 | } |
||
|
0 ignored issues
–
show
|
|||
| 188 | $addedInterfaces[$interface->getName()] = true; |
||
|
0 ignored issues
–
show
|
|||
| 189 | |||
| 190 | $newHierarchy[] = $interface; |
||
|
0 ignored issues
–
show
|
|||
| 191 | } |
||
|
0 ignored issues
–
show
|
|||
| 192 | |||
| 193 | $newHierarchy[] = $class; |
||
|
0 ignored issues
–
show
|
|||
| 194 | } |
||
|
0 ignored issues
–
show
|
|||
| 195 | |||
| 196 | return $newHierarchy; |
||
|
0 ignored issues
–
show
|
|||
| 197 | } |
||
|
0 ignored issues
–
show
|
|||
| 198 | |||
| 199 | /** |
||
|
0 ignored issues
–
show
|
|||
| 200 | * @param NullMetadata|null $metadata |
||
|
0 ignored issues
–
show
|
|||
| 201 | * |
||
|
0 ignored issues
–
show
|
|||
| 202 | * @return ClassMetadata|null |
||
|
0 ignored issues
–
show
|
|||
| 203 | */ |
||
|
0 ignored issues
–
show
|
|||
| 204 | private function filterNullMetadata($metadata = null) |
||
|
0 ignored issues
–
show
|
|||
| 205 | { |
||
|
0 ignored issues
–
show
|
|||
| 206 | return !$metadata instanceof NullMetadata ? $metadata : null; |
||
|
0 ignored issues
–
show
|
|||
| 207 | } |
||
|
0 ignored issues
–
show
|
|||
| 208 | } |
||
| 209 |