Overview

Namespaces

  • Net
    • Bazzline
      • Component
        • CodeGenerator
          • Factory

Classes

  • Net\Bazzline\Component\CodeGenerator\AbstractBasicGenerator
  • Net\Bazzline\Component\CodeGenerator\AbstractContentGenerator
  • Net\Bazzline\Component\CodeGenerator\AbstractDocumentedGenerator
  • Net\Bazzline\Component\CodeGenerator\AbstractGenerator
  • Net\Bazzline\Component\CodeGenerator\BlockGenerator
  • Net\Bazzline\Component\CodeGenerator\ClassGenerator
  • Net\Bazzline\Component\CodeGenerator\ConstantGenerator
  • Net\Bazzline\Component\CodeGenerator\DocumentationGenerator
  • Net\Bazzline\Component\CodeGenerator\Factory\AbstractGeneratorFactory
  • Net\Bazzline\Component\CodeGenerator\Factory\BlockGeneratorFactory
  • Net\Bazzline\Component\CodeGenerator\Factory\ClassGeneratorFactory
  • Net\Bazzline\Component\CodeGenerator\Factory\ConstantGeneratorFactory
  • Net\Bazzline\Component\CodeGenerator\Factory\DocumentationGeneratorFactory
  • Net\Bazzline\Component\CodeGenerator\Factory\FileGeneratorFactory
  • Net\Bazzline\Component\CodeGenerator\Factory\InterfaceGeneratorFactory
  • Net\Bazzline\Component\CodeGenerator\Factory\LineGeneratorFactory
  • Net\Bazzline\Component\CodeGenerator\Factory\MethodGeneratorFactory
  • Net\Bazzline\Component\CodeGenerator\Factory\PropertyGeneratorFactory
  • Net\Bazzline\Component\CodeGenerator\Factory\SignatureGeneratorFactory
  • Net\Bazzline\Component\CodeGenerator\Factory\TraitGeneratorFactory
  • Net\Bazzline\Component\CodeGenerator\FileGenerator
  • Net\Bazzline\Component\CodeGenerator\Indention
  • Net\Bazzline\Component\CodeGenerator\InterfaceGenerator
  • Net\Bazzline\Component\CodeGenerator\LineGenerator
  • Net\Bazzline\Component\CodeGenerator\MethodGenerator
  • Net\Bazzline\Component\CodeGenerator\PropertyGenerator
  • Net\Bazzline\Component\CodeGenerator\SignatureGenerator
  • Net\Bazzline\Component\CodeGenerator\TraitGenerator

Interfaces

  • Net\Bazzline\Component\CodeGenerator\BlockGeneratorDependentInterface
  • Net\Bazzline\Component\CodeGenerator\Factory\ContentFactoryInterface
  • Net\Bazzline\Component\CodeGenerator\GeneratorInterface
  • Net\Bazzline\Component\CodeGenerator\IndentionAwareInterface
  • Net\Bazzline\Component\CodeGenerator\LineGeneratorDependentInterface

Exceptions

  • Net\Bazzline\Component\CodeGenerator\InvalidArgumentException
  • Net\Bazzline\Component\CodeGenerator\RuntimeException
  • Overview
  • Namespace
  • Class
  1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 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: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 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: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 265: 266: 
<?php
/**
 * @author stev leibelt <artodeto@bazzline.net>
 * @since 2014-04-24 
 */

namespace Net\Bazzline\Component\CodeGenerator;

/**
 * Class AbstractGenerator
 * @package Net\Bazzline\Component\Locator\LocatorGenerator\Generator
 */
abstract class AbstractGenerator extends AbstractBasicGenerator implements BlockGeneratorDependentInterface, LineGeneratorDependentInterface
{
    /** @var boolean */
    private $canBeGenerated;

    /** @var BlockGenerator */
    private $blockGenerator;

    /** @var LineGenerator */
    private $lineGenerator;

    /** @var array */
    private $properties = [];

    public function __construct()
    {
        $this->properties = [];
    }

    /**
     * @return $this
     */
    public function clear()
    {
        $this->properties = [];
        $this->resetContent();
    }

    /**
     * @return $this
     */
    public function __clone()
    {
        $this->clear();
    }

    /**
     * @param BlockGenerator $generator
     * @return $this
     */
    public function setBlockGenerator(BlockGenerator $generator)
    {
        $this->blockGenerator = $generator;

        return $this;
    }

