Reflection class for a {@}example tag in a Docblock.

CloneableFinalInstantiable
ExtendsphpDocumentor\Reflection\DocBlock\Tags\BaseTag
ImplementsphpDocumentor\Reflection\DocBlock\Tag
phpDocumentor\Reflection\DocBlock\Tags\Factory\StaticMethod
Methods
public __construct( $filePath, $isURI, $startingLine, $lineCount, $description)
public __toString()
 
Returns a string representation for this tag.

  • return string
public static create( $body)
 


    public getContent()
     


      public phpDocumentor\Reflection\DocBlock\Tags\BaseTag::getDescription()
      public getFilePath()
       
      Returns the file path.

      • return string Path to a file to use as an example. May also be an absolute URI.
      public getLineCount()
       


      • return int
      public phpDocumentor\Reflection\DocBlock\Tags\BaseTag::getName()
       
      Gets the name of this tag.

      • return string The name of this tag.
      public getStartingLine()
       


      • return int
      public phpDocumentor\Reflection\DocBlock\Tags\BaseTag::render(?phpDocumentor\Reflection\DocBlock\Tags\Formatter $formatter = NULL)
      Properties
      protected phpDocumentor\Reflection\DocBlock\Tags\BaseTag::$description
       


      • var Description|null Description of the tag.
      protected phpDocumentor\Reflection\DocBlock\Tags\BaseTag::$name
       


      • var string Name of the tag
      Properties
      private $filePath
       


      • var string Path to a file to use as an example. May also be an absolute URI.
      private $isURI
       


      • var bool Whether the file path component represents an URI. This determines how the file portion appears at {@link getContent()}.
      private $lineCount
       


      • var int
      private $startingLine
       


      • var int
      Methods
      private isUriRelative( $uri)
       
      Returns true if the provided URI is relative or contains a complete scheme (and thus is absolute).

      • return bool
      Methods
      public static create( $body)
       


        © 2020 Bruce Wells
        Search Namespaces \ Classes
        ConfigurationNumbers (0-9.) only