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

CloneableFinalInstantiable
ImplementsphpDocumentor\Reflection\DocBlock\Tag
phpDocumentor\Reflection\DocBlock\Tags\Factory\StaticMethod
Methods
public __construct(string $filePath, bool $isURI, int $startingLine, int $lineCount, ?string $content)
public __toString() : string
 

Returns a string representation for this tag.

public static create(string $body) : phpDocumentor\Reflection\DocBlock\Tag
public getContent() : string
public getDescription() : string
public getFilePath() : string
 

Returns the file path.

  • return string Path to a file to use as an example. May also be an absolute URI.
public getLineCount() : int
public getName() : string
public getStartingLine() : int
public render(?phpDocumentor\Reflection\DocBlock\Tags\Formatter $formatter = NULL) : string
Properties
private $content
 
  • var string|null
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(string $uri) : bool
 

Returns true if the provided URI is relative or contains a complete scheme (and thus is absolute).

Methods
public static create(string $body) : phpDocumentor\Reflection\DocBlock\Tag
© 2020 Bruce Wells
Search Namespaces \ Classes
ConfigurationNumbers (0-9.) only