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:
<?php
namespace Net\Bazzline\Component\CodeGenerator;
class MethodGenerator extends AbstractDocumentedGenerator
{
public function addParameter($name, $defaultValue = '', $typeHint = '', $isReference = false)
{
$parameter = [
'default_value' => $defaultValue,
'name' => $name,
'is_reference' => $isReference,
'type_hint' => $typeHint
];
$this->addGeneratorProperty('parameters', $parameter);
return $this;
}
public function addSince($version, $description = '')
{
$since = [
'description' => $description,
'version' => $version
];
$this->addGeneratorProperty('since_versions', $since);
return $this;
}
public function getBody()
{
return $this->getGeneratorProperty('body', null);
}
public function setBody($body, $returnValueTypeHints = [])
{
$this->addGeneratorProperty('body', $body, false);
$this->addGeneratorProperty('has_body', true, false);
$this->addGeneratorProperty('body_return_value_type_hints', $returnValueTypeHints, false);
return $this;
}
public function markAsAbstract()
{
$this->addGeneratorProperty('abstract', true, false);
return $this;
}
public function markAsHasNoBody()
{
$this->addGeneratorProperty('has_body', false, false);
return $this;
}
public function markAsFinal()
{
$this->addGeneratorProperty('final', true, false);
return $this;
}
public function markAsPrivate()
{
$this->addGeneratorProperty('visibility', 'private', false);
return $this;
}
public function markAsProtected()
{
$this->addGeneratorProperty('visibility', 'protected', false);
return $this;
}
public function markAsPublic()
{
$this->addGeneratorProperty('visibility', 'public', false);
return $this;
}
public function markAsStatic()
{
$this->addGeneratorProperty('static', true, false);
return $this;
}
public function setName($name)
{
$this->addGeneratorProperty('name', (string) $name, false);
return $this;
}
public function generate()
{
$this->resetContent();
$this->generateDocumentation();
$this->generateSignature();
$this->generateBody();
return $this->generateStringFromContent();
}
private function generateBody()
{
$body = $this->getGeneratorProperty('body', ['//@todo implement']);
$isAbstract = $this->getGeneratorProperty('abstract', false);
$hasBody = $this->getGeneratorProperty('has_body', true);
if (!$isAbstract
&& $hasBody) {
$this->addContent('{');
if (!($body instanceof BlockGenerator)
|| !($body instanceof LineGenerator)) {
if (!is_array($body)) {
$body = [
$body
];
}
$body = $this->getBlockGenerator($body);
}
$this->addGeneratorAsContent(
$body,
true
);
$this->addContent('}');
}
}
private function generateDocumentation()
{
$documentation = $this->getGeneratorProperty('documentation');
if ($documentation instanceof DocumentationGenerator) {
if ($this->completeDocumentationAutomatically === true) {
$parameters = $this->getGeneratorProperty('parameters', []);
$returnTypeHints = $this->getGeneratorProperty('body_return_value_type_hints');
foreach ($parameters as $parameter) {
$documentation->addParameter($parameter['name'], $parameter['type_hint']);
}
if (is_array($returnTypeHints)) {
$documentation->setReturn($returnTypeHints);
}
}
$this->addGeneratorAsContent($documentation);
}
}
private function generateSignature()
{
if ($this->canBeGenerated()) {
$hasBody = $this->getGeneratorProperty('has_body', true);
$isAbstract = $this->getGeneratorProperty('abstract', false);
$isFinal = $this->getGeneratorProperty('final', false);
$isStatic = $this->getGeneratorProperty('static', false);
$name = $this->getGeneratorProperty('name');
$parameters = $this->getGeneratorProperty('parameters', []);
$visibility = $this->getGeneratorProperty('visibility');
$line = $this->getLineGenerator();
if ($isAbstract) {
$line->add('abstract');
} else if ($isFinal) {
$line->add('final');
}
if (!is_null($visibility)) {
$line->add($visibility);
}
if ($isStatic) {
$line->add('static');
}
$parametersLine = $this->getLineGenerator();
$parametersLine->setSeparator(', ');
if (is_array($parameters)) {
foreach ($parameters as $parameter) {
$parameterLine = $this->getLineGenerator();
if ((strlen($parameter['type_hint']) > 0)
&& (!in_array($parameter['type_hint'], $this->getNotPrintableTypeHints()))) {
$parameterLine->add($parameter['type_hint']);
}
$parameterLine->add(($parameter['is_reference'] ? '&' : '') . '$' . $parameter['name']);
if (strlen((string) $parameter['default_value']) > 0) {
$parameterLine->add('= ' . (string) $parameter['default_value']);
}
$parametersLine->add($parameterLine);
}
}
$line->add('function ' . $name . '(' . $parametersLine->generate() . ')' . ((($isAbstract) || (!$hasBody)) ? ';' : ''));
$block = $this->getBlockGenerator($line);
$this->addContent($block);
}
}
}