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: 

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

namespace Net\Bazzline\Component\CodeGenerator;

use Net\Bazzline\Component\CodeGenerator\InvalidArgumentException;
use Net\Bazzline\Component\CodeGenerator\RuntimeException;

/**
 * Class PropertyGenerator
 * @package Net\Bazzline\Component\Locator\LocatorGenerator\Generator
 */
class PropertyGenerator extends AbstractDocumentedGenerator
{
    /**
     * @param string $typeHint
     * @return $this
     */
    public function addTypeHint($typeHint)
    {
        $this->addGeneratorProperty('type_hints', (string) $typeHint);

        return $this;
    }

    /**
     * @return $this
     */
    public function markAsPrivate()
    {
        $this->addGeneratorProperty('visibility', 'private', false);

        return $this;
    }

    /**
     * @return $this
     */
    public function markAsProtected()
    {
        $this->addGeneratorProperty('visibility', 'protected', false);

        return $this;
    }

    /**
     * @return $this
     */
    public function markAsPublic()
    {
        $this->addGeneratorProperty('visibility', 'public', false);

        return $this;
    }

    /**
     * @return $this
     */
    public function markAsStatic()
    {
        $this->addGeneratorProperty('static', true, false);

        return $this;
    }

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

        return $this;
    }

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

        return $this;
    }

    /**
     * @throws InvalidArgumentException|RuntimeException
     * @return string
     * @todo implement exception throwing if mandatory parameter is missing
     */
    public function generate()
    {
        $this->resetContent();
        $documentation  = $this->getGeneratorProperty('documentation');
        $isStatic       = $this->getGeneratorProperty('static', false);
        $name           = $this->getGeneratorProperty('name');
        $typeHints      = $this->getGeneratorProperty('type_hints', []);
        $value          = $this->getGeneratorProperty('value');
        $visibility     = $this->getGeneratorProperty('visibility');

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

        $block = $this->getBlockGenerator();
        $line = $this->getLineGenerator();

        if ($documentation instanceof DocumentationGenerator) {
            if ($this->completeDocumentationAutomatically === true) {
                $documentation->setVariable($name, $typeHints);
            }
            $block->add(explode(PHP_EOL, $documentation->generate()));
        }

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

        if ($isStatic) {
            $line->add('static');
        }
        if (!is_null($value)) {
            $line->add('$' . $name . ' = ' . $value . ';');
        } else {
            $line->add('$' . $name . ';');
        }
        $block->add($line);
        $this->addContent($block);

        return $this->generateStringFromContent();
    }
}