Namespaces

  • Nette
    • Application
      • Diagnostics
      • Responses
      • Routers
      • UI
    • Caching
      • Storages
    • ComponentModel
    • Config
      • Adapters
      • Extensions
    • Database
      • Diagnostics
      • Drivers
      • Reflection
      • Table
    • DI
      • Diagnostics
    • Diagnostics
    • Forms
      • Controls
      • Rendering
    • Http
    • Iterators
    • Latte
      • Macros
    • Loaders
    • Localization
    • Mail
    • Reflection
    • Security
      • Diagnostics
    • Templating
    • Utils
      • PhpGenerator
  • NetteModule
  • None
  • PHP

Classes

  • Compiler
  • CompilerExtension
  • Configurator
  • Helpers
  • Loader

Interfaces

  • IAdapter
  • Overview
  • Namespace
  • Class
  • Tree
  1: <?php
  2: 
  3: /**
  4:  * This file is part of the Nette Framework (http://nette.org)
  5:  *
  6:  * Copyright (c) 2004 David Grudl (http://davidgrudl.com)
  7:  *
  8:  * For the full copyright and license information, please view
  9:  * the file license.txt that was distributed with this source code.
 10:  */
 11: 
 12: namespace Nette\Config;
 13: 
 14: use Nette,
 15:     Nette\Utils\Validators;
 16: 
 17: 
 18: 
 19: /**
 20:  * DI container compiler.
 21:  *
 22:  * @author     David Grudl
 23:  *
 24:  * @property-read array $extensions
 25:  * @property-read Nette\DI\ContainerBuilder $containerBuilder
 26:  * @property-read array $config
 27:  */
 28: class Compiler extends Nette\Object
 29: {
 30:     /** @var array of CompilerExtension */
 31:     private $extensions = array();
 32: 
 33:     /** @var Nette\DI\ContainerBuilder */
 34:     private $container;
 35: 
 36:     /** @var array */
 37:     private $config;
 38: 
 39:     /** @var array reserved section names */
 40:     private static $reserved = array('services' => 1, 'factories' => 1, 'parameters' => 1);
 41: 
 42: 
 43: 
 44:     /**
 45:      * Add custom configurator extension.
 46:      * @return Compiler  provides a fluent interface
 47:      */
 48:     public function addExtension($name, CompilerExtension $extension)
 49:     {
 50:         if (isset(self::$reserved[$name])) {
 51:             throw new Nette\InvalidArgumentException("Name '$name' is reserved.");
 52:         }
 53:         $this->extensions[$name] = $extension->setCompiler($this, $name);
 54:         return $this;
 55:     }
 56: 
 57: 
 58: 
 59:     /**
 60:      * @return array
 61:      */
 62:     public function getExtensions()
 63:     {
 64:         return $this->extensions;
 65:     }
 66: 
 67: 
 68: 
 69:     /**
 70:      * @return Nette\DI\ContainerBuilder
 71:      */
 72:     public function getContainerBuilder()
 73:     {
 74:         return $this->container;
 75:     }
 76: 
 77: 
 78: 
 79:     /**
 80:      * Returns configuration without expanded parameters.
 81:      * @return array
 82:      */
 83:     public function getConfig()
 84:     {
 85:         return $this->config;
 86:     }
 87: 
 88: 
 89: 
 90:     /**
 91:      * @return string
 92:      */
 93:     public function compile(array $config, $className, $parentName)
 94:     {
 95:         $this->config = $config;
 96:         $this->container = new Nette\DI\ContainerBuilder;
 97:         $this->processParameters();
 98:         $this->processExtensions();
 99:         $this->processServices();
100:         return $this->generateCode($className, $parentName);
101:     }
102: 
103: 
104: 
105:     public function processParameters()
106:     {
107:         if (isset($this->config['parameters'])) {
108:             $this->container->parameters = $this->config['parameters'];
109:         }
110:     }
111: 
112: 
113: 
114:     public function processExtensions()
115:     {
116:         if ($extra = array_diff_key($this->config, self::$reserved, $this->extensions)) {
117:             $extra = implode("', '", array_keys($extra));
118:             throw new Nette\InvalidStateException("Found sections '$extra' in configuration, but corresponding extensions are missing.");
119:         }
120: 
121:         foreach ($this->extensions as $name => $extension) {
122:             $extension->loadConfiguration();
123:         }
124:     }
125: 
126: 
127: 
128:     public function processServices()
129:     {
130:         $this->parseServices($this->container, $this->config);
131: 
132:         foreach ($this->extensions as $name => $extension) {
133:             $this->container->addDefinition($name)
134:                 ->setClass('Nette\DI\NestedAccessor', array('@container', $name))
135:                 ->setAutowired(FALSE);
136: 
137:             if (isset($this->config[$name])) {
138:                 $this->parseServices($this->container, $this->config[$name], $name);
139:             }
140:         }
141: 
142:         foreach ($this->container->getDefinitions() as $name => $def) {
143:             $factory = $name . 'Factory';
144:             if (!$def->shared && !$def->internal && !$this->container->hasDefinition($factory)) {
145:                 $this->container->addDefinition($factory)
146:                     ->setClass('Nette\Callback', array('@container', Nette\DI\Container::getMethodName($name, FALSE)))
147:                     ->setAutowired(FALSE)
148:                     ->tags = $def->tags;
149:             }
150:         }
151:     }
152: 
153: 
154: 
155:     public function generateCode($className, $parentName)
156:     {
157:         foreach ($this->extensions as $extension) {
158:             $extension->beforeCompile();
159:         }
160: 
161:         $classes[] = $class = $this->container->generateClass($parentName);
162:         $class->setName($className)
163:             ->addMethod('initialize');
164: 
165:         foreach ($this->extensions as $extension) {
166:             $extension->afterCompile($class);
167:         }
168: 
169:         $defs = $this->container->getDefinitions();
170:         ksort($defs);
171:         $list = array_keys($defs);
172:         foreach (array_reverse($defs, TRUE) as $name => $def) {
173:             if ($def->class === 'Nette\DI\NestedAccessor' && ($found = preg_grep('#^'.$name.'\.#i', $list))) {
174:                 $list = array_diff($list, $found);
175:                 $def->class = $className . '_' . preg_replace('#\W+#', '_', $name);
176:                 $class->documents = preg_replace("#\S+(?= \\$$name$)#", $def->class, $class->documents);
177:                 $classes[] = $accessor = new Nette\Utils\PhpGenerator\ClassType($def->class);
178:                 foreach ($found as $item) {
179:                     $short = substr($item, strlen($name)  + 1);
180:                     $accessor->addDocument($defs[$item]->shared
181:                         ? "@property {$defs[$item]->class} \$$short"
182:                         : "@method {$defs[$item]->class} create" . ucfirst("$short()"));
183:                 }
184:             }
185:         }
186: 
187:         return implode("\n\n\n", $classes);
188:     }
189: 
190: 
191: 
192:     /********************* tools ****************d*g**/
193: 
194: 
195: 
196:     /**
197:      * Parses section 'services' from configuration file.
198:      * @return void
199:      */
200:     public static function parseServices(Nette\DI\ContainerBuilder $container, array $config, $namespace = NULL)
201:     {
202:         $services = isset($config['services']) ? $config['services'] : array();
203:         $factories = isset($config['factories']) ? $config['factories'] : array();
204:         if ($tmp = array_intersect_key($services, $factories)) {
205:             $tmp = implode("', '", array_keys($tmp));
206:             throw new Nette\DI\ServiceCreationException("It is not allowed to use services and factories with the same names: '$tmp'.");
207:         }
208: 
209:         $all = $services + $factories;
210:         uasort($all, function($a, $b) {
211:             return strcmp(Helpers::isInheriting($a), Helpers::isInheriting($b));
212:         });
213: 
214:         foreach ($all as $name => $def) {
215:             $shared = array_key_exists($name, $services);
216:             $name = ($namespace ? $namespace . '.' : '') . $name;
217: 
218:             if (($parent = Helpers::takeParent($def)) && $parent !== $name) {
219:                 $container->removeDefinition($name);
220:                 $definition = $container->addDefinition($name);
221:                 if ($parent !== Helpers::OVERWRITE) {
222:                     foreach ($container->getDefinition($parent) as $k => $v) {
223:                         $definition->$k = $v;
224:                     }
225:                 }
226:             } elseif ($container->hasDefinition($name)) {
227:                 $definition = $container->getDefinition($name);
228:                 if ($definition->shared !== $shared) {
229:                     throw new Nette\DI\ServiceCreationException("It is not allowed to use service and factory with the same name '$name'.");
230:                 }
231:             } else {
232:                 $definition = $container->addDefinition($name);
233:             }
234:             try {
235:                 static::parseService($definition, $def, $shared);
236:             } catch (\Exception $e) {
237:                 throw new Nette\DI\ServiceCreationException("Service '$name': " . $e->getMessage(), NULL, $e);
238:             }
239:         }
240:     }
241: 
242: 
243: 
244:     /**
245:      * Parses single service from configuration file.
246:      * @return void
247:      */
248:     public static function parseService(Nette\DI\ServiceDefinition $definition, $config, $shared = TRUE)
249:     {
250:         if ($config === NULL) {
251:             return;
252:         } elseif (!is_array($config)) {
253:             $config = array('class' => NULL, 'factory' => $config);
254:         }
255: 
256:         $known = $shared
257:             ? array('class', 'factory', 'arguments', 'setup', 'autowired', 'run', 'tags')
258:             : array('class', 'factory', 'arguments', 'setup', 'autowired', 'tags', 'internal', 'parameters');
259: 
260:         if ($error = array_diff(array_keys($config), $known)) {
261:             throw new Nette\InvalidStateException("Unknown key '" . implode("', '", $error) . "' in definition of service.");
262:         }
263: 
264:         $arguments = array();
265:         if (array_key_exists('arguments', $config)) {
266:             Validators::assertField($config, 'arguments', 'array');
267:             $arguments = self::filterArguments($config['arguments']);
268:             $definition->setArguments($arguments);
269:         }
270: 
271:         if (array_key_exists('class', $config) || array_key_exists('factory', $config)) {
272:             $definition->class = NULL;
273:             $definition->factory = NULL;
274:         }
275: 
276:         if (array_key_exists('class', $config)) {
277:             Validators::assertField($config, 'class', 'string|stdClass|null');
278:             if ($config['class'] instanceof \stdClass) {
279:                 $definition->setClass($config['class']->value, self::filterArguments($config['class']->attributes));
280:             } else {
281:                 $definition->setClass($config['class'], $arguments);
282:             }
283:         }
284: 
285:         if (array_key_exists('factory', $config)) {
286:             Validators::assertField($config, 'factory', 'callable|stdClass|null');
287:             if ($config['factory'] instanceof \stdClass) {
288:                 $definition->setFactory($config['factory']->value, self::filterArguments($config['factory']->attributes));
289:             } else {
290:                 $definition->setFactory($config['factory'], $arguments);
291:             }
292:         }
293: 
294:         if (isset($config['setup'])) {
295:             if (Helpers::takeParent($config['setup'])) {
296:                 $definition->setup = array();
297:             }
298:             Validators::assertField($config, 'setup', 'list');
299:             foreach ($config['setup'] as $id => $setup) {
300:                 Validators::assert($setup, 'callable|stdClass', "setup item #$id");
301:                 if ($setup instanceof \stdClass) {
302:                     Validators::assert($setup->value, 'callable', "setup item #$id");
303:                     if (strpos(is_array($setup->value) ? implode('', $setup->value) : $setup->value, '$') === FALSE) {
304:                         $definition->addSetup($setup->value, self::filterArguments($setup->attributes));
305:                     } else {
306:                         Validators::assert($setup->attributes, 'list:1', "setup arguments for '" . callback($setup->value) . "'");
307:                         $definition->addSetup($setup->value, $setup->attributes[0]);
308:                     }
309:                 } else {
310:                     $definition->addSetup($setup);
311:                 }
312:             }
313:         }
314: 
315:         $definition->setShared($shared);
316:         if (isset($config['parameters'])) {
317:             Validators::assertField($config, 'parameters', 'array');
318:             $definition->setParameters($config['parameters']);
319:         }
320: 
321:         if (isset($config['autowired'])) {
322:             Validators::assertField($config, 'autowired', 'bool');
323:             $definition->setAutowired($config['autowired']);
324:         }
325: 
326:         if (isset($config['internal'])) {
327:             Validators::assertField($config, 'internal', 'bool');
328:             $definition->setInternal($config['internal']);
329:         }
330: 
331:         if (isset($config['run'])) {
332:             $config['tags']['run'] = (bool) $config['run'];
333:         }
334: 
335:         if (isset($config['tags'])) {
336:             Validators::assertField($config, 'tags', 'array');
337:             if (Helpers::takeParent($config['tags'])) {
338:                 $definition->tags = array();
339:             }
340:             foreach ($config['tags'] as $tag => $attrs) {
341:                 if (is_int($tag) && is_string($attrs)) {
342:                     $definition->addTag($attrs);
343:                 } else {
344:                     $definition->addTag($tag, $attrs);
345:                 }
346:             }
347:         }
348:     }
349: 
350: 
351: 
352:     /**
353:      * Removes ... and replaces entities with Nette\DI\Statement.
354:      * @return array
355:      */
356:     public static function filterArguments(array $args)
357:     {
358:         foreach ($args as $k => $v) {
359:             if ($v === '...') {
360:                 unset($args[$k]);
361:             } elseif ($v instanceof \stdClass && isset($v->value, $v->attributes)) {
362:                 $args[$k] = new Nette\DI\Statement($v->value, self::filterArguments($v->attributes));
363:             }
364:         }
365:         return $args;
366:     }
367: 
368: }
369: 
Nette Framework 2.0.0 API API documentation generated by ApiGen 2.7.0