PHP Class Phrozn\Site\Base

Author: Victor Farazdagi
Inheritance: implements Phrozn\Site
Datei anzeigen Open project: farazdagi/phrozn

Public Methods

Method Description
__construct ( string $inputDir = null, string $outputDir = null, array $config = null ) : void Initialize site object
getInputDir ( ) : string Get input directory path
getOutputDir ( ) : string Get output directory path
getOutputter ( ) : Phrozn\Outputter Get outputter instance
getQueue ( ) : array Return list of queued views ready to be processed
getSiteConfig ( ) : array Get site configuration
setInputDir ( string $path ) : Phrozn\Site Set input directory path
setOutputDir ( string $path ) : Phrozn\Site Set output directory path
setOutputter ( Phrozn\Outputter $outputter ) : Phrozn\Site Set outputter
setSiteConfig ( array $config ) : Phrozn\Has\SiteConfig Set site configuration

Protected Methods

Method Description
addView ( $view ) : Phrozn\Site Adds view to the list of queued views
buildQueue ( ) : Phrozn\Site Create list of views to be created
getProjectDir ( ) : string Guess directory with Phrozn project using input directory

Method Details

__construct() public method

Initialize site object
public __construct ( string $inputDir = null, string $outputDir = null, array $config = null ) : void
$inputDir string Input directory path
$outputDir string Output directory path
$config array Configuration options with which site generation should run
return void

addView() protected method

Adds view to the list of queued views
protected addView ( $view ) : Phrozn\Site
return Phrozn\Site

buildQueue() protected method

Create list of views to be created
protected buildQueue ( ) : Phrozn\Site
return Phrozn\Site

getInputDir() public method

Get input directory path
public getInputDir ( ) : string
return string

getOutputDir() public method

Get output directory path
public getOutputDir ( ) : string
return string

getOutputter() public method

Get outputter instance
public getOutputter ( ) : Phrozn\Outputter
return Phrozn\Outputter

getProjectDir() protected method

Guess directory with Phrozn project using input directory
protected getProjectDir ( ) : string
return string

getQueue() public method

Return list of queued views ready to be processed
public getQueue ( ) : array
return array

getSiteConfig() public method

Get site configuration
public getSiteConfig ( ) : array
return array

setInputDir() public method

Set input directory path
public setInputDir ( string $path ) : Phrozn\Site
$path string Directory path
return Phrozn\Site

setOutputDir() public method

Set output directory path
public setOutputDir ( string $path ) : Phrozn\Site
$path string Directory path
return Phrozn\Site

setOutputter() public method

Set outputter
public setOutputter ( Phrozn\Outputter $outputter ) : Phrozn\Site
$outputter Phrozn\Outputter Outputter instance
return Phrozn\Site

setSiteConfig() public method

Set site configuration
public setSiteConfig ( array $config ) : Phrozn\Has\SiteConfig
$config array Array of options
return Phrozn\Has\SiteConfig