phpBB API Documentation
Class

phpbb\auth\provider_collection

class provider_collection extends service_collection

Collection of auth providers to be configured at container compile time.

Methods

__construct(ContainerInterface $container, config $config)

Constructor

getIterator()

{@inheritdoc}

from service_collection
offsetExists($index)

{@inheritdoc}

from service_collection
offsetGet($index)

{@inheritdoc}

from service_collection
null add(string $name)

Add a service to the collection

from service_collection
object get_provider(string $provider_name = '')

Get an auth provider.

Details

at line 32
public __construct(ContainerInterface $container, config $config)

Constructor

Parameters

ContainerInterface $container Container object
config $config phpBB config

in service_collection at line 41
public getIterator()

{@inheritdoc}

in service_collection at line 55
public offsetExists($index)

{@inheritdoc}

Parameters

$index

in service_collection at line 64
public offsetGet($index)

{@inheritdoc}

Parameters

$index

in service_collection at line 75
public null add(string $name)

Add a service to the collection

Parameters

string $name The service name

Return Value

null

at line 50
public object get_provider(string $provider_name = '')

Get an auth provider.

Parameters

string $provider_name The name of the auth provider

Return Value

object Default auth provider selected in config if it does exist. Otherwise the standard db auth provider.

Exceptions

RuntimeException If neither the auth provider that is specified by the phpBB config nor the db auth provider exist. The db auth provider should always exist in a phpBB installation.