phpBB API Documentation
Class

phpbb\cache\service

class service

Class for grabbing/handling cached entries

Methods

__construct(driver_interface $driver, config $config, driver_interface $db, string $phpbb_root_path, string $php_ext)

Creates a cache service around a cache driver

driver_interface get_driver()

Returns the cache driver used by this cache service.

set_driver(driver_interface $driver)

Replaces the cache driver used by this cache service.

__call($method, $arguments)

obtain_word_list()

Obtain list of naughty words and build preg style replacement arrays for use by the calling script

obtain_icons()

Obtain currently listed icons

obtain_ranks()

Obtain ranks

array obtain_attach_extensions(mixed $forum_id)

Obtain allowed extensions

obtain_bots()

Obtain active bots

obtain_cfg_items($style)

Obtain cfg file data

obtain_disallowed_usernames()

Obtain disallowed usernames

Details

at line 65
public __construct(driver_interface $driver, config $config, driver_interface $db, string $phpbb_root_path, string $php_ext)

Creates a cache service around a cache driver

Parameters

driver_interface $driver The cache driver
config $config The config
driver_interface $db Database connection
string $phpbb_root_path Root path
string $php_ext PHP file extension

at line 79
public driver_interface get_driver()

Returns the cache driver used by this cache service.

Return Value

driver_interface The cache driver

at line 89
public set_driver(driver_interface $driver)

Replaces the cache driver used by this cache service.

Parameters

driver_interface $driver The cache driver

at line 94
public __call($method, $arguments)

Parameters

$method
$arguments

at line 103
public obtain_word_list()

Obtain list of naughty words and build preg style replacement arrays for use by the calling script

at line 128
public obtain_icons()

Obtain currently listed icons

at line 158
public obtain_ranks()

Obtain ranks

at line 195
public array obtain_attach_extensions(mixed $forum_id)

Obtain allowed extensions

Parameters

mixed $forum_id If false then check for private messaging, if int then check for forum id. If true, then only return extension informations.

Return Value

array allowed extensions array.

at line 299
public obtain_bots()

Obtain active bots

at line 339
public obtain_cfg_items($style)

Obtain cfg file data

Parameters

$style

at line 370
public obtain_disallowed_usernames()

Obtain disallowed usernames