<?php

namespace DrupalCodeBuilder\Generator;

use MutableTypedData\Definition\PropertyListInterface;

use DrupalCodeBuilder\Definition\PropertyDefinition;

use DrupalCodeBuilder\Generator\Render\DocBlock;

/**

* Generator for PHP class files that define a class annotation.

*/

class AnnotationClass extends PHPClassFile {

/**

* {@inheritdoc}

*/

public static function addToGeneratorDefinition(PropertyListInterface $definition) {

parent::addToGeneratorDefinition($definition);

$definition->addProperties([

// TODO: this is specific to plugins.

'plugin_relative_namespace' => PropertyDefinition::create('string')

->setAutoAcquiredFromRequester(),

]);

}

/**

* {@inheritdoc}

*/

protected function getClassDocBlock(): DocBlock {

$docblock = parent::getClassDocBlock();

$docblock->Annotation();

return $docblock;

}

/**

* {@inheritdoc}

*/

protected function collectSectionBlocks() {

// Set up properties.

// TODO: these properties are only for plugin annotations, but so far

// nothing else uses this generator.

$this->properties[] = $this->createPropertyBlock(

'id',

'string',

[

'docblock_first_line' => 'The plugin ID.',

'prefixes' => ['public'],

]

);

$this->properties[] = $this->createPropertyBlock(

'label',

'\Drupal\Core\Annotation\Translation',

[

'docblock_first_line' => 'The human-readable name of the plugin.',

'prefixes' => ['public'],

]

/*

// TODO: needs:

'@ingroup plugin_translatable',

*/

);

}

}