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: 267: 268: 269: 270: 271: 272: 273: 274: 275: 276: 277: 278: 279: 280: 281: 282: 283: 284: 285: 286: 287: 288: 289: 

<?php
/**
 * @author stev leibelt <artodeto@bazzline.net>
 * @since 2015-01-04 
 */

namespace Net\Bazzline\Component\CodeGenerator;

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

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

        return $this;
    }

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

        return $this;
    }

    /**
     * @param string $fullQualifiedClassName
     * @param string $alias
     * @return $this
     */
    public function addUse($fullQualifiedClassName, $alias = '')
    {
        $use = [
            'alias' => $alias,
            'name'  => $fullQualifiedClassName
        ];

        $this->addGeneratorProperty('uses', $use);

        return $this;
    }

    /**
     * @param string $name
     * @return $this
     */
    public function setName($name)
    {
        $this->addGeneratorProperty('name', (string) $name, false);

        return $this;
    }

    /**
     * @param string $namespace
     * @return $this
     */
    public function setNamespace($namespace)
    {
        $this->addGeneratorProperty('namespace', (string) $namespace, false);

        return $this;
    }

    /**
     * @throws InvalidArgumentException|RuntimeException
     * @return string
     * @todo implement exception throwing if mandatory parameter is missing
     * @todo decouple/move fitting areas to ClassGenerator and InterfaceGenerator
     */
    public function generate()
    {
        if ($this->canBeGenerated()) {
            $this->executePregenertionHook();
            $this->addEmptyLine = false;
            $this->resetContent();
            $this->generateNamespace();
            $this->generateUse();
            $this->generateDocumentation();
            $this->generateSignature();
            $this->generateBody();
        }

        return $this->generateStringFromContent();
    }

    protected function executePregenertionHook() {}

    private function generateBody()
    {
        $this->addEmptyLine = false;
        $this->addContent('{');
        /** @var null|ConstantGenerator[] $constants */
        $constants = $this->getGeneratorProperty('constants');
        /** @var null|MethodGenerator[] $methods */
        $methods = $this->getGeneratorProperty('methods');
        /** @var null|PropertyGenerator[] $properties */
        $properties = $this->getGeneratorProperty('properties');
        /** @var null|array $traits */
        $traits = $this->getGeneratorProperty('traits');

        if (is_array($traits)) {
            $this->addContent('use ' . implode(',', $traits) . ';', true);
            $this->addEmptyLine = true;
        }
        if (is_array($constants)) {
            if ($this->addEmptyLine) {
                $this->addContent('');
            }
            $lastArrayKey = $this->getLastArrayKey($constants);
            foreach($constants as $key => $constant) {
                $this->addGeneratorAsContent($constant, true);
                if ($key !== $lastArrayKey) {
                    $this->addContent('');
                }
            }
            $this->addEmptyLine = true;
        }
        if (is_array($properties)) {
            if ($this->addEmptyLine) {
                $this->addContent('');
            }
            $lastArrayKey = $this->getLastArrayKey($properties);
            foreach($properties as $key => $property) {
                $this->addGeneratorAsContent($property, true);
                if ($key !== $lastArrayKey) {
                    $this->addContent('');
                }
            }
            $this->addEmptyLine = true;
        }
        if (is_array($methods)) {
            if ($this->addEmptyLine) {
                $this->addContent('');
            }
            $lastArrayKey = $this->getLastArrayKey($methods);
            foreach($methods as $key => $method) {
                $this->addGeneratorAsContent($method, true);
                if ($key !== $lastArrayKey) {
                    $this->addContent('');
                }
            }
        }

        $this->addContent('}');
        $this->addEmptyLine = false;
    }

    private function generateNamespace()
    {
        $namespace = $this->getGeneratorProperty('namespace');

        if (!is_null($namespace)) {
            $this->addContent(
                $this->getLineGenerator(
                    'namespace ' . $namespace . ';'
                )
            );
            $this->addEmptyLine = true;
        }
    }

    private function generateDocumentation()
    {
        $documentation = $this->getGeneratorProperty('documentation');

        if ($documentation instanceof DocumentationGenerator) {
            if ($this->completeDocumentationAutomatically) {
                $isInterface    = $this->getGeneratorProperty('interface', false);
                $name           = $this->getGeneratorProperty('name');
                $namespace      = $this->getGeneratorProperty('namespace');

                if (is_string($name)) {
                    //@todo decouple/move fitting areas to ClassGenerator and InterfaceGenerator
                    if ($isInterface) {
                        $documentation->setInterface($name);
                    } else {
                        $documentation->setClass($name);
                    }
                }
                if (is_string($namespace)) {
                    $documentation->setPackage($namespace);
                }
            }
            if ($documentation->hasContent()) {
                if ($this->addEmptyLine) {
                    $this->addContent('');
                    $this->addEmptyLine = false;
                }
                $this->addGeneratorAsContent($documentation);
            }
        }
    }

    /**
     * @throws \Net\Bazzline\Component\CodeGenerator\RuntimeException
     */
    private function generateSignature()
    {
        $isAbstract     = $this->getGeneratorProperty('abstract', false);
        $isInterface    = $this->getGeneratorProperty('interface', false);
        $isFinal        = $this->getGeneratorProperty('final', false);
        $extends        = $this->getGeneratorProperty('extends');
        $implements     = $this->getGeneratorProperty('implements');
        $name           = $this->getGeneratorProperty('name');

        if (is_null($name)) {
            throw new RuntimeException('name is mandatory');
        }

        if ($this->addEmptyLine) {
            $this->addContent('');
            $this->addEmptyLine = false;
        }

        $line = $this->getLineGenerator();
        if ($isAbstract) {
            $line->add('abstract');
        } else if ($isInterface) {
            $line->add('interface');
        } else if ($isFinal) {
            $line->add('final');
        }

        //@todo decouple/move fitting areas to ClassGenerator and InterfaceGenerator
        if ($isInterface) {
            $line->add($name);

            if (is_array($extends)) {
                $line->add('extends');
                $line->add(implode(', ', $extends));
            }
        } else {
            $line->add('class ' . $name);

            if (is_string($extends)) {
                $line->add('extends');
                $line->add($extends);
            }
        }

        if (is_array($implements)) {
            $line->add('implements');
            $line->add(implode(', ', $implements));
        }

        $this->addContent($line);
        $this->addEmptyLine = true;
    }

    private function generateUse()
    {
        $uses = $this->getGeneratorProperty('uses');

        if (is_array($uses)) {
            if ($this->addEmptyLine) {
                $this->addContent('');
                $this->addEmptyLine = false;
            }
            foreach ($uses as $use) {
                $line = $this->getLineGenerator();
                if (strlen($use['alias']) > 0) {
                    $line->add('use ' . $use['name'] . ' as ' . $use['alias'] . ';');
                } else {
                    $line->add('use ' . $use['name'] . ';');
                }
                $this->addContent($line);
            }
            $this->addEmptyLine = true;
        }
    }
}