Collects actions from all action providers. More...

Collaboration diagram for ilUserActionCollector:

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

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

Protected Member Functions
	__construct ($a_user_id)
	Constructor. More...

Protected Attributes
	$collection

	$user_id

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 )

protected

Constructor.

Parameters

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

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

         {
                 $this->user_id = $a_user_id;
         }

Member Function Documentation

◆ getActionsForTargetUser()

ilUserActionCollector::getActionsForTargetUser	(	$a_target_user,
		$a_context_component_id,
		$a_context_id
	)

Collect actions.

Returns: ilUserActionCollection action

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

References $a_context_id, $collection, ilUserActionProviderFactory\getAllProviders(), ilUserActionCollection\getInstance(), 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)
                 {
                         $prov->setUserId($this->user_id);
                         $coll = $prov->collectActionsForTargetUser($a_target_user);
                         foreach ($coll->getActions() as $action)
                         {
                                 if (ilUserActionAdmin::lookupActive($a_context_component_id, $a_context_id, $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 )

static

Get instance (for a user)

Parameters

int $a_user_id user id

Returns: ilUserActionCollector

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

Referenced by ilAwarenessData\__construct().

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