PHP Class phpDocumentor\Reflection\DocBlock\Tag\ExampleTag

See link: http://phpdoc.org

Author: Vasil Rangelov ([email protected])

Inheritance: extends phpDocumentor\Reflection\DocBlock\Tag\SourceTag

Datei anzeigen Open project: explodybits/hookr-plugin Class Usage Examples

Protected Properties

Property	Type	Description
$filePath		Path to a file to use as an example. May also be an absolute URI.
$isURI		Whether the file path component represents an URI. This determines how the file portion appears at {@link getContent()}.

Public Methods

Method	Description
getContent ( )
getFilePath ( ) : string	Returns the file path.
setContent ( $content )
setFilePath ( string $filePath )	Sets the file path.
setFileURI ( type $uri )	Sets the file path as an URI.

Method Details

getContent() public method

public getContent ( )

getFilePath() public method

Returns the file path.

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

setContent() public method

public setContent ( $content )

setFilePath() public method

Sets the file path.

public setFilePath ( string $filePath )
$filePath	string	The new file path to use for the example.

setFileURI() public method

This function is equivalent to {@link setFilePath()}, except that it convers an URI to a file path before that. There is no getFileURI(), as {@link getFilePath()} is compatible.

public setFileURI ( type $uri )
$uri	type	The new file URI to use as an example.

Property Details

$filePath protected_oe property

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

protected $filePath

$isURI protected_oe property

Whether the file path component represents an URI. This determines how the file portion appears at {@link getContent()}.

protected $isURI