PHP code example of type-lang / phpdoc

    
        
<?php
require_once('vendor/autoload.php');

/* Start to develop here. Best regards https://php-download.com/ */

    

type-lang / phpdoc example snippets

$parser = new \TypeLang\PHPDoc\Parser();
$result = $parser->parse(<<<'PHPDOC'
    /**
     * Example description {@see some} and blah-blah-blah.
     *
     * @Example\Annotation("foo")
     * @return array<non-empty-string, TypeStatement>
     * @throws \Throwable
     */
    PHPDOC);

var_dump($result);

TypeLang\PHPDoc\DocBlock\DocBlock {
  +description: TypeLang\PHPDoc\DocBlock\Description\TaggedDescription {
    +components: array:3 [
      0 => TypeLang\PHPDoc\DocBlock\Description\Description {
        #value: "Example description "
      }
      1 => TypeLang\PHPDoc\DocBlock\Tag\SeeTag\SeeTag {
        +description: null
        +name: "see"
        +ref: TypeLang\PHPDoc\DocBlock\Tag\Shared\Reference\TypeSymbolReference {
          +type: TypeLang\Parser\Node\Stmt\NamedTypeNode { … }
        }
      }
      2 => TypeLang\PHPDoc\DocBlock\Description\Description {
        #value: " and blah-blah-blah.\n"
      }
    ]
  }
  +tags: array:3 [
    0 => TypeLang\PHPDoc\DocBlock\Tag\Tag {
      +description: TypeLang\PHPDoc\DocBlock\Description\Description {
        #value: "("foo")\n"
      }
      +name: "Example\Annotation"
    }
    1 => TypeLang\PHPDoc\DocBlock\Tag\ReturnTag\ReturnTag {
      +description: null
      +name: "return"
      +type: TypeLang\Parser\Node\Stmt\NamedTypeNode { … }
    }
    2 => TypeLang\PHPDoc\DocBlock\Tag\ThrowsTag\ThrowsTag {
      +description: null
      +name: "throws"
      +type: TypeLang\Parser\Node\Stmt\NamedTypeNode { … }
    }
  ]
}

/**                                 |
 * Hello world                      | ← DocBlock's description.
 *                                  |
 * @param int $example              | ← DocBlock's tag #1.
 * @throws \Throwable Description   | ← DocBlock's tag #2.
 */                                 |

/**
 * DocBlock structure pseudocode (real impl may differ)
 * 
 * @template-implements \Traversable<array-key, Tag>
 * @template-implements \ArrayAccess<array-key, Tag>
 */
class DocBlock
{
    public ?Description $description { get; }

    public iterable<array-key, Tag> $tags { get; }
}

/**
               ↓↓↓↓↓↓↓↓↓↓↓                         | ← This is a nested tag of the description.
 * Hello world {@see some} and blah-blah-blah.     |
   ↑↑↑↑↑↑↑↑↑↑↑             ↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑     | ← This is part of the template.
 */

/**
 * Simple description structure pseudocode (real impl may differ)
 */
class Description implements \Stringable {}

/**
 * Tagged (composite) description structure pseudocode (real impl may differ)
 * 
 * @template-implements \Traversable<array-key, Tag>
 * @template-implements \ArrayAccess<array-key, Tag>
 */
class TaggedDescription extends Description implements 
    \Traversable, 
    \ArrayAccess,
    \Countable
{
    public iterable<array-key, Tag> $tags { get; }
    
    public iterable<array-key, Tag|Description> $components { get; }
}

/**
    ↓↓↓↓↓↓                                 | ← This is a tag name.
 * @throws \Throwable An error occurred.   |
           ↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑   | ← This is tag description.
 */

/**
 * Common tag structure pseudocode (real impl may differ)
 */
class Tag implements \Stringable
{
    public non-empty-string $name { get; }

    public ?Description $description { get; }
}

/**
 * Throws tag structure pseudocode (real impl may differ)
 */
class ThrowsTag extends Tag
{
    public TypeStatement $type;
}