Newer
Older
Alex Pott
committed
<?php
namespace Drupal\Component\ProxyBuilder;
/**
* Generates the string representation of the proxy service.
*/
class ProxyBuilder {
/**
* Generates the used proxy class name from a given class name.
*
* @param string $class_name
* The class name of the actual service.
*
* @return string
* The class name of the proxy.
*/
public static function buildProxyClassName($class_name) {
$match = [];
preg_match('/([a-zA-Z0-9_]+\\\\[a-zA-Z0-9_]+)\\\\(.+)/', $class_name, $match);
$root_namespace = $match[1];
$rest_fqcn = $match[2];
$proxy_class_name = $root_namespace . '\\ProxyClass\\' . $rest_fqcn;
return $proxy_class_name;
}
/**
* Generates the used proxy namespace from a given class name.
*
* @param string $class_name
* The class name of the actual service.
*
* @return string
* The namespace name of the proxy.
*/
public static function buildProxyNamespace($class_name) {
$proxy_classname = static::buildProxyClassName($class_name);
preg_match('/(.+)\\\\[a-zA-Z0-9]+/', $proxy_classname, $match);
$proxy_namespace = $match[1];
return $proxy_namespace;
Alex Pott
committed
}
/**
* Builds a proxy class string.
*
* @param string $class_name
* The class name of the actual service.
* @param string $proxy_class_name
* (optional) The class name of the proxy service.
Alex Pott
committed
*
* @return string
* The full string with namespace class and methods.
*/
public function build($class_name, $proxy_class_name = '') {
Alex Pott
committed
$reflection = new \ReflectionClass($class_name);
if ($proxy_class_name) {
$proxy_class_reflection = new \ReflectionClass($proxy_class_name);
$proxy_namespace = $proxy_class_reflection->getNamespaceName();
}
else {
$proxy_class_name = $this->buildProxyClassName($class_name);
$proxy_namespace = $this->buildProxyNamespace($class_name);
$proxy_class_shortname = str_replace($proxy_namespace . '\\', '', $proxy_class_name);
}
Alex Pott
committed
$output = '';
$class_documentation = <<<'EOS'
namespace {{ namespace }}{
/**
* Provides a proxy class for \{{ class_name }}.
*
* @see \Drupal\Component\ProxyBuilder
*/
Alex Pott
committed
EOS;
$class_start = ' class {{ proxy_class_shortname }}';
Alex Pott
committed
Alex Pott
committed
// For cases in which the implemented interface is a child of another
// interface, getInterfaceNames() also returns the parent. This causes a
// PHP error.
// In order to avoid that, check for each interface, whether one of its
// parents is also in the list and exclude it.
if ($interfaces = $reflection->getInterfaces()) {
foreach ($interfaces as $interface_name => $interface) {
// Exclude all parents from the list of implemented interfaces of the
// class.
if ($parent_interfaces = $interface->getInterfaceNames()) {
foreach ($parent_interfaces as $parent_interface) {
if (isset($interfaces[$parent_interface])) {}
unset($interfaces[$parent_interface]);
}
}
Alex Pott
committed
}
Alex Pott
committed
$interface_names = [];
foreach ($interfaces as $interface) {
$interface_names[] = '\\' . $interface->getName();
}
$class_start .= ' implements ' . implode(', ', $interface_names);
Alex Pott
committed
}
$output .= $this->buildUseStatements();
// The actual class;
$properties = <<<'EOS'
/**
* The id of the original proxied service.
*
Alex Pott
committed
* @var string
*/
protected $drupalProxyOriginalServiceId;
Alex Pott
committed
/**
* The real proxied service, after it was lazy loaded.
*
Alex Pott
committed
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
* @var \{{ class_name }}
*/
protected $service;
/**
* The service container.
*
* @var \Symfony\Component\DependencyInjection\ContainerInterface
*/
protected $container;
EOS;
$output .= $properties;
// Add all the methods.
$methods = [];
$methods[] = $this->buildConstructorMethod();
$methods[] = $this->buildLazyLoadItselfMethod();
// Add all the methods of the proxied service.
$reflection_methods = $reflection->getMethods();
foreach ($reflection_methods as $method) {
if ($method->getName() === '__construct') {
continue;
}
if ($method->isPublic()) {
$methods[] = $this->buildMethod($method) . "\n";
}
}
$output .= implode("\n", $methods);
// Indent the output.
Alex Pott
committed
$output = implode("\n", array_map(function ($value) {
Alex Pott
committed
if ($value === '') {
return $value;
}
return " $value";
Alex Pott
committed
}, explode("\n", $output)));
$final_output = $class_documentation . $class_start . "\n {\n\n" . $output . "\n }\n\n}\n";
Alex Pott
committed
$final_output = str_replace('{{ class_name }}', $class_name, $final_output);
$final_output = str_replace('{{ namespace }}', $proxy_namespace ? $proxy_namespace . ' ' : '', $final_output);
$final_output = str_replace('{{ proxy_class_shortname }}', $proxy_class_shortname, $final_output);
Alex Pott
committed
return $final_output;
}
/**
* Generates the string for the method which loads the actual service.
*
* @return string
*/
protected function buildLazyLoadItselfMethod() {
$output = <<<'EOS'
/**
* Lazy loads the real service from the container.
*
* @return object
* Returns the constructed real service.
*/
Alex Pott
committed
protected function lazyLoadItself()
{
if (!isset($this->service)) {
$this->service = $this->container->get($this->drupalProxyOriginalServiceId);
Alex Pott
committed
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
}
return $this->service;
}
EOS;
return $output;
}
/**
* Generates the string representation of a single method: signature, body.
*
* @param \ReflectionMethod $reflection_method
* A reflection method for the method.
*
* @return string
*/
protected function buildMethod(\ReflectionMethod $reflection_method) {
$parameters = [];
foreach ($reflection_method->getParameters() as $parameter) {
$parameters[] = $this->buildParameter($parameter);
}
$function_name = $reflection_method->getName();
$reference = '';
if ($reflection_method->returnsReference()) {
$reference = '&';
}
$signature_line = <<<'EOS'
/**
* {@inheritdoc}
*/
EOS;
Alex Pott
committed
if ($reflection_method->isStatic()) {
$signature_line .= 'public static function ' . $reference . $function_name . '(';
Alex Pott
committed
}
else {
$signature_line .= 'public function ' . $reference . $function_name . '(';
Alex Pott
committed
}
$signature_line .= implode(', ', $parameters);
$signature_line .= ')';
$output = $signature_line . "\n{\n";
$output .= $this->buildMethodBody($reflection_method);
Alex Pott
committed
$output .= "\n" . '}';
Alex Pott
committed
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
return $output;
}
/**
* Builds a string for a single parameter of a method.
*
* @param \ReflectionParameter $parameter
* A reflection object of the parameter.
*
* @return string
*/
protected function buildParameter(\ReflectionParameter $parameter) {
$parameter_string = '';
if ($parameter->isArray()) {
$parameter_string .= 'array ';
}
elseif ($parameter->isCallable()) {
$parameter_string .= 'callable ';
}
elseif ($class = $parameter->getClass()) {
$parameter_string .= '\\' . $class->getName() . ' ';
}
if ($parameter->isPassedByReference()) {
$parameter_string .= '&';
}
$parameter_string .= '$' . $parameter->getName();
if ($parameter->isDefaultValueAvailable()) {
$parameter_string .= ' = ';
$parameter_string .= var_export($parameter->getDefaultValue(), TRUE);
}
return $parameter_string;
}
/**
* Builds the body of a wrapped method.
*
* @param \ReflectionMethod $reflection_method
* A reflection method for the method.
*
* @return string
*/
protected function buildMethodBody(\ReflectionMethod $reflection_method) {
$output = '';
$function_name = $reflection_method->getName();
if (!$reflection_method->isStatic()) {
$output .= ' return $this->lazyLoadItself()->' . $function_name . '(';
}
else {
$class_name = $reflection_method->getDeclaringClass()->getName();
$output .= " \\$class_name::$function_name(";
}
// Add parameters;
$parameters = [];
foreach ($reflection_method->getParameters() as $parameter) {
$parameters[] = '$' . $parameter->getName();
}
$output .= implode(', ', $parameters) . ');';
return $output;
}
/**
* Builds the constructor used to inject the actual service ID.
*
* @return string
*/
protected function buildConstructorMethod() {
$output = <<<'EOS'
/**
* Constructs a ProxyClass Drupal proxy object.
*
* @param \Symfony\Component\DependencyInjection\ContainerInterface $container
* The container.
* @param string $drupal_proxy_original_service_id
* The service ID of the original service.
*/
public function __construct(\Symfony\Component\DependencyInjection\ContainerInterface $container, $drupal_proxy_original_service_id)
Alex Pott
committed
{
$this->container = $container;
$this->drupalProxyOriginalServiceId = $drupal_proxy_original_service_id;
Alex Pott
committed
}
EOS;
return $output;
}
/**
* Build the required use statements of the proxy class.
*
* @return string
*/
protected function buildUseStatements() {
$output = '';
return $output;
}
}