ilUserActionCollector Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilUserActionCollector:

Public Member Functions
	__construct (private int $user_id, private ilUserActionContext $action_context, private ilUserActionProviderFactory $user_action_provider_factory, private ilUserActionAdmin $user_action_admin)
	getActionsForTargetUser (int $target_user)

Protected Member Functions
	hasProviderActiveActions (ilUserActionProvider $provider)

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Collects actions from all action providers

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 23 of file class.ilUserActionCollector.php.

Constructor & Destructor Documentation

__construct()

ilUserActionCollector::__construct	(	private int	$user_id,
		private ilUserActionContext	$action_context,
		private ilUserActionProviderFactory	$user_action_provider_factory,
		private ilUserActionAdmin	$user_action_admin
	)

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

      {
    }

Member Function Documentation

getActionsForTargetUser()

ilUserActionCollector::getActionsForTargetUser

(

int

$target_user

)

Definition at line 33 of file class.ilUserActionCollector.php.

References $provider, and hasProviderActiveActions().

Referenced by ilMyStaffGUI\executeCommand().

                                                             : ilUserActionCollection
    {
        $collection = new ilUserActionCollection();
        foreach ($this->user_action_provider_factory->getProviders() as $provider) {
            if (!$this->hasProviderActiveActions($provider)) {
                continue;
            }
            $provider->setUserId($this->user_id);
            $coll = $provider->collectActionsForTargetUser($target_user);
            foreach ($coll->getActions() as $action) {
                if ($this->user_action_admin->isActionActive(
                    $this->action_context->getComponentId(),
                    $this->action_context->getContextId(),
                    $provider->getComponentId(),
                    $action->getType()
                )) {
                    $collection->addAction($action);
                }
            }
        }

        return $collection;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

hasProviderActiveActions()

ilUserActionCollector::hasProviderActiveActions ( ilUserActionProvider  $provider )

protected

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

References ilUserActionProvider\getActionTypes(), and ilUserActionProvider\getComponentId().

Referenced by getActionsForTargetUser().

                                                                               : bool
    {
        foreach ($provider->getActionTypes() as $act_type => $act_txt) {
            if ($this->user_action_admin->isActionActive(
                $this->action_context->getComponentId(),
                $this->action_context->getContextId(),
                $provider->getComponentId(),
                $act_type
            )) {
                return true;
            }
        }
        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• components/ILIAS/User/classes/Actions/class.ilUserActionCollector.php