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: 290: 291: 292: 293: 294: 295: 296: 297: 298: 299: 300: 301: 302: 303: 304: 305: 306: 307: 308: 309: 310: 311: 312: 313: 314: 315: 316: 317: 318: 319: 320: 321: 322: 323: 324: 325: 326: 327: 328: 329: 330: 331: 332: 333: 334: 335: 336: 337: 338: 339: 340: 341: 342: 343: 344: 345: 346: 347: 348: 349: 350: 351: 352: 353: 354: 355: 356: 357: 358: 359: 360: 361: 362: 363: 364: 365: 366: 367: 368: 369: 370: 371: 372: 373: 374: 375: 376: 377: 378: 379: 380: 381: 382: 383: 384: 385: 386: 387: 388: 389: 390: 391: 392: 393: 394: 395: 396: 397: 398: 399: 400: 401: 402: 403: 404: 405: 406: 407: 408: 409: 410: 411: 412: 413: 414: 415: 416: 417: 418: 419: 420: 421: 422: 423: 424: 425: 426: 427: 428: 429: 430: 431: 432:
<?php
namespace Net\Bazzline\Component\CodeGenerator;
class DocumentationGenerator extends AbstractGenerator
{
private $addEmptyLine;
public function addComment($comment)
{
$this->addGeneratorProperty('comments', (string) $comment, true);
return $this;
}
public function setClass($className)
{
$this->addGeneratorProperty('class', (string) $className, false);
return $this;
}
public function setInterface($interfaceName)
{
$this->addGeneratorProperty('interface', (string) $interfaceName, false);
return $this;
}
public function setPackage($package)
{
$this->addGeneratorProperty('package', (string) $package, false);
return $this;
}
public function addParameter($name, $typeHints = [], $comment = '')
{
$parameter = [
'comment' => (string) $comment,
'name' => (string) $name,
'type_hints' => (array) $typeHints
];
$this->addGeneratorProperty('parameters', $parameter);
return $this;
}
public function setReturn($typeHints, $comment = '')
{
$return = [
'comment' => (string) $comment,
'type_hints' => (array) $typeHints
];
$this->addGeneratorProperty('return', $return, false);
return $this;
}
public function addSee($see)
{
$this->addGeneratorProperty('sees', (string) $see);
return $this;
}
public function addThrows($exception)
{
$this->addGeneratorProperty('throws', (string) $exception);
return $this;
}
public function addTodoS($toDo)
{
$this->addGeneratorProperty('todos', (string) $toDo);
return $this;
}
public function setAuthor($name, $email = '')
{
$author = [
'email' => (string) $email,
'name' => (string) $name
];
$this->addGeneratorProperty('author', $author, false);
return $this;
}
public function setVariable($name, $typeHints = [])
{
$variable = [
'name' => $name,
'type_hints' => $typeHints
];
$this->addGeneratorProperty('variable', $variable, false);
return $this;
}
public function setVersion($number, $description = '')
{
$version = [
'description' => (string) $description,
'number' => (string) $number
];
$this->addGeneratorProperty('version', $version, false);
return $this;
}
public function generate()
{
if ($this->canBeGenerated()) {
$this->addEmptyLine = false;
$this->resetContent();
$this->addContent('/**');
$this->generateSees();
$this->generateComments();
$this->generateInterface();
$this->generateClass();
$this->generatePackage();
$this->generateToDoS();
$this->generateParameters();
$this->generateReturn();
$this->generateThrows();
$this->generateVariable();
$this->generateAuthor();
$this->generateVersion();
$this->addContent(' */');
}
return $this->generateStringFromContent();
}
private function generateAuthor()
{
$author = $this->getGeneratorProperty('author');
if (is_array($author)) {
if ($this->addEmptyLine) {
$this->addContent(' *');
$this->addEmptyLine = false;
}
$line = $this->getLineGenerator(' * @author ' . $author['name']);
if (strlen($author['email']) > 0) {
$line->add('<' . $author['email'] . '>');
}
$this->addContent($line);
}
}
private function generateClass()
{
$class = $this->getGeneratorProperty('class');
if (is_string($class)) {
if ($this->addEmptyLine) {
$this->addContent(' *');
$this->addEmptyLine = false;
}
$line = $this->getLineGenerator(' * Class ' . $class);
$this->addContent($line);
$this->addEmptyLine = true;
}
}
private function generateInterface()
{
$interface = $this->getGeneratorProperty('interface');
if (is_string($interface)) {
if ($this->addEmptyLine) {
$this->addContent(' *');
$this->addEmptyLine = false;
}
$line = $this->getLineGenerator(' * Interface ' . $interface);
$this->addContent($line);
$this->addEmptyLine = true;
}
}
private function generatePackage()
{
$package = $this->getGeneratorProperty('package');
if (is_string($package)) {
if ($this->addEmptyLine) {
$this->addContent(' *');
$this->addEmptyLine = false;
}
$line = $this->getLineGenerator(' * @package ' . $package);
$this->addContent($line);
}
}
private function generateComments()
{
$comments = $this->getGeneratorProperty('comments');
if (is_array($comments)) {
if ($this->addEmptyLine) {
$this->addContent(' *');
$this->addEmptyLine = false;
}
foreach ($comments as $comment) {
$line = $this->getLineGenerator(' * ' . $comment);
$this->addContent($line);
}
}
}
private function generateParameters()
{
$parameters = $this->getGeneratorProperty('parameters');
if (is_array($parameters)) {
if ($this->addEmptyLine) {
$this->addContent(' *');
$this->addEmptyLine = false;
}
foreach ($parameters as $parameter) {
$line = $this->getLineGenerator(' * @param');
if (!empty($parameter['type_hints'])) {
$line->add(implode('|', $parameter['type_hints']));
}
$line->add('$' . $parameter['name']);
if (strlen($parameter['comment']) > 0) {
$line->add($parameter['comment']);
}
$this->addContent($line);
}
}
}
private function generateReturn()
{
$return = $this->getGeneratorProperty('return');
if (is_array($return)) {
if ($this->addEmptyLine) {
$this->addContent(' *');
$this->addEmptyLine = false;
}
$line = $this->getLineGenerator(' * @return');
if (!empty($return['type_hints'])) {
$line->add(implode('|', $return['type_hints']));
}
if (strlen($return['comment']) > 0) {
$line->add($return['comment']);
}
$this->addContent($line);
}
}
private function generateSees()
{
$sees = $this->getGeneratorProperty('sees');
if (is_array($sees)) {
if ($this->addEmptyLine) {
$this->addContent(' *');
$this->addEmptyLine = false;
}
foreach ($sees as $see) {
$line = $this->getLineGenerator(' * @see ' . $see);
$this->addContent($line);
}
}
}
private function generateThrows()
{
$throws = $this->getGeneratorProperty('throws');
if (is_array($throws)) {
if ($this->addEmptyLine) {
$this->addContent(' *');
$this->addEmptyLine = false;
}
$line = $this->getLineGenerator(' * @throws ' . implode('|', $throws));
$this->addContent($line);
}
}
private function generateToDoS()
{
$todos = $this->getGeneratorProperty('todos');
if (is_array($todos)) {
if ($this->addEmptyLine) {
$this->addContent(' *');
$this->addEmptyLine = false;
}
foreach ($todos as $todo) {
$line = $this->getLineGenerator(' * @todo ' . $todo);
$this->addContent($line);
}
}
}
private function generateVariable()
{
$variable = $this->getGeneratorProperty('variable');
if (is_array($variable)) {
if ($this->addEmptyLine) {
$this->addContent(' *');
$this->addEmptyLine = false;
}
$line = $this->getLineGenerator(' * @var');
if (!empty($variable['type_hints'])) {
$line->add(implode('|', $variable['type_hints']));
}
$line->add('$' . $variable['name']);
$this->addContent($line);
}
}
private function generateVersion()
{
$version = $this->getGeneratorProperty('version');
if (is_array($version)) {
if ($this->addEmptyLine) {
$this->addContent(' *');
$this->addEmptyLine = false;
}
$line = $this->getLineGenerator(' * @version ' . $version['number']);
if (strlen($version['description']) > 0) {
$line->add($version['description']);
}
$this->addContent($line);
}
}
}