Class ilBuddySystemRelationStateFactory. More...

Collaboration diagram for ilBuddySystemRelationStateFactory:

Public Member Functions
	__construct (ilLanguage $lng)

	getValidStates ()
	Get all valid states. More...

	getInitialState ()

	getTableFilterStateMapper (ilBuddySystemRelationState $state)

	getStateButtonRendererByOwnerAndRelation (int $ownerId, ilBuddySystemRelation $relation)

Static Public Member Functions
static	getInstance (?ilLanguage $lng=null)

Protected Attributes
	$lng

Static Protected Attributes
static	$instance

static	$validStates

Detailed Description

Class ilBuddySystemRelationStateFactory.

Author: Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

Definition at line 8 of file class.ilBuddySystemRelationStateFactory.php.

Constructor & Destructor Documentation

◆ __construct()

ilBuddySystemRelationStateFactory::__construct ( ilLanguage $lng )

Definition at line 19 of file class.ilBuddySystemRelationStateFactory.php.

    {
        $this->lng = $lng;
    }

References $lng.

Member Function Documentation

◆ getInitialState()

ilBuddySystemRelationStateFactory::getInitialState ( )

Returns: ilBuddySystemRelationState

Exceptions

ilBuddySystemException

Definition at line 59 of file class.ilBuddySystemRelationStateFactory.php.

                                      : ilBuddySystemRelationState
    {
        foreach ($this->getValidStates() as $state) {
            if ($state->isInitial()) {
                return $state;
            }
        }
 
        throw new ilBuddySystemException("Could not find an initial state class");
    }

References getValidStates().

Here is the call graph for this function:

◆ getInstance()

static ilBuddySystemRelationStateFactory::getInstance ( ?ilLanguage $lng = null )

static

Definition at line 24 of file class.ilBuddySystemRelationStateFactory.php.

                                                                : self
    {
        global $DIC;
 
        if (null === self::$instance) {
            $lng = $lng ?? $DIC['lng'];
 
            self::$instance = new self($lng);
        }
 
        return self::$instance;
    }

References $DIC, $instance, and $lng.

Referenced by ilBuddySystemGUI\__construct(), ilBuddySystemLinkButton\getHtml(), ilBuddyList\getRelationByUserId(), ilBuddySystemRelationsTableGUI\initFilter(), and ilBuddySystemRelationsTableGUI\populate().

Here is the caller graph for this function:

◆ getStateButtonRendererByOwnerAndRelation()

ilBuddySystemRelationStateFactory::getStateButtonRendererByOwnerAndRelation	(	int	$ownerId,
		ilBuddySystemRelation	$relation
	)

Parameters

int	$ownerId
ilBuddySystemRelation	$relation

Returns: ilBuddySystemRelationStateButtonRenderer

Definition at line 83 of file class.ilBuddySystemRelationStateFactory.php.

      : ilBuddySystemRelationStateButtonRenderer {
        $stateClass = get_class($relation->getState());
        $class = $stateClass . 'ButtonRenderer';
 
        return new $class($ownerId, $relation);
    }

◆ getTableFilterStateMapper()

ilBuddySystemRelationStateFactory::getTableFilterStateMapper ( ilBuddySystemRelationState $state )

Definition at line 70 of file class.ilBuddySystemRelationStateFactory.php.

                                                                                 : ilBuddySystemRelationStateTableFilterMapper
    {
        $stateClass = get_class($state);
        $class = $stateClass . 'TableFilterMapper';
 
        return new $class($this->lng, $state);
    }

◆ getValidStates()

ilBuddySystemRelationStateFactory::getValidStates ( )

Get all valid states.

Returns: ilBuddySystemRelationState[]

Definition at line 41 of file class.ilBuddySystemRelationStateFactory.php.

                                     : array
    {
        if (null !== self::$validStates) {
            return self::$validStates;
        }
 
        return (self::$validStates = [
            new ilBuddySystemUnlinkedRelationState(),
            new ilBuddySystemRequestedRelationState(),
            new ilBuddySystemIgnoredRequestRelationState(),
            new ilBuddySystemLinkedRelationState(),
        ]);
    }