Collaboration diagram for ilTermsOfServiceTableDataProviderFactory:

Public Member Functions
	getByContext ($context)

	setLanguageAdapter ($lng)

	getLanguageAdapter ()

	setDatabaseAdapter ($db)

	getDatabaseAdapter ()

Data Fields
const	CONTEXT_AGRREMENT_BY_LANGUAGE = 'agreements_by_language'

const	CONTEXT_ACCEPTANCE_HISTORY = 'acceptance_history'

Protected Member Functions
	validateConfiguration (array $mandatory_members)

	getExceptionByMember ($member)

Protected Attributes
	$lng

	$db

Detailed Description

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

Version: $Id$

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

Member Function Documentation

◆ getByContext()

ilTermsOfServiceTableDataProviderFactory::getByContext ( $context )

Parameters

string $context

Returns: ilTermsOfServiceAgreementByLanguageProvider|ilTermsOfServiceAgreementByLanguageProvider|ilTermsOfServiceAcceptanceHistoryProvider

Exceptions

ilTermsOfServiceMissingLanguageAdapterException
InvalidArgumentException

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

        {
                switch($context)
                {
                        case self::CONTEXT_AGRREMENT_BY_LANGUAGE:
                                $this->validateConfiguration(array('lng'));
                                require_once 'Services/TermsOfService/classes/class.ilTermsOfServiceAgreementByLanguageProvider.php';
                                return new ilTermsOfServiceAgreementByLanguageProvider($this->lng);
 
                        case self::CONTEXT_ACCEPTANCE_HISTORY:
                                $this->validateConfiguration(array('db'));
                                require_once 'Services/TermsOfService/classes/class.ilTermsOfServiceAcceptanceHistoryProvider.php';
                                return new ilTermsOfServiceAcceptanceHistoryProvider($this->getDatabaseAdapter());
 
                        default:
                                throw new InvalidArgumentException('Provider not supported');
                }
        }

References CONTEXT_ACCEPTANCE_HISTORY, CONTEXT_AGRREMENT_BY_LANGUAGE, getDatabaseAdapter(), and validateConfiguration().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDatabaseAdapter()

ilTermsOfServiceTableDataProviderFactory::getDatabaseAdapter ( )

Returns: ilDB|null

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

        {
                return $this->db;
        }

References $db.

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

Here is the caller graph for this function:

◆ getExceptionByMember()

ilTermsOfServiceTableDataProviderFactory::getExceptionByMember ( $member )

protected

Parameters

string $member

Returns: ilTermsOfServiceMissingDatabaseAdapterException|ilTermsOfServiceMissingLanguageAdapterException

Exceptions

InvalidArgumentException

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

        {
                switch($member)
                {
                        case 'lng':
                                require_once 'Services/TermsOfService/exceptions/class.ilTermsOfServiceMissingLanguageAdapterException.php';
                                return new ilTermsOfServiceMissingLanguageAdapterException('Incomplete factory configuration. Please inject a language adapter.');
 
                        case 'db':
                                require_once 'Services/TermsOfService/exceptions/class.ilTermsOfServiceMissingDatabaseAdapterException.php';
                                return new ilTermsOfServiceMissingDatabaseAdapterException('Incomplete factory configuration. Please inject a database adapter.');
 
                        default:
                                throw new InvalidArgumentException("Exveption for member {$member} not supported");
                }
        }

Referenced by validateConfiguration().

Here is the caller graph for this function:

◆ getLanguageAdapter()

ilTermsOfServiceTableDataProviderFactory::getLanguageAdapter ( )

Returns: ilLanguage

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

        {
                return $this->lng;
        }

References $lng.

Referenced by ilTermsOfServiceTableDataProviderFactoryTest\testFactoryShouldReturnLanguageAdapterWhenLanguageAdapterIsSet().

Here is the caller graph for this function:

◆ setDatabaseAdapter()

ilTermsOfServiceTableDataProviderFactory::setDatabaseAdapter ( $db )

Parameters

ilDB | null $db

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

        {
                $this->db = $db;
        }

References $db.

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

Here is the caller graph for this function:

◆ setLanguageAdapter()

ilTermsOfServiceTableDataProviderFactory::setLanguageAdapter ( $lng )

Parameters

ilLanguage | null $lng

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

        {
                $this->lng = $lng;
        }

References $lng.

Referenced by ilTermsOfServiceTableDataProviderFactoryTest\testExceptionIsRaisedWhenAgreementByLanguageProviderIsRequestedWithoutCompleteFactoryConfiguration(), ilTermsOfServiceTableDataProviderFactoryTest\testFactoryShouldReturnAgreementByLanguageProviderWhenRequested(), and ilTermsOfServiceTableDataProviderFactoryTest\testFactoryShouldReturnLanguageAdapterWhenLanguageAdapterIsSet().

Here is the caller graph for this function:

◆ validateConfiguration()

ilTermsOfServiceTableDataProviderFactory::validateConfiguration ( array $mandatory_members )

protected

Parameters

array $mandatory_members

Exceptions

ilTermsOfServiceMissingLanguageAdapterException
ilTermsOfServiceMissingDatabaseAdapterException

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

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