    /**
     * @param LineGenerator $generator
     * @return $this
     */
    public function setLineGenerator(LineGenerator $generator)
    {
        $this->lineGenerator = $generator;

        return $this;
    }

    /**
     * @param Indention $indention
     * @return $this
     */
    final public function setIndention(Indention $indention)
    {
        parent::setIndention($indention);
        $this->blockGenerator->setIndention($indention);
        $this->lineGenerator->setIndention($indention);

        return $this;
    }

    /**
     * @return boolean
     */
    public function hasContent()
    {
        return (!empty($this->properties));
    }

    /**
     * @return $this
     */
    final protected function markAsCanBeGenerated()
    {
        $this->canBeGenerated = true;

        return $this;
    }

    /**
     * @return bool
     */
    final protected function canBeGenerated()
    {
        return ($this->canBeGenerated === true);
    }

    /**
     * @param string $name
     * @param mixed $value
     * @param bool $isStackable
     */
    final protected function addGeneratorProperty($name, $value, $isStackable = true)
    {
        $name = (string) $name;

        if ($isStackable) {
            if ((!isset($this->properties[$name]))
                || (!is_array($this->properties[$name]))) {
                $this->properties[$name] = [];
            }
            $this->properties[$name][] = $value;
        } else {
            if (!isset($this->properties[$name])) {
                $this->properties[$name] = null;
            }
            $this->properties[$name] = $value;
        }

        $this->markAsCanBeGenerated();
    }

    /**
     * @param string|AbstractGenerator[] $content
     * @param bool $isIndented
     * @throws InvalidArgumentException
     * @todo extend addContent to support int|string|array|LineGenerator|BlockGenerator
     */
    final protected function addContent($content, $isIndented = false)
    {
        if ($isIndented) {
            $this->getIndention()->increaseLevel();
        }
        if (!($content instanceof AbstractGenerator)) {
            if (is_array($content)) {
                $content = $this->getBlockGenerator($content);
            } else {
                $content = $this->getLineGenerator($content);
            }
        }
        //@todo why? - take a look to BlockGenerator->generate(), strings are not supported
        $content = $content->generate();
        if ($isIndented) {
            $this->getIndention()->decreaseLevel();
        }
        $this->blockGenerator->add($content);
    }

    /**
     * @param GeneratorInterface $generator
     * @param bool $isIndented - needed?
     */
    final protected function addGeneratorAsContent(GeneratorInterface $generator, $isIndented = false)
    {
        $generator->setIndention($this->getIndention());
        $this->addContent(
            explode(
                PHP_EOL,
                $generator->generate()
            ),
            $isIndented
        );
    }

    /**
     * @return string
     */
    final protected function generateStringFromContent()
    {
        return $this->blockGenerator->generate();
    }

    /**
     * @param string $name
     * @param mixed $default
     * @return null|string|array
     */
    final protected function getGeneratorProperty($name, $default = null)
    {
        return (isset($this->properties[$name])) ? $this->properties[$name] : $default;
    }

    /**
     * @param null|string|LineGenerator|BlockGenerator $content
     * @return BlockGenerator
     */
    final protected function getBlockGenerator($content = null)
    {
        $block = clone $this->blockGenerator;
        $block->setIndention($this->getIndention());

        if (!is_null($content)) {
            $block->add($content);
        }

        return $block;
    }

    /**
     * @param null|string $content
     * @return LineGenerator
     */
    final protected function getLineGenerator($content = null)
    {
        $line = clone $this->lineGenerator;
        $line->setIndention($this->getIndention());

        if (!is_null($content)) {
            $line->add($content);
        }

        return $line;
    }

    /**
     * @return array
     */
    final protected function getNotPrintableTypeHints()
    {
        return [
            'bool', 
            'boolean', 
            'int', 
            'integer', 
            'object', 
            'resource', 
            'string'
        ];
    }

    /**
     * @param array $array
     * @return mixed
     */
    final protected function getLastArrayKey(array $array)
    {
        end($array);
        $lastArrayKey = key($array);
        reset($array);

        return $lastArrayKey;
    }

    /**
     * @return $this
     */
    final protected function resetContent()
    {
        $this->blockGenerator = $this->getBlockGenerator();

        return $this;
    }
}
PHP Code Generator Component by bazzline.net API documentation generated by ApiGen