Class ilAccessibilityTableDataProviderFactory. More...

Collaboration diagram for ilAccessibilityTableDataProviderFactory:

Public Member Functions
	getByContext (string $context)

	setDatabaseAdapter (?ilDBInterface $db)

	getDatabaseAdapter ()

Data Fields
const	CONTEXT_DOCUMENTS = 'documents'

Protected Member Functions
	validateConfiguration (array $mandatoryMemberVariables)

	getExceptionByMember (string $member)

Protected Attributes
	$db

Detailed Description

Class ilAccessibilityTableDataProviderFactory.

Definition at line 7 of file class.ilAccessibilityTableDataProviderFactory.php.

Member Function Documentation

◆ getByContext()

ilAccessibilityTableDataProviderFactory::getByContext ( string $context )

Parameters

string $context

Returns: ilAccessibilityTableDataProvider

Exceptions

ilAccessibilityMissingDatabaseAdapterException
InvalidArgumentException

Definition at line 20 of file class.ilAccessibilityTableDataProviderFactory.php.

                                                  : ilAccessibilityTableDataProvider
    {
        switch ($context) {
            case self::CONTEXT_DOCUMENTS:
                return new ilAccessibilityDocumentTableDataProvider();
 
            default:
                throw new InvalidArgumentException('Provider not supported');
        }
    }

References $context, and CONTEXT_DOCUMENTS.

◆ getDatabaseAdapter()

ilAccessibilityTableDataProviderFactory::getDatabaseAdapter ( )

Returns: ilDBInterface|null

Definition at line 74 of file class.ilAccessibilityTableDataProviderFactory.php.

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

References $db.

◆ getExceptionByMember()

ilAccessibilityTableDataProviderFactory::getExceptionByMember ( string $member )

protected

Parameters

string $member

Returns: ilAccessibilityMissingDatabaseAdapterException

Exceptions

InvalidArgumentException

Definition at line 50 of file class.ilAccessibilityTableDataProviderFactory.php.

    {
        switch ($member) {
            case 'db':
                return new ilAccessibilityMissingDatabaseAdapterException(
                    '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()

ilAccessibilityTableDataProviderFactory::setDatabaseAdapter ( ?ilDBInterface $db )

Parameters

ilDBInterface | null $db

Definition at line 66 of file class.ilAccessibilityTableDataProviderFactory.php.

    {
        $this->db = $db;
    }

References $db.

◆ validateConfiguration()

ilAccessibilityTableDataProviderFactory::validateConfiguration ( array $mandatoryMemberVariables )

protected

Parameters

array $mandatoryMemberVariables

Exceptions

ilAccessibilityMissingDatabaseAdapterException

Definition at line 35 of file class.ilAccessibilityTableDataProviderFactory.php.

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