Collects actions from all action providers. More...

Collaboration diagram for ilUserActionCollector:

Public Member Functions
	getActionsForTargetUser ($a_target_user)
	Collect actions. More...

Static Public Member Functions
static	getInstance ($a_user_id, ilUserActionContext $a_context)
	Get instance (for a user) More...

Protected Member Functions
	__construct ($a_user_id, ilUserActionContext $a_context)
	Constructor. More...

	hasProviderActiveActions (ilUserActionProvider $prov)

Protected Attributes
	$collection

	$user_id

	$action_context

Static Protected Attributes
static	$instances = array()

Detailed Description

Collects actions from all action providers.

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilUserActionCollector::__construct	(		$a_user_id,
		ilUserActionContext	$a_context
	)

protected

Constructor.

Parameters

int	$a_user_id	user id (usually the current user logged in)
ilUserActionContext	$a_context

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

     {
         $this->user_id = $a_user_id;
         $this->action_context = $a_context;
     }

Member Function Documentation

◆ getActionsForTargetUser()

ilUserActionCollector::getActionsForTargetUser ( $a_target_user )

Collect actions.

Returns: ilUserActionCollection action

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

References $collection, ilUserActionProviderFactory\getAllProviders(), ilUserActionCollection\getInstance(), hasProviderActiveActions(), and ilUserActionAdmin\lookupActive().

     {
         // overall collection of users
         include_once("./Services/User/Actions/classes/class.ilUserActionCollection.php");
         $this->collection = ilUserActionCollection::getInstance();
 
         include_once("./Services/User/Actions/classes/class.ilUserActionAdmin.php");
 
         include_once("./Services/User/Actions/classes/class.ilUserActionProviderFactory.php");
         foreach (ilUserActionProviderFactory::getAllProviders() as $prov) {
             if (!$this->hasProviderActiveActions($prov)) {
                 continue;
             }
             $prov->setUserId($this->user_id);
             $coll = $prov->collectActionsForTargetUser($a_target_user);
             foreach ($coll->getActions() as $action) {
                 if (ilUserActionAdmin::lookupActive(
                     $this->action_context->getComponentId(),
                     $this->action_context->getContextId(),
                     $prov->getComponentId(),
                     $action->getType()
                 )) {
                     $this->collection->addAction($action);
                 }
             }
         }
 
         return $this->collection;
     }

Here is the call graph for this function:

◆ getInstance()

static ilUserActionCollector::getInstance	(		$a_user_id,
		ilUserActionContext	$a_context
	)

static

Get instance (for a user)

Parameters

int	$a_user_id	user id
ilUserActionContext	$a_context

Returns: ilUserActionCollector

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

Referenced by ilAwarenessData\__construct(), ilMyStaffGUI\executeCommand(), and ilUserActionGUI\renderDropDown().

     {
         if (!isset(self::$instances[$a_user_id])) {
             self::$instances[$a_user_id] = new ilUserActionCollector($a_user_id, $a_context);
         }
 
         return self::$instances[$a_user_id];
     }

Here is the caller graph for this function:

◆ hasProviderActiveActions()

ilUserActionCollector::hasProviderActiveActions ( ilUserActionProvider $prov )

protected

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

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

Referenced by getActionsForTargetUser().

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