Menu

## Example
in package
implements Tag, StaticMethod

Example.php : 29

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

### Interfaces, Classes and Traits

Tag
StaticMethod

### Table of Contents

$content : string|null
$filePath : string
$isURI : bool
$lineCount : int
$startingLine : int
__construct() : mixed
__toString() : string
  Returns a string representation for this tag.
create() : Tag|mixed
getContent() : string
getDescription() : string|null
getFilePath() : string
  Returns the file path.
getLineCount() : int
getName() : string
getStartingLine() : int
render() : string
isUriRelative() : bool
  Returns true if the provided URI is relative or contains a complete scheme (and thus is absolute).

### Properties

#### $content

Example.php : 47
`private string|null $content`

#### $filePath

Example.php : 32
`private string $filePath`

Path to a file to use as an example. May also be an absolute URI.

#### $isURI

Example.php : 38
`private bool $isURI`

Whether the file path component represents an URI. This determines how the file portion appears at .

#### $lineCount

Example.php : 44
`private int $lineCount`

#### $startingLine

Example.php : 41
`private int $startingLine`

### Methods

#### __construct()

Example.php : 49
`public __construct(string $filePath, bool $isURI, int $startingLine, int $lineCount, string|null $content) : mixed`

##### Parameters

$filePath : string
$isURI : bool
$startingLine : int
$lineCount : int
$content : string|null

##### Return values

mixed —

#### __toString()

Example.php : 149

Returns a string representation for this tag.

`public __toString() : string`

##### Return values

string —

#### create()

Example.php : 91
`public static create(string $body) : Tag|mixed`

##### Parameters

$body : string

##### Return values

Tag|mixed —

Class that implements Tag

#### getContent()

Example.php : 70
`public getContent() : string`

##### Return values

string —

#### getDescription()

Example.php : 86
`public getDescription() : string|null`

##### Return values

string|null —

#### getFilePath()

Example.php : 141

Returns the file path.

`public getFilePath() : string`

##### Return values

string —

Path to a file to use as an example. May also be an absolute URI.

#### getLineCount()

Example.php : 182
`public getLineCount() : int`

##### Return values

int —

#### getName()

Example.php : 187
`public getName() : string`

##### Return values

string —

#### getStartingLine()

Example.php : 177
`public getStartingLine() : int`

##### Return values

int —

#### render()

Example.php : 192
`public render([Formatter|null $formatter = null ]) : string`

##### Parameters

$formatter : Formatter|null = null

##### Return values

string —

#### isUriRelative()

Example.php : 172

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

`private isUriRelative(string $uri) : bool`

##### Parameters

$uri : string

##### Return values

bool —

## Search results