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
ilDBInterface	$db = null

Detailed Description

Class ilTermsOfServiceTableDataProviderFactory.

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

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

Member Function Documentation

◆ getByContext()

ilTermsOfServiceTableDataProviderFactory::getByContext ( string $context )

Parameters

string $context

Returns: ilTermsOfServiceTableDataProvider

Exceptions

ilTermsOfServiceMissingDatabaseAdapterException
InvalidArgumentException

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

References getDatabaseAdapter(), and validateConfiguration().

Referenced by ilTermsOfServiceTableDataProviderFactoryTest\testExceptionIsRaisedWhenAcceptanceHistoryProviderIsRequestedWithoutCompleteFactoryConfiguration(), ilTermsOfServiceTableDataProviderFactoryTest\testExceptionIsRaisedWhenUnsupportedProviderIsRequested(), and ilTermsOfServiceTableDataProviderFactoryTest\testFactoryShouldReturnAcceptanceHistoryProviderWhenRequested().

                                                  : 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');
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDatabaseAdapter()

ilTermsOfServiceTableDataProviderFactory::getDatabaseAdapter ( )

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

References $db.

Referenced by getByContext(), and ilTermsOfServiceTableDataProviderFactoryTest\testFactoryShouldReturnDatabaseAdapterWhenDatabaseAdapterIsSet().

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

Here is the caller graph for this function:

◆ getExceptionByMember()

ilTermsOfServiceTableDataProviderFactory::getExceptionByMember ( string $member )

protected

Parameters

string $member

Returns: ilTermsOfServiceException

Exceptions

InvalidArgumentException

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

Referenced by validateConfiguration().

                                                            : ilTermsOfServiceException
     {
         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");
         }
     }

Here is the caller graph for this function:

◆ setDatabaseAdapter()

ilTermsOfServiceTableDataProviderFactory::setDatabaseAdapter ( ?ilDBInterface $db )

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

References $db.

Referenced by ilTermsOfServiceTableDataProviderFactoryTest\testExceptionIsRaisedWhenAcceptanceHistoryProviderIsRequestedWithoutCompleteFactoryConfiguration(), ilTermsOfServiceTableDataProviderFactoryTest\testFactoryShouldReturnAcceptanceHistoryProviderWhenRequested(), and ilTermsOfServiceTableDataProviderFactoryTest\testFactoryShouldReturnDatabaseAdapterWhenDatabaseAdapterIsSet().

                                                           : void
     {
         $this->db = $db;
     }

Here is the caller graph for this function:

◆ validateConfiguration()

ilTermsOfServiceTableDataProviderFactory::validateConfiguration ( array $mandatoryMemberVariables )

protected

Parameters

array $mandatoryMemberVariables

Exceptions

ilTermsOfServiceMissingDatabaseAdapterException

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

References getExceptionByMember().

Referenced by getByContext().

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