ilAbstractBuddySystemRelationStateButtonRenderer Class Reference

Inheritance diagram for ilAbstractBuddySystemRelationStateButtonRenderer:

Collaboration diagram for ilAbstractBuddySystemRelationStateButtonRenderer:

Public Member Functions
	__construct (protected int $usrId, protected ilBuddySystemRelation $relation, ilLanguage $lng=null)
	getHtml ()

Protected Member Functions
	getLanguageVariableSuffix ()
	render ()
	getTemplateVariablePrefix ()
	renderStateButton ()
	renderTargetState (ilBuddySystemRelationState $target_state)

Protected Attributes
ilTemplate	$tpl
ilLanguage	$lng

Detailed Description

Definition at line 21 of file class.ilAbstractBuddySystemRelationStateButtonRenderer.php.

Constructor & Destructor Documentation

__construct()

ilAbstractBuddySystemRelationStateButtonRenderer::__construct	(	protected int	$usrId,
		protected ilBuddySystemRelation	$relation,
		ilLanguage	$lng = null
	)

Definition at line 26 of file class.ilAbstractBuddySystemRelationStateButtonRenderer.php.

References $DIC, ilStr\convertUpperCamelCaseToUnderscoreCase(), and ILIAS\Repository\lng().

    {
        global $DIC;

        $this->tpl = new ilTemplate(
            'tpl.buddy_system_state_' . ilStr::convertUpperCamelCaseToUnderscoreCase($this->relation->getState()->getName()) . '.html',
            true,
            true,
            'components/ILIAS/Contact/BuddySystem'
        );

        $this->tpl->setVariable('MENU_ID', uniqid('buddy-system-menu', true));

        $this->lng = $lng ?? $DIC['lng'];
    }

Here is the call graph for this function:

Member Function Documentation

getHtml()

ilAbstractBuddySystemRelationStateButtonRenderer::getHtml

(

)

Implements ilBuddySystemRelationStateButtonRenderer.

Definition at line 99 of file class.ilAbstractBuddySystemRelationStateButtonRenderer.php.

References render().

                             : string
    {
        $this->render();

        return $this->tpl->get();
    }

Here is the call graph for this function:

getLanguageVariableSuffix()

ilAbstractBuddySystemRelationStateButtonRenderer::getLanguageVariableSuffix ( )

protected

Definition at line 42 of file class.ilAbstractBuddySystemRelationStateButtonRenderer.php.

                                                  : string
    {
        $suffix = '_p';
        if ($this->relation->isOwnedByActor()) {
            $suffix = '_a';
        }

        return $suffix;
    }

getTemplateVariablePrefix()

ilAbstractBuddySystemRelationStateButtonRenderer::getTemplateVariablePrefix ( )

protected

Definition at line 61 of file class.ilAbstractBuddySystemRelationStateButtonRenderer.php.

Referenced by renderStateButton(), and renderTargetState().

                                                  : string
    {
        return '';
    }

Here is the caller graph for this function:

render()

ilAbstractBuddySystemRelationStateButtonRenderer::render ( )

protected

Definition at line 52 of file class.ilAbstractBuddySystemRelationStateButtonRenderer.php.

References renderStateButton(), and renderTargetState().

Referenced by getHtml().

                               : void
    {
        $this->renderStateButton();
        $states = $this->relation->getCurrentPossibleTargetStates();
        foreach ($states as $target_state) {
            $this->renderTargetState($target_state);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

renderStateButton()

ilAbstractBuddySystemRelationStateButtonRenderer::renderStateButton ( )

protected

Definition at line 66 of file class.ilAbstractBuddySystemRelationStateButtonRenderer.php.

References ilStr\convertUpperCamelCaseToUnderscoreCase(), getTemplateVariablePrefix(), and ILIAS\Repository\lng().

Referenced by render().

                                          : void
    {
        $state_id = ilStr::convertUpperCamelCaseToUnderscoreCase($this->relation->getState()->getName());

        $this->tpl->setVariable(
            $this->getTemplateVariablePrefix() . 'BUTTON_TXT',
            $this->lng->txt(
                'buddy_bs_btn_txt_' . $state_id . $this->getLanguageVariableSuffix()
            )
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

renderTargetState()

ilAbstractBuddySystemRelationStateButtonRenderer::renderTargetState ( ilBuddySystemRelationState  $target_state )

protected

Definition at line 78 of file class.ilAbstractBuddySystemRelationStateButtonRenderer.php.

References ilStr\convertUpperCamelCaseToUnderscoreCase(), ilBuddySystemRelationState\getAction(), ilBuddySystemRelationState\getName(), getTemplateVariablePrefix(), and ILIAS\Repository\lng().

Referenced by render().

                                                                                  : void
    {
        $state_id = ilStr::convertUpperCamelCaseToUnderscoreCase($this->relation->getState()->getName());
        $target_state_id = ilStr::convertUpperCamelCaseToUnderscoreCase($target_state->getName());

        $this->tpl->setVariable(
            $this->getTemplateVariablePrefix() . 'TARGET_STATE_' . strtoupper($target_state_id),
            $target_state::class
        );
        $this->tpl->setVariable(
            $this->getTemplateVariablePrefix() . 'TARGET_STATE_ACTION_' . strtoupper($target_state_id),
            $target_state->getAction()
        );
        $this->tpl->setVariable(
            $this->getTemplateVariablePrefix() . 'TARGET_STATE_TXT_' . strtoupper($target_state_id),
            $this->lng->txt(
                'buddy_bs_act_btn_txt_' . $state_id . '_to_' . $target_state_id
            )
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$lng

ilLanguage ilAbstractBuddySystemRelationStateButtonRenderer::$lng

protected

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

$tpl

ilTemplate ilAbstractBuddySystemRelationStateButtonRenderer::$tpl

protected

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

---

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

• components/ILIAS/Contact/BuddySystem/classes/states/renderer/class.ilAbstractBuddySystemRelationStateButtonRenderer.php