PHP Class AsseticBundle\Configuration

Show file Open project: widmogrod/zf2-assetic-module Class Usage Examples

Protected Properties

Property Type Description
$acceptableErrors array List of error types occurring in EVENT_DISPATCH_ERROR that will use this module to render assets.
$basePath string | null By default this value is set from "\Zend\Http\PhpEnvironment\Request::getBasePath()" Example: /~jdo/
$baseUrl string | null By default this value is set from "\Zend\Http\PhpEnvironment\Request::getBaseUrl()" Example: http://example.com/
$buildOnRequest boolean Should build assets on request.
$cacheEnabled boolean Is cache enabled.
$cachePath string Full path to cache directory.
$combine boolean Combine option giving the opportunity not to combine the assets in debug mode.
$controllers array Map of controllers names and assets configuration.
$debug boolean Debug option that is passed to Assetic.
$default array Default options.
$modules array Map of modules names and assets configuration.
$rendererToStrategy array Map of strategies that will be choose to setup Assetic\AssetInterface for particular Zend\View\Renderer\RendererInterface
$routes array Map of routes names and assets configuration.
$umask null | integer Umask
$webPath string Full path to public directory where assets will be generated.
$writeIfChanged boolean Asset will be save on disk, only when it's modification time was changed

Public Methods

Method Description
__construct ( $config = null )
addModule ( $name, array $options )
addRendererToStrategy ( $rendererClass, $strategyClass )
detectBaseUrl ( )
getAcceptableErrors ( )
getBasePath ( ) : null | string
getBaseUrl ( )
getBuildOnRequest ( ) : boolean
getCacheEnabled ( )
getCachePath ( )
getController ( $name, $default = null )
getControllers ( )
getDefault ( )
getModule ( $name, $default = null )
getModules ( )
getRoute ( $name, $default = null )
getRoutes ( )
getStrategyNameForRenderer ( $rendererName, $default = null )
getUmask ( ) : integer | null
getWebPath ( $file = null )
getWriteIfChanged ( ) : boolean
isCombine ( )
isDebug ( )
setAcceptableErrors ( array $acceptableErrors )
setBasePath ( null | string $basePath )
setBaseUrl ( $baseUrl )
setBuildOnRequest ( boolean $flag )
setCacheEnabled ( $cacheEnabled )
setCachePath ( $path )
setCombine ( $flag )
setControllers ( array $controllers )
setDebug ( $flag )
setDefault ( array $default )
setModules ( array $modules )
setRendererToStrategy ( array $strategyForRenderer )
setRoutes ( array $routes )
setUmask ( null | integer $umask )
setWebPath ( $path )
setWriteIfChanged ( boolean $flag )

Protected Methods

Method Description
assembleSetterNameFromConfigKey ( $key )
processArray ( $config )

Method Details

__construct() public method

public __construct ( $config = null )

addModule() public method

public addModule ( $name, array $options )
$options array

addRendererToStrategy() public method

public addRendererToStrategy ( $rendererClass, $strategyClass )

assembleSetterNameFromConfigKey() protected method

protected assembleSetterNameFromConfigKey ( $key )

detectBaseUrl() public method

public detectBaseUrl ( )

getAcceptableErrors() public method

public getAcceptableErrors ( )

getBasePath() public method

public getBasePath ( ) : null | string
return null | string

getBaseUrl() public method

public getBaseUrl ( )

getBuildOnRequest() public method

public getBuildOnRequest ( ) : boolean
return boolean

getCacheEnabled() public method

public getCacheEnabled ( )

getCachePath() public method

public getCachePath ( )

getController() public method

public getController ( $name, $default = null )

getControllers() public method

public getControllers ( )

getDefault() public method

public getDefault ( )

getModule() public method

public getModule ( $name, $default = null )

getModules() public method

public getModules ( )

getRoute() public method

public getRoute ( $name, $default = null )

getRoutes() public method

public getRoutes ( )

getStrategyNameForRenderer() public method

public getStrategyNameForRenderer ( $rendererName, $default = null )

getUmask() public method

public getUmask ( ) : integer | null
return integer | null

getWebPath() public method

public getWebPath ( $file = null )

getWriteIfChanged() public method

public getWriteIfChanged ( ) : boolean
return boolean

isCombine() public method

public isCombine ( )

isDebug() public method

public isDebug ( )

processArray() protected method

protected processArray ( $config )

setAcceptableErrors() public method

public setAcceptableErrors ( array $acceptableErrors )
$acceptableErrors array

setBasePath() public method

public setBasePath ( null | string $basePath )
$basePath null | string

setBaseUrl() public method

public setBaseUrl ( $baseUrl )

setBuildOnRequest() public method

public setBuildOnRequest ( boolean $flag )
$flag boolean

setCacheEnabled() public method

public setCacheEnabled ( $cacheEnabled )

setCachePath() public method

public setCachePath ( $path )

setCombine() public method

public setCombine ( $flag )

setControllers() public method

public setControllers ( array $controllers )
$controllers array

setDebug() public method

public setDebug ( $flag )

setDefault() public method

public setDefault ( array $default )
$default array

setModules() public method

public setModules ( array $modules )
$modules array

setRendererToStrategy() public method

public setRendererToStrategy ( array $strategyForRenderer )
$strategyForRenderer array

setRoutes() public method

public setRoutes ( array $routes )
$routes array

setUmask() public method

public setUmask ( null | integer $umask )
$umask null | integer

setWebPath() public method

public setWebPath ( $path )

setWriteIfChanged() public method

public setWriteIfChanged ( boolean $flag )
$flag boolean

Property Details

$acceptableErrors protected property

List of error types occurring in EVENT_DISPATCH_ERROR that will use this module to render assets.
protected array $acceptableErrors
return array

$basePath protected property

By default this value is set from "\Zend\Http\PhpEnvironment\Request::getBasePath()" Example: /~jdo/
protected string|null $basePath
return string | null

$baseUrl protected property

By default this value is set from "\Zend\Http\PhpEnvironment\Request::getBaseUrl()" Example: http://example.com/
protected string|null $baseUrl
return string | null

$buildOnRequest protected property

Should build assets on request.
protected bool $buildOnRequest
return boolean

$cacheEnabled protected property

Is cache enabled.
protected bool $cacheEnabled
return boolean

$cachePath protected property

Full path to cache directory.
protected string $cachePath
return string

$combine protected property

Combine option giving the opportunity not to combine the assets in debug mode.
protected bool $combine
return boolean

$controllers protected property

Map of controllers names and assets configuration.
protected array $controllers
return array

$debug protected property

Debug option that is passed to Assetic.
protected bool $debug
return boolean

$default protected property

Default options.
protected array $default
return array

$modules protected property

Map of modules names and assets configuration.
protected array $modules
return array

$rendererToStrategy protected property

Map of strategies that will be choose to setup Assetic\AssetInterface for particular Zend\View\Renderer\RendererInterface
protected array $rendererToStrategy
return array

$routes protected property

Map of routes names and assets configuration.
protected array $routes
return array

$umask protected property

Umask
protected null|int $umask
return null | integer

$webPath protected property

Full path to public directory where assets will be generated.
protected string $webPath
return string

$writeIfChanged protected property

Asset will be save on disk, only when it's modification time was changed
protected bool $writeIfChanged
return boolean