PhpStorm. LiveTemlate. Generate comments for ENUM

readme.md

Add DocBlock for the class when using myclabs/php-enum library. Sippet for PHPStorm

Snippet to fast create docblock for enum using library https://github.com/myclabs/php-enum.

1. PHPStorm > Settings > Editor > Live Templates
2. Add new snippet
3. Abbreviation: cEnumDocBlock
4. Description: Create ENUM docblock
5. Template Text:

/**
$CLASS_NAME$
 */$END$

6. Edit variables
7. Expression: groovyScript("File inputFile = new File(_1);LineNumberReader reader = inputFile.newReader(); def somValue = ''; while ((line = reader.readLine()) != null) { def cleanLine = line.trim(); def m = cleanLine =~ /private const\\\s(.*)\\\s=/; if (m.size() > 0) { somValue = somValue + ' * @method static ' + _2 + ' ' + m[0][1] + '''()\n'''; }; }; return somValue + '';", filePath(), phpClassName())

enumMethods.groovy

File inputFile = new File(_1);LineNumberReader reader = inputFile.newReader();
def outputLine = '';
while ((line = reader.readLine()) != null) {
    def cleanLine = line.trim();
    def m = cleanLine =~ /private const\\\s(.*)\\\s=/;
    if (m.size() > 0) {
        outputLine = outputLine + ' * @method static ' + _2 + ' ' + m[0][1] + '''()\n''';
    };
};
return outputLine + '';