PHP Class Carew\Document

Show file Open project: carew/carew Class Usage Examples

Public Methods

Method Description
__construct ( Symfony\Component\Finder\SplFileInfo $file = null, $filePath = null, $type = self::TYPE_UNKNOWN )
__toString ( )
addMetadatas ( array $metadatas )
getBody ( )
getBodyDecorated ( )
getFile ( )
getFilePath ( )
getLayout ( )
getMetadata ( $key, $default = null )
getMetadatas ( )
getNavigations ( )
getPath ( )
getRootPath ( )
getTags ( )
getTitle ( )
getToc ( )
getType ( )
getVar ( $key, $default = null )
getVars ( )
isPublished ( )
isTypeApi ( )
isTypePage ( )
isTypePost ( )
setBody ( $body )
setBodyDecorated ( $bodyDecorated )
setFilePath ( $filePath )
setLayout ( $layout )
setMetadata ( $key, $value )
setNavigations ( $navigations )
setPath ( $path )
setPublished ( $published )
setTags ( $tags )
setTitle ( $title )
setToc ( $toc )
setVar ( $key, $value )
setVars ( $vars )

Method Details

__construct() public method

public __construct ( Symfony\Component\Finder\SplFileInfo $file = null, $filePath = null, $type = self::TYPE_UNKNOWN )
$file Symfony\Component\Finder\SplFileInfo

__toString() public method

public __toString ( )

addMetadatas() public method

public addMetadatas ( array $metadatas )
$metadatas array

getBody() public method

public getBody ( )

getBodyDecorated() public method

public getBodyDecorated ( )

getFile() public method

public getFile ( )

getFilePath() public method

public getFilePath ( )

getLayout() public method

public getLayout ( )

getMetadata() public method

public getMetadata ( $key, $default = null )

getMetadatas() public method

public getMetadatas ( )

getNavigations() public method

public getNavigations ( )

getPath() public method

public getPath ( )

getRootPath() public method

public getRootPath ( )

getTags() public method

public getTags ( )

getTitle() public method

public getTitle ( )

getToc() public method

public getToc ( )

getType() public method

public getType ( )

getVar() public method

public getVar ( $key, $default = null )

getVars() public method

public getVars ( )

isPublished() public method

public isPublished ( )

isTypeApi() public method

public isTypeApi ( )

isTypePage() public method

public isTypePage ( )

isTypePost() public method

public isTypePost ( )

setBody() public method

public setBody ( $body )

setBodyDecorated() public method

public setBodyDecorated ( $bodyDecorated )

setFilePath() public method

public setFilePath ( $filePath )

setLayout() public method

public setLayout ( $layout )

setMetadata() public method

public setMetadata ( $key, $value )

setNavigations() public method

public setNavigations ( $navigations )

setPath() public method

public setPath ( $path )

setPublished() public method

public setPublished ( $published )

setTags() public method

public setTags ( $tags )

setTitle() public method

public setTitle ( $title )

setToc() public method

public setToc ( $toc )

setVar() public method

public setVar ( $key, $value )

setVars() public method

public setVars ( $vars )