abstract class ContentFilter (View source)

Conditionally executes a given callback, attempting to return the desired results of its execution.

Traits

Provides extensions to this object to integrate it with standard config API methods.

Config options

cache_lifetime int

Cache lifetime

Properties

protected ContentFilter $nestedContentFilter

Nested content filter

Methods

public static 
config()

Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).

public
mixed
stat(string $name) deprecated

Get inherited config value

public
mixed
uninherited(string $name)

Gets the uninherited value for the given config option

public
$this
set_stat(string $name, mixed $value) deprecated

Update the config value for a given property

public
__construct($nestedContentFilter = null)

No description

protected
CacheInterface
getCache()

Gets the cache to use

public
mixed
getContent(string $key, callable $callback)

Evaluates the result of the given callback

Details

static Config_ForClass config()

Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).

Return Value

Config_ForClass

mixed stat(string $name) deprecated

deprecated 5.0 Use ->config()->get() instead

Get inherited config value

Parameters

string $name

Return Value

mixed

mixed uninherited(string $name)

Gets the uninherited value for the given config option

Parameters

string $name

Return Value

mixed

$this set_stat(string $name, mixed $value) deprecated

deprecated 5.0 Use ->config()->set() instead

Update the config value for a given property

Parameters

string $name
mixed $value

Return Value

$this

__construct($nestedContentFilter = null)

No description

Parameters

$nestedContentFilter

protected CacheInterface getCache()

Gets the cache to use

Return Value

CacheInterface

mixed getContent(string $key, callable $callback)

Evaluates the result of the given callback

Parameters

string $key

Unique key for this

callable $callback

Callback for evaluating the content

Return Value

mixed

Result of $callback()