3 * Zend Framework (http://framework.zend.com/)
5 * @link http://github.com/zendframework/zf2 for the canonical source repository
6 * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
7 * @license http://framework.zend.com/license/new-bsd New BSD License
10 namespace Zend\Code\Generator
;
12 use Zend\Code\Reflection\Exception
as ReflectionException
;
13 use Zend\Code\Reflection\FileReflection
;
15 class FileGenerator
extends AbstractGenerator
20 protected $filename = null;
23 * @var DocBlockGenerator
25 protected $docBlock = null;
30 protected $requiredFiles = array();
35 protected $namespace = null;
40 protected $uses = array();
45 protected $classes = array();
50 protected $body = null;
53 * Passes $options to {@link setOptions()}.
55 * @param array|\Traversable $options
57 public function __construct($options = null)
59 if (null !== $options) {
60 $this->setOptions($options);
65 * Use this if you intend on generating code generation objects based on the same file.
66 * This will keep previous changes to the file in tact during the same PHP process
68 * @param string $filePath
69 * @param bool $includeIfNotAlreadyIncluded
70 * @throws ReflectionException\InvalidArgumentException If file does not exists
71 * @throws ReflectionException\RuntimeException If file exists but is not included or required
72 * @return FileGenerator
74 public static function fromReflectedFileName($filePath, $includeIfNotAlreadyIncluded = true)
76 $fileReflector = new FileReflection($filePath, $includeIfNotAlreadyIncluded);
77 $codeGenerator = static::fromReflection($fileReflector);
79 return $codeGenerator;
83 * @param FileReflection $fileReflection
84 * @return FileGenerator
86 public static function fromReflection(FileReflection
$fileReflection)
90 $file->setSourceContent($fileReflection->getContents());
91 $file->setSourceDirty(false);
93 $body = $fileReflection->getContents();
95 $uses = $fileReflection->getUses();
97 foreach ($fileReflection->getClasses() as $class) {
98 $phpClass = ClassGenerator
::fromReflection($class);
99 $phpClass->setContainingFileGenerator($file);
101 foreach ($uses as $fileUse) {
102 $phpClass->addUse($fileUse['use'], $fileUse['as']);
105 $file->setClass($phpClass);
107 $classStartLine = $class->getStartLine(true);
108 $classEndLine = $class->getEndLine();
110 $bodyLines = explode("\n", $body);
111 $bodyReturn = array();
112 for ($lineNum = 1, $count = count($bodyLines); $lineNum <= $count; $lineNum++
) {
113 if ($lineNum == $classStartLine) {
114 $bodyReturn[] = str_replace(
117 '/* Zend_Code_Generator_Php_File-ClassMarker: {?} */'
120 $lineNum = $classEndLine;
122 $bodyReturn[] = $bodyLines[$lineNum - 1]; // adjust for index -> line conversion
125 $body = implode("\n", $bodyReturn);
126 unset($bodyLines, $bodyReturn, $classStartLine, $classEndLine);
129 $namespace = $fileReflection->getNamespace();
131 if ($namespace != '') {
132 $file->setNamespace($namespace);
136 $file->setUses($uses);
139 if (($fileReflection->getDocComment() != '')) {
140 $docBlock = $fileReflection->getDocBlock();
141 $file->setDocBlock(DocBlockGenerator
::fromReflection($docBlock));
143 $bodyLines = explode("\n", $body);
144 $bodyReturn = array();
145 for ($lineNum = 1, $count = count($bodyLines); $lineNum <= $count; $lineNum++
) {
146 if ($lineNum == $docBlock->getStartLine()) {
147 $bodyReturn[] = str_replace(
150 '/* Zend_Code_Generator_FileGenerator-DocBlockMarker */'
152 $lineNum = $docBlock->getEndLine();
154 $bodyReturn[] = $bodyLines[$lineNum - 1]; // adjust for index -> line conversion
157 $body = implode("\n", $bodyReturn);
158 unset($bodyLines, $bodyReturn, $classStartLine, $classEndLine);
161 $file->setBody($body);
167 * @param array $values
168 * @return FileGenerator
170 public static function fromArray(array $values)
172 $fileGenerator = new static;
173 foreach ($values as $name => $value) {
174 switch (strtolower(str_replace(array('.', '-', '_'), '', $name))) {
176 $fileGenerator->setFilename($value);
179 $fileGenerator->setClass(($value instanceof ClassGenerator
) ?
$value : ClassGenerator
::fromArray($value));
181 case 'requiredfiles':
182 $fileGenerator->setRequiredFiles($value);
185 if (property_exists($fileGenerator, $name)) {
186 $fileGenerator->{$name} = $value;
187 } elseif (method_exists($fileGenerator, 'set' . $name)) {
188 $fileGenerator->{'set' . $name}($value);
193 return $fileGenerator;
197 * @param DocBlockGenerator|string $docBlock
198 * @throws Exception\InvalidArgumentException
199 * @return FileGenerator
201 public function setDocBlock($docBlock)
203 if (is_string($docBlock)) {
204 $docBlock = array('shortDescription' => $docBlock);
207 if (is_array($docBlock)) {
208 $docBlock = new DocBlockGenerator($docBlock);
209 } elseif (!$docBlock instanceof DocBlockGenerator
) {
210 throw new Exception\
InvalidArgumentException(sprintf(
211 '%s is expecting either a string, array or an instance of %s\DocBlockGenerator',
217 $this->docBlock
= $docBlock;
222 * @return DocBlockGenerator
224 public function getDocBlock()
226 return $this->docBlock
;
230 * @param array $requiredFiles
231 * @return FileGenerator
233 public function setRequiredFiles(array $requiredFiles)
235 $this->requiredFiles
= $requiredFiles;
242 public function getRequiredFiles()
244 return $this->requiredFiles
;
248 * @param array $classes
249 * @return FileGenerator
251 public function setClasses(array $classes)
253 foreach ($classes as $class) {
254 $this->setClass($class);
263 public function getNamespace()
265 return $this->namespace;
269 * @param string $namespace
270 * @return FileGenerator
272 public function setNamespace($namespace)
274 $this->namespace = (string) $namespace;
279 * Returns an array with the first element the use statement, second is the as part.
280 * If $withResolvedAs is set to true, there will be a third element that is the
281 * "resolved" as statement, as the second part is not required in use statements
283 * @param bool $withResolvedAs
286 public function getUses($withResolvedAs = false)
289 if ($withResolvedAs) {
290 for ($useIndex = 0, $count = count($uses); $useIndex < $count; $useIndex++
) {
291 if ($uses[$useIndex][1] == '') {
292 if (($lastSeparator = strrpos($uses[$useIndex][0], '\\')) !== false) {
293 $uses[$useIndex][2] = substr($uses[$useIndex][0], $lastSeparator +
1);
295 $uses[$useIndex][2] = $uses[$useIndex][0];
298 $uses[$useIndex][2] = $uses[$useIndex][1];
308 * @return FileGenerator
310 public function setUses(array $uses)
312 foreach ($uses as $use) {
314 if (array_key_exists('use', $use) && array_key_exists('as', $use)) {
315 $import = $use['use'];
317 } elseif (count($use) == 2) {
318 list($import, $alias) = $use;
320 $import = current($use);
323 $this->setUse($import, $alias);
330 * @param null|string $as
331 * @return FileGenerator
333 public function setUse($use, $as = null)
335 if (!in_array(array($use, $as), $this->uses
)) {
336 $this->uses
[] = array($use, $as);
342 * @param string $name
343 * @return ClassGenerator
345 public function getClass($name = null)
348 reset($this->classes
);
350 return current($this->classes
);
353 return $this->classes
[(string) $name];
357 * @param array|string|ClassGenerator $class
358 * @throws Exception\InvalidArgumentException
359 * @return FileGenerator
361 public function setClass($class)
363 if (is_array($class)) {
364 $class = ClassGenerator
::fromArray($class);
365 } elseif (is_string($class)) {
366 $class = new ClassGenerator($class);
367 } elseif (!$class instanceof ClassGenerator
) {
368 throw new Exception\
InvalidArgumentException(sprintf(
369 '%s is expecting either a string, array or an instance of %s\ClassGenerator',
375 // @todo check for dup here
376 $className = $class->getName();
377 $this->classes
[$className] = $class;
383 * @param string $filename
384 * @return FileGenerator
386 public function setFilename($filename)
388 $this->filename
= (string) $filename;
395 public function getFilename()
397 return $this->filename
;
401 * @return ClassGenerator[]
403 public function getClasses()
405 return $this->classes
;
409 * @param string $body
410 * @return FileGenerator
412 public function setBody($body)
414 $this->body
= (string) $body;
421 public function getBody()
429 public function isSourceDirty()
431 $docBlock = $this->getDocBlock();
432 if ($docBlock && $docBlock->isSourceDirty()) {
436 foreach ($this->classes
as $class) {
437 if ($class->isSourceDirty()) {
442 return parent
::isSourceDirty();
448 public function generate()
450 if ($this->isSourceDirty() === false) {
451 return $this->sourceContent
;
456 // start with the body (if there), or open tag
457 $body = $this->getBody();
458 if (preg_match('#(?:\s*)<\?php#', $body) == false) {
459 $output = '<?php' . self
::LINE_FEED
;
462 // if there are markers, put the body into the output
463 if (preg_match('#/\* Zend_Code_Generator_FileGenerator-(.*?)Marker:#', $body)) {
464 $tokens = token_get_all($body);
465 foreach ($tokens as $token) {
466 if (is_array($token) && in_array($token[0], array(T_OPEN_TAG
, T_COMMENT
, T_DOC_COMMENT
, T_WHITESPACE
))
468 $output .= $token[1];
474 // Add file DocBlock, if any
475 if (null !== ($docBlock = $this->getDocBlock())) {
476 $docBlock->setIndentation('');
478 if (preg_match('#/* Zend_Code_Generator_FileGenerator-DocBlockMarker */#', $output)) {
479 $output = preg_replace('#/* Zend_CodeGenerator_Php_File-DocBlockMarker */#', $docBlock->generate(),
482 $output .= $docBlock->generate() . self
::LINE_FEED
;
487 $output .= self
::LINE_FEED
;
490 $namespace = $this->getNamespace();
492 $output .= sprintf('namespace %s;%s', $namespace, str_repeat(self
::LINE_FEED
, 2));
495 // process required files
496 // @todo marker replacement for required files
497 $requiredFiles = $this->getRequiredFiles();
498 if (!empty($requiredFiles)) {
499 foreach ($requiredFiles as $requiredFile) {
500 $output .= 'require_once \'' . $requiredFile . '\';' . self
::LINE_FEED
;
503 $output .= self
::LINE_FEED
;
506 // process import statements
507 $uses = $this->getUses();
509 foreach ($uses as $use) {
510 list($import, $alias) = $use;
511 if (null === $alias) {
512 $output .= sprintf('use %s;%s', $import, self
::LINE_FEED
);
514 $output .= sprintf('use %s as %s;%s', $import, $alias, self
::LINE_FEED
);
517 $output .= self
::LINE_FEED
;
521 $classes = $this->getClasses();
522 if (!empty($classes)) {
523 foreach ($classes as $class) {
524 $regex = str_replace('?', $class->getName(),
525 '/* Zend_Code_Generator_FileGenerator-ClassMarker: {?} */');
526 $regex = preg_quote($regex, '#');
527 if (preg_match('#' . $regex . '#', $output)) {
528 $output = preg_replace('#' . $regex . '#', $class->generate(), $output, 1);
531 $class->setNamespaceName(null);
533 $output .= $class->generate() . self
::LINE_FEED
;
539 // add an extra space between classes and
540 if (!empty($classes)) {
541 $output .= self
::LINE_FEED
;
551 * @return FileGenerator
552 * @throws Exception\RuntimeException
554 public function write()
556 if ($this->filename
== '' ||
!is_writable(dirname($this->filename
))) {
557 throw new Exception\
RuntimeException('This code generator object is not writable.');
559 file_put_contents($this->filename
, $this->generate());