PHP Class Flintstone\Config

Show file Open project: fire015/flintstone Class Usage Examples

Protected Properties

Property Type Description
$config array Config.

Public Methods

Method Description
__construct ( array $config = [] ) Constructor.
getCache ( ) : Flintstone\Cache\CacheInterface | false Get the cache.
getDir ( ) : string Get the dir.
getExt ( ) : string Get the ext.
getFormatter ( ) : Flintstone\Formatter\FormatterInterface Get the formatter.
getSwapMemoryLimit ( ) : integer Get the swap memory limit.
setCache ( mixed $cache ) Set the cache.
setDir ( string $dir ) Set the dir.
setExt ( string $ext ) Set the ext.
setFormatter ( Flintstone\Formatter\FormatterInterface | null $formatter ) Set the formatter.
setGzip ( boolean $gzip ) Set gzip.
setSwapMemoryLimit ( integer $limit ) Set the swap memory limit.
useGzip ( ) : boolean Use gzip?

Protected Methods

Method Description
normalizeConfig ( array $config ) : array Normalize the user supplied config.

Method Details

__construct() public method

Constructor.
public __construct ( array $config = [] )
$config array

getCache() public method

Get the cache.
public getCache ( ) : Flintstone\Cache\CacheInterface | false
return Flintstone\Cache\CacheInterface | false

getDir() public method

Get the dir.
public getDir ( ) : string
return string

getExt() public method

Get the ext.
public getExt ( ) : string
return string

getFormatter() public method

Get the formatter.
public getFormatter ( ) : Flintstone\Formatter\FormatterInterface
return Flintstone\Formatter\FormatterInterface

getSwapMemoryLimit() public method

Get the swap memory limit.
public getSwapMemoryLimit ( ) : integer
return integer

normalizeConfig() protected method

Normalize the user supplied config.
protected normalizeConfig ( array $config ) : array
$config array
return array

setCache() public method

Set the cache.
public setCache ( mixed $cache )
$cache mixed

setDir() public method

Set the dir.
public setDir ( string $dir )
$dir string

setExt() public method

Set the ext.
public setExt ( string $ext )
$ext string

setFormatter() public method

Set the formatter.
public setFormatter ( Flintstone\Formatter\FormatterInterface | null $formatter )
$formatter Flintstone\Formatter\FormatterInterface | null

setGzip() public method

Set gzip.
public setGzip ( boolean $gzip )
$gzip boolean

setSwapMemoryLimit() public method

Set the swap memory limit.
public setSwapMemoryLimit ( integer $limit )
$limit integer

useGzip() public method

Use gzip?
public useGzip ( ) : boolean
return boolean

Property Details

$config protected property

Config.
protected array $config
return array