|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
namespace Thruster\Bundle\ViewBundle\View; |
|
4
|
|
|
|
|
5
|
|
|
use Symfony\Component\HttpKernel\Bundle\BundleInterface; |
|
6
|
|
|
use Symfony\Component\HttpKernel\KernelInterface; |
|
7
|
|
|
|
|
8
|
|
|
/** |
|
9
|
|
|
* ViewNameParser converts controller from the short notation a:b:c |
|
10
|
|
|
* (BlogBundle:Post:index) to a fully-qualified class::method string |
|
11
|
|
|
* (Bundle\BlogBundle\View\PostView::singleItem). |
|
12
|
|
|
* |
|
13
|
|
|
* @package Thruster\Bundle\ViewsBundle\View |
|
14
|
|
|
* @author Aurimas Niekis <[email protected]> |
|
15
|
|
|
*/ |
|
16
|
|
|
class ViewNameParser |
|
17
|
|
|
{ |
|
18
|
|
|
/** |
|
19
|
|
|
* @var KernelInterface |
|
20
|
|
|
*/ |
|
21
|
|
|
protected $kernel; |
|
22
|
|
|
|
|
23
|
|
|
/** |
|
24
|
|
|
* Constructor. |
|
25
|
|
|
* |
|
26
|
|
|
* @param KernelInterface $kernel A KernelInterface instance |
|
27
|
|
|
*/ |
|
28
|
|
|
public function __construct(KernelInterface $kernel) |
|
29
|
|
|
{ |
|
30
|
|
|
$this->kernel = $kernel; |
|
31
|
|
|
} |
|
32
|
|
|
|
|
33
|
|
|
/** |
|
34
|
|
|
* Converts a short notation a:b:c to a class::method. |
|
35
|
|
|
* |
|
36
|
|
|
* @param string $view A short notation view (a:b:c) |
|
37
|
|
|
* |
|
38
|
|
|
* @return string A string in the class::method notation |
|
39
|
|
|
* |
|
40
|
|
|
* @throws \InvalidArgumentException when the specified bundle is not enabled |
|
41
|
|
|
* or the controller cannot be found |
|
42
|
|
|
*/ |
|
43
|
|
|
public function parse($view) |
|
44
|
|
|
{ |
|
45
|
|
|
$originalView = $view; |
|
46
|
|
|
|
|
47
|
|
|
if (3 !== count($parts = explode(':', $view))) { |
|
48
|
|
|
throw new \InvalidArgumentException( |
|
49
|
|
|
sprintf( |
|
50
|
|
|
'The "%s" view is not a valid "a:b:c" view string.', |
|
51
|
|
|
$view |
|
52
|
|
|
) |
|
53
|
|
|
); |
|
54
|
|
|
} |
|
55
|
|
|
|
|
56
|
|
|
list($bundle, $view, $method) = $parts; |
|
57
|
|
|
$view = str_replace('/', '\\', $view); |
|
58
|
|
|
$bundles = []; |
|
59
|
|
|
|
|
60
|
|
|
try { |
|
61
|
|
|
// this throws an exception if there is no such bundle |
|
62
|
|
|
$allBundles = $this->kernel->getBundle($bundle, false); |
|
|
|
|
|
|
63
|
|
|
} catch (\InvalidArgumentException $e) { |
|
64
|
|
|
$message = sprintf( |
|
65
|
|
|
'The "%s" (from the view name "%s") does not exist or is not enabled in your kernel!', |
|
66
|
|
|
$bundle, |
|
67
|
|
|
$originalView |
|
68
|
|
|
); |
|
69
|
|
|
|
|
70
|
|
|
if ($alternative = $this->findAlternative($bundle)) { |
|
71
|
|
|
$message .= sprintf(' Did you mean "%s:%s:%s"?', $alternative, $view, $method); |
|
72
|
|
|
} |
|
73
|
|
|
|
|
74
|
|
|
throw new \InvalidArgumentException($message, 0, $e); |
|
75
|
|
|
} |
|
76
|
|
|
|
|
77
|
|
|
foreach ($allBundles as $b) { |
|
|
|
|
|
|
78
|
|
|
$try = $b->getNamespace() . '\\View\\' . $view . 'View'; |
|
79
|
|
|
if (class_exists($try)) { |
|
80
|
|
|
return $try . '::' . $method; |
|
81
|
|
|
} |
|
82
|
|
|
|
|
83
|
|
|
$bundles[] = $b->getName(); |
|
84
|
|
|
$msg = sprintf( |
|
85
|
|
|
'The view value "%s:%s:%s" maps to a "%s" class, but this class was not found. Create this class or ' . |
|
86
|
|
|
'check the spelling of the class and its namespace.', |
|
87
|
|
|
$bundle, |
|
88
|
|
|
$view, |
|
89
|
|
|
$method, |
|
90
|
|
|
$try |
|
91
|
|
|
); |
|
92
|
|
|
} |
|
93
|
|
|
|
|
94
|
|
|
if (count($bundles) > 1) { |
|
95
|
|
|
$msg = sprintf( |
|
96
|
|
|
'Unable to find view "%s:%s" in bundles %s.', |
|
97
|
|
|
$bundle, |
|
98
|
|
|
$view, |
|
99
|
|
|
implode(', ', $bundles) |
|
100
|
|
|
); |
|
101
|
|
|
} |
|
102
|
|
|
|
|
103
|
|
|
throw new \InvalidArgumentException($msg); |
|
104
|
|
|
} |
|
105
|
|
|
|
|
106
|
|
|
/** |
|
107
|
|
|
* Converts a class::method notation to a short one (a:b:c). |
|
108
|
|
|
* |
|
109
|
|
|
* @param string $view A string in the class::method notation |
|
110
|
|
|
* |
|
111
|
|
|
* @return string A short notation view (a:b:c) |
|
112
|
|
|
* |
|
113
|
|
|
* @throws \InvalidArgumentException when the view is not valid or cannot be found in any bundle |
|
114
|
|
|
*/ |
|
115
|
|
|
public function build($view) |
|
116
|
|
|
{ |
|
117
|
|
|
if (0 === preg_match('#^(.*?\\\\View\\\\(.+)View)::(.+)$#', $view, $match)) { |
|
118
|
|
|
throw new \InvalidArgumentException( |
|
119
|
|
|
sprintf('The "%s" view is not a valid "class::method" string.', $view) |
|
120
|
|
|
); |
|
121
|
|
|
} |
|
122
|
|
|
|
|
123
|
|
|
$className = $match[1]; |
|
124
|
|
|
$viewName = $match[2]; |
|
125
|
|
|
$methodName = $match[3]; |
|
126
|
|
|
foreach ($this->kernel->getBundles() as $name => $bundle) { |
|
127
|
|
|
if (0 !== strpos($className, $bundle->getNamespace())) { |
|
128
|
|
|
continue; |
|
129
|
|
|
} |
|
130
|
|
|
|
|
131
|
|
|
return sprintf('%s:%s:%s', $name, $viewName, $methodName); |
|
132
|
|
|
} |
|
133
|
|
|
|
|
134
|
|
|
throw new \InvalidArgumentException( |
|
135
|
|
|
sprintf('Unable to find a bundle that defines view "%s".', $view) |
|
136
|
|
|
); |
|
137
|
|
|
} |
|
138
|
|
|
|
|
139
|
|
|
/** |
|
140
|
|
|
* Attempts to find a bundle that is *similar* to the given bundle name. |
|
141
|
|
|
* |
|
142
|
|
|
* @param string $nonExistentBundleName |
|
143
|
|
|
* |
|
144
|
|
|
* @return string |
|
145
|
|
|
*/ |
|
146
|
|
|
private function findAlternative($nonExistentBundleName) |
|
147
|
|
|
{ |
|
148
|
|
|
$bundleNames = array_map(function (BundleInterface $b) { |
|
149
|
|
|
return $b->getName(); |
|
150
|
|
|
}, $this->kernel->getBundles()); |
|
151
|
|
|
|
|
152
|
|
|
$alternative = null; |
|
153
|
|
|
$shortest = null; |
|
154
|
|
|
foreach ($bundleNames as $bundleName) { |
|
155
|
|
|
// if there's a partial match, return it immediately |
|
156
|
|
|
if (false !== strpos($bundleName, $nonExistentBundleName)) { |
|
157
|
|
|
return $bundleName; |
|
158
|
|
|
} |
|
159
|
|
|
|
|
160
|
|
|
$lev = levenshtein($nonExistentBundleName, $bundleName); |
|
161
|
|
|
if ($lev <= strlen($nonExistentBundleName) / 3 && ($alternative === null || $lev < $shortest)) { |
|
162
|
|
|
$alternative = $bundleName; |
|
163
|
|
|
$shortest = $lev; |
|
164
|
|
|
} |
|
165
|
|
|
} |
|
166
|
|
|
|
|
167
|
|
|
return $alternative; |
|
168
|
|
|
} |
|
169
|
|
|
} |
|
170
|
|
|
|
ThrusterIO /
view-bundle
Loading history...
This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.
If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.
In this case you can add the
@ignorePhpDoc annotation to the duplicate definition and it will be ignored.