PHP Класс phpDocumentor\Reflection\DocBlock\Tag\ExampleTag

См. ссылку: http://phpdoc.org
Автор: Vasil Rangelov ([email protected])
Наследование: extends phpDocumentor\Reflection\DocBlock\Tag\SourceTag
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$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()}.

Открытые методы

Метод Описание
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.

Описание методов

getContent() публичный Метод

public getContent ( )

getFilePath() публичный Метод

Returns the file path.
public getFilePath ( ) : string
Результат string Path to a file to use as an example. May also be an absolute URI.

setContent() публичный Метод

public setContent ( $content )

setFilePath() публичный Метод

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

setFileURI() публичный Метод

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.

Описание свойств

$filePath защищенное свойство

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

$isURI защищенное свойство

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