Class ilTermsOfServiceTableDataProviderFactory. More...

Collaboration diagram for ilTermsOfServiceTableDataProviderFactory:

Public Member Functions
	getByContext (string $context)

	setDatabaseAdapter (?ilDBInterface $db)

	getDatabaseAdapter ()

Data Fields
const	CONTEXT_ACCEPTANCE_HISTORY = 'acceptance_history'

const	CONTEXT_DOCUMENTS = 'documents'

Protected Member Functions
	validateConfiguration (array $mandatoryMemberVariables)

	getExceptionByMember (string $member)

Protected Attributes
	$db

Detailed Description

Class ilTermsOfServiceTableDataProviderFactory.

Author: Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

Definition at line 8 of file class.ilTermsOfServiceTableDataProviderFactory.php.

Member Function Documentation

◆ getByContext()

ilTermsOfServiceTableDataProviderFactory::getByContext ( string $context )

Parameters

string $context

Returns: ilTermsOfServiceTableDataProvider

Exceptions

ilTermsOfServiceMissingDatabaseAdapterException
InvalidArgumentException

Definition at line 22 of file class.ilTermsOfServiceTableDataProviderFactory.php.

                                                  : ilTermsOfServiceTableDataProvider
    {
        switch ($context) {
            case self::CONTEXT_ACCEPTANCE_HISTORY:
                $this->validateConfiguration(['db']);
                return new ilTermsOfServiceAcceptanceHistoryProvider($this->getDatabaseAdapter());
 
            case self::CONTEXT_DOCUMENTS:
                return new ilTermsOfServiceDocumentTableDataProvider();
 
            default:
                throw new InvalidArgumentException('Provider not supported');
        }
    }

References $context, CONTEXT_ACCEPTANCE_HISTORY, CONTEXT_DOCUMENTS, getDatabaseAdapter(), and validateConfiguration().

Here is the call graph for this function:

◆ getDatabaseAdapter()

ilTermsOfServiceTableDataProviderFactory::getDatabaseAdapter ( )

Returns: ilDBInterface|null

Definition at line 80 of file class.ilTermsOfServiceTableDataProviderFactory.php.

                                         : ?ilDBInterface
    {
        return $this->db;
    }

References $db.

Referenced by getByContext().

Here is the caller graph for this function:

◆ getExceptionByMember()

ilTermsOfServiceTableDataProviderFactory::getExceptionByMember ( string $member )

protected

Parameters

string $member

Returns: ilTermsOfServiceMissingDatabaseAdapterException

Exceptions

InvalidArgumentException

Definition at line 56 of file class.ilTermsOfServiceTableDataProviderFactory.php.

    {
        switch ($member) {
            case 'db':
                return new ilTermsOfServiceMissingDatabaseAdapterException(
                    'Incomplete factory configuration. Please inject a database adapter.'
                );
 
            default:
                throw new InvalidArgumentException("Exception for member {$member} not supported");
        }
    }

Referenced by validateConfiguration().

Here is the caller graph for this function:

◆ setDatabaseAdapter()

ilTermsOfServiceTableDataProviderFactory::setDatabaseAdapter ( ?ilDBInterface $db )

Parameters

ilDBInterface | null $db

Definition at line 72 of file class.ilTermsOfServiceTableDataProviderFactory.php.

    {
        $this->db = $db;
    }

References $db.

◆ validateConfiguration()

ilTermsOfServiceTableDataProviderFactory::validateConfiguration ( array $mandatoryMemberVariables )

protected

Parameters

array $mandatoryMemberVariables

Exceptions

ilTermsOfServiceMissingDatabaseAdapterException

Definition at line 41 of file class.ilTermsOfServiceTableDataProviderFactory.php.

                                                                              : void
    {
        foreach ($mandatoryMemberVariables as $member) {
            if (null === $this->{$member}) {
                $exception = $this->getExceptionByMember($member);
                throw $exception;
            }
        }
    }