Code Coverage |
||||||||||
Classes and Traits |
Functions and Methods |
Lines |
||||||||
| Total | |
0.00% |
0 / 1 |
|
94.44% |
17 / 18 |
CRAP | |
96.39% |
80 / 83 |
| Generator | |
0.00% |
0 / 1 |
|
94.44% |
17 / 18 |
49 | |
96.39% |
80 / 83 |
| __construct | |
100.00% |
1 / 1 |
4 | |
100.00% |
7 / 7 |
|||
| addCodeObjects | |
100.00% |
1 / 1 |
5 | |
100.00% |
8 / 8 |
|||
| addCodeObject | |
100.00% |
1 / 1 |
2 | |
100.00% |
5 / 5 |
|||
| hasCode | |
100.00% |
1 / 1 |
1 | |
100.00% |
1 / 1 |
|||
| getCode | |
100.00% |
1 / 1 |
1 | |
100.00% |
1 / 1 |
|||
| code | |
100.00% |
1 / 1 |
1 | |
100.00% |
1 / 1 |
|||
| setCloseTag | |
100.00% |
1 / 1 |
1 | |
100.00% |
2 / 2 |
|||
| hasCloseTag | |
100.00% |
1 / 1 |
1 | |
100.00% |
1 / 1 |
|||
| setEnv | |
100.00% |
1 / 1 |
1 | |
100.00% |
2 / 2 |
|||
| getEnv | |
100.00% |
1 / 1 |
1 | |
100.00% |
1 / 1 |
|||
| hasEnv | |
100.00% |
1 / 1 |
1 | |
100.00% |
1 / 1 |
|||
| setFilename | |
100.00% |
1 / 1 |
1 | |
100.00% |
2 / 2 |
|||
| hasFilename | |
100.00% |
1 / 1 |
1 | |
100.00% |
1 / 1 |
|||
| getFilename | |
100.00% |
1 / 1 |
1 | |
100.00% |
1 / 1 |
|||
| render | |
100.00% |
1 / 1 |
15 | |
100.00% |
30 / 30 |
|||
| writeToFile | |
100.00% |
1 / 1 |
4 | |
100.00% |
6 / 6 |
|||
| outputToHttp | |
0.00% |
0 / 1 |
7.77 | |
75.00% |
9 / 12 |
|||
| __toString | |
100.00% |
1 / 1 |
1 | |
100.00% |
1 / 1 |
|||
| <?php | |
| /** | |
| * Pop PHP Framework (http://www.popphp.org/) | |
| * | |
| * @link https://github.com/popphp/popphp-framework | |
| * @author Nick Sagona, III <dev@nolainteractive.com> | |
| * @copyright Copyright (c) 2009-2020 NOLA Interactive, LLC. (http://www.nolainteractive.com) | |
| * @license http://www.popphp.org/license New BSD License | |
| */ | |
| /** | |
| * @namespace | |
| */ | |
| namespace Pop\Code; | |
| use Pop\Code\Generator\GeneratorInterface; | |
| use Pop\Code\Generator\Traits; | |
| /** | |
| * Generator code class | |
| * | |
| * @category Pop | |
| * @package Pop\Code | |
| * @author Nick Sagona, III <dev@nolainteractive.com> | |
| * @copyright Copyright (c) 2009-2020 NOLA Interactive, LLC. (http://www.nolainteractive.com) | |
| * @license http://www.popphp.org/license New BSD License | |
| * @version 4.0.0 | |
| */ | |
| class Generator extends Generator\AbstractGenerator | |
| { | |
| use Traits\DocblockTrait; | |
| /** | |
| * Code generator objects | |
| * @var array | |
| */ | |
| protected $code = []; | |
| /** | |
| * Namespaces for the code generator objects | |
| * @var array | |
| */ | |
| protected $namespaces = []; | |
| /** | |
| * Environment setting, i.e. #!/usr/bin/php | |
| * @var string | |
| */ | |
| protected $env = null; | |
| /** | |
| * Flag to close the code file with ?> | |
| * @var boolean | |
| */ | |
| protected $close = false; | |
| /** | |
| * Code filename | |
| * @var string | |
| */ | |
| protected $filename = null; | |
| /** | |
| * Constructor | |
| * | |
| * Instantiate the code generator object | |
| * | |
| * @param mixed $code | |
| * @throws Exception | |
| */ | |
| public function __construct($code = null) | |
| { | |
| if (null !== $code) { | |
| if (is_array($code)) { | |
| $this->addCodeObjects($code); | |
| } else if ($code instanceof GeneratorInterface) { | |
| $this->addCodeObject($code); | |
| } else { | |
| throw new Exception('Error: The code parameter was not the correct type.'); | |
| } | |
| } | |
| } | |
| /** | |
| * Add code generator objects | |
| * | |
| * @param array $codeObjects | |
| * @return Generator | |
| */ | |
| public function addCodeObjects(array $codeObjects) | |
| { | |
| foreach ($codeObjects as $namespace => $codeObject) { | |
| if (!is_numeric($namespace)) { | |
| if (is_array($codeObject)) { | |
| foreach ($codeObject as $code) { | |
| $this->addCodeObject($code, $namespace); | |
| } | |
| } else { | |
| $this->addCodeObject($codeObject, $namespace); | |
| } | |
| } else { | |
| $this->addCodeObject($codeObject); | |
| } | |
| } | |
| return $this; | |
| } | |
| /** | |
| * Add a code generator object | |
| * | |
| * @param Generator\GeneratorInterface $codeObject | |
| * @param string $namespace | |
| * @return Generator | |
| */ | |
| public function addCodeObject(Generator\GeneratorInterface $codeObject, $namespace = null) | |
| { | |
| $this->code[] = $codeObject; | |
| if (null !== $namespace) { | |
| $key = count($this->code) - 1; | |
| $this->namespaces[$key] = $namespace; | |
| } | |
| return $this; | |
| } | |
| /** | |
| * Has code generator objects | |
| * | |
| * @return boolean | |
| */ | |
| public function hasCode() | |
| { | |
| return (!empty($this->code)); | |
| } | |
| /** | |
| * Access the code generator object | |
| * | |
| * @return array | |
| */ | |
| public function getCode() | |
| { | |
| return $this->code; | |
| } | |
| /** | |
| * Access the code generator objects (alias method) | |
| * | |
| * @return array | |
| */ | |
| public function code() | |
| { | |
| return $this->code; | |
| } | |
| /** | |
| * Set the code close tag flag | |
| * | |
| * @param boolean $close | |
| * @return Generator | |
| */ | |
| public function setCloseTag($close = false) | |
| { | |
| $this->close = (boolean)$close; | |
| return $this; | |
| } | |
| /** | |
| * Determine if the code close tag flag is set | |
| * | |
| * @return boolean | |
| */ | |
| public function hasCloseTag() | |
| { | |
| return $this->close; | |
| } | |
| /** | |
| * Set the environment | |
| * | |
| * @param string $env | |
| * @return Generator | |
| */ | |
| public function setEnv($env = null) | |
| { | |
| $this->env = $env; | |
| return $this; | |
| } | |
| /** | |
| * Get the environment | |
| * | |
| * @return string | |
| */ | |
| public function getEnv() | |
| { | |
| return $this->env; | |
| } | |
| /** | |
| * Determine if the environment is set | |
| * | |
| * @return boolean | |
| */ | |
| public function hasEnv() | |
| { | |
| return (null !== $this->env); | |
| } | |
| /** | |
| * Set the filename | |
| * | |
| * @param string $filename | |
| * @return Generator | |
| */ | |
| public function setFilename($filename) | |
| { | |
| $this->filename = $filename; | |
| return $this; | |
| } | |
| /** | |
| * Has filename | |
| * | |
| * @return boolean | |
| */ | |
| public function hasFilename() | |
| { | |
| return (null !== $this->filename); | |
| } | |
| /** | |
| * Get filename | |
| * | |
| * @return string | |
| */ | |
| public function getFilename() | |
| { | |
| return $this->filename; | |
| } | |
| /** | |
| * Render method | |
| * | |
| * @return string | |
| */ | |
| public function render() | |
| { | |
| $this->output = ''; | |
| if (null !== $this->env) { | |
| $this->output .= $this->env . PHP_EOL; | |
| } | |
| $this->output .= '<?php' . PHP_EOL; | |
| $this->output .= (null !== $this->docblock) ? $this->docblock->render() . PHP_EOL : null; | |
| $currentNamespace = null; | |
| $inNamespace = false; | |
| foreach ($this->code as $key => $code) { | |
| if (isset($this->namespaces[$key]) && ($currentNamespace != $this->namespaces[$key])) { | |
| if (null !== $currentNamespace) { | |
| $this->output .= '}' . PHP_EOL . PHP_EOL; | |
| } | |
| $namespace = ($this->namespaces[$key] != '*') ? $this->namespaces[$key] . ' ' : null; | |
| $this->output .= 'namespace ' . $namespace . '{' . PHP_EOL; | |
| $currentNamespace = $this->namespaces[$key]; | |
| $inNamespace = true; | |
| } else if (!isset($this->namespaces[$key]) && (null !== $currentNamespace)) { | |
| $this->output .= '}' . PHP_EOL . PHP_EOL; | |
| $inNamespace = false; | |
| } | |
| if (null !== $currentNamespace) { | |
| $code->setIndent($code->getIndent() + $this->indent); | |
| if ($code->hasDocblock()) { | |
| $code->getDocblock()->setIndent($code->getDocblock()->getIndent() + $this->indent); | |
| } | |
| if (in_array('Pop\Code\Generator\Traits\BodyTrait', class_uses($code))) { | |
| $code->indentBody($this->indent); | |
| } | |
| } | |
| $this->output .= $code; | |
| } | |
| if ($inNamespace) { | |
| $this->output .= '}' . PHP_EOL . PHP_EOL; | |
| } | |
| if ($this->close) { | |
| $this->output .= '?>' . PHP_EOL; | |
| } | |
| return $this->output; | |
| } | |
| /** | |
| * Write to file | |
| * | |
| * @param string $filename | |
| * @throws Exception | |
| * @return void | |
| */ | |
| public function writeToFile($filename = null) | |
| { | |
| if ((null !== $this->filename) && (null === $filename)) { | |
| $filename = $this->filename; | |
| } | |
| if (empty($filename)) { | |
| throw new Exception('Error: The filename has not been set.'); | |
| } | |
| file_put_contents($filename, $this->render()); | |
| } | |
| /** | |
| * Output to HTTP | |
| * | |
| * @param string $filename | |
| * @param boolean $forceDownload | |
| * @param array $headers | |
| * @return void | |
| */ | |
| public function outputToHttp($filename = null, $forceDownload = false, array $headers = []) | |
| { | |
| if ((null !== $this->filename) && (null === $filename)) { | |
| $filename = $this->filename; | |
| } | |
| if (empty($filename)) { | |
| $filename = 'code.php'; | |
| } | |
| $headers['Content-Type'] = 'text/plain'; | |
| $headers['Content-Disposition'] = (($forceDownload) ? 'attachment; ' : null) . 'filename=' . $filename; | |
| // Send the headers and output the PDF | |
| if (!headers_sent()) { | |
| header('HTTP/1.1 200 OK'); | |
| foreach ($headers as $name => $value) { | |
| header($name . ': ' . $value); | |
| } | |
| } | |
| echo $this->render(); | |
| } | |
| /** | |
| * Print code | |
| * | |
| * @return string | |
| */ | |
| public function __toString() | |
| { | |
| return $this->render(); | |
| } | |
| } |