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

namespace Net\Bazzline\Component\CodeGenerator;

/**
 * Class TraitGenerator
 * @package Net\Bazzline\Component\Locator\LocatorGenerator\Generator
 */
class TraitGenerator extends AbstractDocumentedGenerator
{
    /**
     * @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 MethodGenerator $method
     * @return $this
     */
    public function addMethod(MethodGenerator $method)
    {
        $this->addGeneratorProperty('methods', $method);

        return $this;
    }

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

        return $this;
    }

    /**
     * @return null|string
     */
    public function getName()
    {
        return $this->getGeneratorProperty('name');
    }

    /**
     * @throws InvalidArgumentException|RuntimeException
     * @return string
     * @todo implement exception throwing if mandatory parameter is missing
     */
    public function generate()
    {
        if ($this->canBeGenerated()) {
            if (is_null($this->getGeneratorProperty('name'))) {
                throw new RuntimeException('name is mandatory');
            }

            $this->resetContent();
            $this->generateDocumentation();
            $this->generateSignature();
            $this->generateBody();
        }

        return $this->generateStringFromContent();
    }

    private function generateBody()
    {
        $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');

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

        $this->addContent('}');
    }

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

        if ($documentation instanceof DocumentationGenerator) {
            if ($this->completeDocumentationAutomatically === true) {
                $name = $this->getGeneratorProperty('name');

                if (is_string($name)) {
                    $documentation->setClass($name);
                }
            }
            $this->addGeneratorAsContent($documentation);
        }
    }

    /**
     * @throws \Net\Bazzline\Component\CodeGenerator\RuntimeException
     */
    private function generateSignature()
    {
        $name = $this->getGeneratorProperty('name');

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

        $line = $this->getLineGenerator('trait ' . $name);
        $this->addContent($line);
    }
}
PHP Code Generator Component by bazzline.net API documentation generated by ApiGen