ilBuddySystemRelationStateFactory Class Reference

Class ilBuddySystemRelationStateFactory. More...

Collaboration diagram for ilBuddySystemRelationStateFactory:

Public Member Functions
	__construct (protected ilLanguage $lng)
	reset ()
	getValidStates ()
	Get all valid states. More...
	getInitialState ()
	getTableFilterStateMapper (ilBuddySystemRelationState $state)
	getStateButtonRendererByOwnerAndRelation (int $ownerId, ilBuddySystemRelation $relation)

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

Static Protected Attributes
static self	$instance = null
static array	$validStates = null

Detailed Description

Class ilBuddySystemRelationStateFactory.

Author

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

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

Constructor & Destructor Documentation

__construct()

ilBuddySystemRelationStateFactory::__construct

(

protected ilLanguage

$lng

)

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

    {
    }

Member Function Documentation

getInitialState()

ilBuddySystemRelationStateFactory::getInitialState

(

)

Exceptions

ilBuddySystemException

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

References getValidStates().

                                     : ilBuddySystemRelationState
    {
        foreach ($this->getValidStates() as $state) {
            if ($state->isInitial()) {
                return $state;
            }
        }

        throw new ilBuddySystemException('Could not find an initial state class');
    }

Here is the call graph for this function:

getInstance()

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

static

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

References $DIC, $lng, and null.

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

                                                               : self
    {
        global $DIC;

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

            self::$instance = new self($lng);
        }

        return self::$instance;
    }

Here is the caller graph for this function:

getStateButtonRendererByOwnerAndRelation()

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

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

References ilBuddySystemRelation\getState().

     : ilBuddySystemRelationStateButtonRenderer {
        $stateClass = $relation->getState()::class;
        $class = $stateClass . 'ButtonRenderer';

        return new $class($ownerId, $relation);
    }

Here is the call graph for this function:

getTableFilterStateMapper()

ilBuddySystemRelationStateFactory::getTableFilterStateMapper

(

ilBuddySystemRelationState

$state

)

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

References ILIAS\Repository\lng().

                                                                                : ilBuddySystemRelationStateTableFilterMapper
    {
        $stateClass = $state::class;
        $class = $stateClass . 'TableFilterMapper';

        return new $class($this->lng, $state);
    }

Here is the call graph for this function:

getValidStates()

ilBuddySystemRelationStateFactory::getValidStates

(

)

Get all valid states.

Returns

ilBuddySystemRelationState[]

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

Referenced by getInitialState().

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

Here is the caller graph for this function:

reset()

ilBuddySystemRelationStateFactory::reset

(

)

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

References null.

                           : void
    {
        self::$instance = null;
    }

Field Documentation

$instance

self ilBuddySystemRelationStateFactory::$instance = null

staticprotected

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

$validStates

array ilBuddySystemRelationStateFactory::$validStates = null

staticprotected

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

---

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

• components/ILIAS/Contact/BuddySystem/classes/states/class.ilBuddySystemRelationStateFactory.php