ILIAS\GlobalScreen\Provider\ProviderFactory Class Reference

Class ProviderFactory. More...

Inheritance diagram for ILIAS\GlobalScreen\Provider\ProviderFactory:

Collaboration diagram for ILIAS\GlobalScreen\Provider\ProviderFactory:

Public Member Functions
	__construct (array $main_bar_providers, ItemInformation $main_menu_item_information)
	ProviderFactory constructor. More...
	getMainBarProvider ()
	getMainBarItemInformation ()
	getProviderByClassName (string $class_name)
	isInstanceCreationPossible (string $class_name)
	isRegistered (string $class_name)

Protected Member Functions
	registerInternal (array $providers)

Protected Attributes
	$all_providers

Private Attributes
	$main_bar_providers = []
	$main_menu_item_information = null

Detailed Description

Class ProviderFactory.

Author

Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 13 of file ProviderFactory.php.

Constructor & Destructor Documentation

__construct()

ILIAS\GlobalScreen\Provider\ProviderFactory::__construct	(	array	$main_bar_providers,
		ItemInformation	$main_menu_item_information
	)

ProviderFactory constructor.

Parameters

array	$main_bar_providers
ItemInformation	$main_menu_item_information

Definition at line 36 of file ProviderFactory.php.

References ILIAS\GlobalScreen\Provider\ProviderFactory\$main_bar_providers, ILIAS\GlobalScreen\Provider\ProviderFactory\$main_menu_item_information, and ILIAS\GlobalScreen\Provider\ProviderFactory\registerInternal().

    {
        $this->main_bar_providers = $main_bar_providers;
        $this->main_menu_item_information = $main_menu_item_information;

        $this->registerInternal($main_bar_providers);
    }

Here is the call graph for this function:

Member Function Documentation

getMainBarItemInformation()

ILIAS\GlobalScreen\Provider\ProviderFactory::getMainBarItemInformation

(

)

Implements ILIAS\GlobalScreen\Provider\ProviderFactoryInterface.

Definition at line 71 of file ProviderFactory.php.

References ILIAS\GlobalScreen\Provider\ProviderFactory\$main_menu_item_information.

                                                : ItemInformation
    {
        return $this->main_menu_item_information;
    }

getMainBarProvider()

ILIAS\GlobalScreen\Provider\ProviderFactory::getMainBarProvider

(

)

Implements ILIAS\GlobalScreen\Provider\ProviderFactoryInterface.

Definition at line 62 of file ProviderFactory.php.

References ILIAS\GlobalScreen\Provider\ProviderFactory\$main_bar_providers.

                                         : array
    {
        return $this->main_bar_providers;
    }

getProviderByClassName()

ILIAS\GlobalScreen\Provider\ProviderFactory::getProviderByClassName

(

string

$class_name

)

Implements ILIAS\GlobalScreen\Provider\ProviderFactoryInterface.

Definition at line 80 of file ProviderFactory.php.

References ILIAS\GlobalScreen\Provider\ProviderFactory\isInstanceCreationPossible(), and ILIAS\GlobalScreen\Provider\ProviderFactory\isRegistered().

                                                               : Provider
    {
        if (!$this->isInstanceCreationPossible($class_name) || !$this->isRegistered($class_name)) {
            throw new \LogicException("the GlobalScreen-Provider $class_name is not available");
        }

        return $this->all_providers[$class_name];
    }

Here is the call graph for this function:

isInstanceCreationPossible()

ILIAS\GlobalScreen\Provider\ProviderFactory::isInstanceCreationPossible

(

string

$class_name

)

Implements ILIAS\GlobalScreen\Provider\ProviderFactoryInterface.

Definition at line 93 of file ProviderFactory.php.

Referenced by ilGSProviderFactory\appendPlugins(), and ILIAS\GlobalScreen\Provider\ProviderFactory\getProviderByClassName().

                                                                   : bool
    {
        return class_exists($class_name);
    }

Here is the caller graph for this function:

isRegistered()

ILIAS\GlobalScreen\Provider\ProviderFactory::isRegistered

(

string

$class_name

)

Implements ILIAS\GlobalScreen\Provider\ProviderFactoryInterface.

Definition at line 102 of file ProviderFactory.php.

Referenced by ILIAS\GlobalScreen\Provider\ProviderFactory\getProviderByClassName().

                                                     : bool
    {
        return isset($this->all_providers[$class_name]);
    }

Here is the caller graph for this function:

registerInternal()

ILIAS\GlobalScreen\Provider\ProviderFactory::registerInternal ( array  $providers )

protected

Parameters

array

$providers

Definition at line 48 of file ProviderFactory.php.

Referenced by ILIAS\GlobalScreen\Provider\ProviderFactory\__construct(), and ilGSProviderFactory\getMainBarProvider().

    {
        array_walk(
            $providers,
            function (Provider $item) {
                $this->all_providers[get_class($item)] = $item;
            }
        );
    }

Here is the caller graph for this function:

Field Documentation

$all_providers

ILIAS\GlobalScreen\Provider\ProviderFactory::$all_providers

protected

Definition at line 27 of file ProviderFactory.php.

$main_bar_providers

ILIAS\GlobalScreen\Provider\ProviderFactory::$main_bar_providers = []

private

Definition at line 19 of file ProviderFactory.php.

Referenced by ILIAS\GlobalScreen\Provider\ProviderFactory\__construct(), and ILIAS\GlobalScreen\Provider\ProviderFactory\getMainBarProvider().

$main_menu_item_information

ILIAS\GlobalScreen\Provider\ProviderFactory::$main_menu_item_information = null

private

Definition at line 23 of file ProviderFactory.php.

Referenced by ILIAS\GlobalScreen\Provider\ProviderFactory\__construct(), and ILIAS\GlobalScreen\Provider\ProviderFactory\getMainBarItemInformation().

---

The documentation for this class was generated from the following file:

• src/GlobalScreen/Provider/ProviderFactory.php