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: 
<?php
/**
 * @author stev leibelt <artodeto@bazzline.net>
 * @since 2014-05-14 
 */

namespace Net\Bazzline\Component\CodeGenerator;

/**
 * Class FileGenerator
 * @package Net\Bazzline\Component\CodeGenerator
 */
class FileGenerator extends AbstractDocumentedGenerator
{
    /** @var boolean */
    private $addEmptyLine;

    /**
     * @param ConstantGenerator $constant
     * @return $this
     */
    public function addConstant(ConstantGenerator $constant)
    {
        $this->addGeneratorProperty('constants', $constant);

        return $this;
    }

    /**
     * @param PropertyGenerator $property
     * @return $this
     */
    public function addProperty(PropertyGenerator $property)
    {
        $this->addGeneratorProperty('properties', $property);

        return $this;
    }

    /**
     * @param ClassGenerator $class
     * @return $this
     */
    public function addClass(ClassGenerator $class)
    {
        $this->addGeneratorProperty('classes', $class);

        return $this;
    }

    /**
     * @param InterfaceGenerator $interface
     * @return $this
     */
    public function addInterface(InterfaceGenerator $interface)
    {
        $this->addGeneratorProperty('interfaces', $interface);

        return $this;
    }

    /**
     * @param MethodGenerator $method
     * @return $this
     */
    public function addMethod(MethodGenerator $method)
    {
        $this->addGeneratorProperty('methods', $method);

        return $this;
    }

    /**
     * @param TraitGenerator $trait
     * @return $this
     */
    public function addTrait(TraitGenerator $trait)
    {
        $this->addGeneratorProperty('traits', $trait->getName());

        return $this;
    }

    public function markAsExecutable()
    {
        $this->addGeneratorProperty('is_executable', true, false);

        return $this;
    }

    /**
     * @param int|string|array $content
     * @return $this
     * @todo add support for Generator as type
     */
    public function addFileContent($content)
    {
        if (!is_array($content)) {
            $content = [
                $content
            ];
        }

        foreach ($content as $partial) {
            $this->addGeneratorProperty('content', $partial);
        }

        return $this;
    }

    /**
     * @throws InvalidArgumentException|RuntimeException
     * @return string
     * @todo implement exception throwing if mandatory parameter is missing
     */
    public function generate()
    {
        if ($this->canBeGenerated()) {
            $this->resetContent();
            $this->addEmptyLine = false;
            $isExecutable = $this->getGeneratorProperty('is_executable', false);
            if ($isExecutable) {
                $this->addContent('#!/bin/php');
            }

            $this->addContent('<?php');
            $this->generateContent();
            $this->generateConstants();
            $this->generateProperties();
            $this->generateTraits();
            $this->generateMethods();
            $this->generateInterfaces();
            $this->generateClasses();
        }

        return $this->generateStringFromContent();
    }

    private function generateContent()
    {
        $content = $this->getGeneratorProperty('content', []);

        foreach ($content as $partial) {
            $this->addContent($partial);
        }
        $this->addEmptyLine = true;
    }

    private function generateConstants()
    {
        /** @var null|ConstantGenerator[] $constants */
        $constants = $this->getGeneratorProperty('constants');

        $this->addContentFromCollectionTwo($constants);
    }

    private function generateProperties()
    {
        /** @var null|PropertyGenerator[] $properties */
        $properties = $this->getGeneratorProperty('properties');

        $this->addContentFromCollectionTwo($properties);
    }

    private function generateTraits()
    {
        /** @var null|array $traits */
        $traits = $this->getGeneratorProperty('traits');

        $this->addContentFromCollectionTwo($traits);
    }

    private function generateMethods()
    {
        /** @var null|MethodGenerator[] $methods */
        $methods = $this->getGeneratorProperty('methods');

        $this->addContentFromCollectionTwo($methods);
    }

    private function generateClasses()
    {
        /** @var null|ClassGenerator[] $classes */
        $classes = $this->getGeneratorProperty('classes');

        $this->addContentFromCollection($classes);
    }

    private function generateInterfaces()
    {
        /** @var null|InterfaceGenerator[] $interfaces */
        $interfaces = $this->getGeneratorProperty('interfaces');

        $this->addContentFromCollection($interfaces);
    }

    /**
     * @param null|array $collection
     * @todo figure out difference between addContentFromCollection and
     *  addContentFromCollectionTwo and express difference with fitting names
     */
    private function addContentFromCollection($collection)
    {
        if (is_array($collection)) {
            if ($this->addEmptyLine) {
                $this->addContent('');
            }
            $keys = array_keys($collection);
            $lastKey = array_pop($keys);

            foreach($collection as $key => $item) {
                $this->addGeneratorAsContent($item);
                if ($key !== $lastKey) {
                    $this->addContent('');
                }
            }
        }
    }

    /**
     * @param null|array $collection
     */
    private function addContentFromCollectionTwo($collection)
    {
        if (is_array($collection)) {
            if ($this->addEmptyLine) {
                $this->addContent('');
            }
            $lastKey = $this->getLastArrayKey($collection);
            foreach($collection as $key => $item) {
                $this->addGeneratorAsContent($item);
                if ($key !== $lastKey) {
                    $this->addContent('');
                }
            }
        }
        $this->addEmptyLine = true;
    }
}
PHP Code Generator Component by bazzline.net API documentation generated by ApiGen