Overview

Namespaces

  • Charcoal
    • App
      • Action
      • Config
      • Handler
      • Middleware
      • Module
      • Route
      • Script
      • ServiceProvider
      • Template

Classes

  • CacheConfig
  • DatabaseConfig
  • FilesystemConfig
  • LoggerConfig
  • MemcacheCacheConfig
  • MemcacheCacheServerConfig
  • Overview
  • Namespace
  • Class

Class CacheConfig

Cache Configuration

Charcoal\Config\AbstractConfig
Extended by Charcoal\App\Config\CacheConfig
Namespace: Charcoal\App\Config
Located at Charcoal/App/Config/CacheConfig.php
Methods summary
public array
# defaults( )

Returns

array
public Charcoal\App\Config\CacheConfig
# setTypes( array $types )

Set the types (drivers) of cache.

Set the types (drivers) of cache.

The first cache actually available on the system will be the one used for caching.

Parameters

$types
The types of cache to try using, in order of priority.

Returns

Charcoal\App\Config\CacheConfig
Chainable
public array
# validTypes( )

Get the valid types (drivers).

Get the valid types (drivers).

Returns

array
public Charcoal\App\Config\CacheConfig
# addType( string $type )

Parameters

$type
The cache type.

Returns

Charcoal\App\Config\CacheConfig
Chainable

Throws

InvalidArgumentException
If the type is not a string.
public array
# types( )

Returns

array
public Charcoal\App\Config\CacheConfig
# setDefaultTtl( integer $ttl )

Parameters

$ttl
The time-to-live, in seconds.

Returns

Charcoal\App\Config\CacheConfig
Chainable

Throws

InvalidArgumentException
If the TTL argument is not numeric.
public integer
# defaultTtl( )

Returns

integer
public Charcoal\App\Config\CacheConfig
# setPrefix( string $prefix )

Parameters

$prefix
The cache prefix (or namespace).

Returns

Charcoal\App\Config\CacheConfig
Chainable

Throws

InvalidArgumentException
If the prefix is not a string.
public string
# prefix( )

Returns

string
public Charcoal\App\Config\CacheConfig
# setMiddleware( array $middleware )

Parameters

$middleware
The cache middleware configuration.

Returns

Charcoal\App\Config\CacheConfig
Chainable
public array
# middleware( )

Returns

array
Properties summary
public array $middleware
#
API documentation generated by ApiGen