Class ilAbstractBuddySystemRelationStateButtonRenderer. More...

Inheritance diagram for ilAbstractBuddySystemRelationStateButtonRenderer:

Collaboration diagram for ilAbstractBuddySystemRelationStateButtonRenderer:

Public Member Functions
	__construct (int $usrId, ilBuddySystemRelation $relation)

	getHtml ()

Protected Member Functions
	getLanguageVariableSuffix ()

	render ()

	getTemplateVariablePrefix ()

	renderStateButton ()

	renderTargetState (ilBuddySystemRelationState $target_state)

Protected Attributes
	$relation

	$usrId

	$tpl

	$lng

Detailed Description

Class ilAbstractBuddySystemRelationStateButtonRenderer.

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

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

Constructor & Destructor Documentation

◆ __construct()

ilAbstractBuddySystemRelationStateButtonRenderer::__construct	(	int	$usrId,
		ilBuddySystemRelation	$relation
	)

Parameters

int	$usrId
ilBuddySystemRelation	$relation

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

References $DIC, $relation, $usrId, and ilStr\convertUpperCamelCaseToUnderscoreCase().

     {
         global $DIC;
 
         $this->usrId = $usrId;
         $this->relation = $relation;
 
         $this->tpl = new ilTemplate(
             'tpl.buddy_system_state_' . ilStr::convertUpperCamelCaseToUnderscoreCase($this->relation->getState()->getName()) . '.html',
             true,
             true,
             'Services/Contact/BuddySystem'
         );
 
         $this->lng = $DIC['lng'];
     }

Here is the call graph for this function:

Member Function Documentation

◆ getHtml()

ilAbstractBuddySystemRelationStateButtonRenderer::getHtml ( )

Returns: string

Implements ilBuddySystemRelationStateButtonRenderer.

Definition at line 118 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

Returns: string

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

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

◆ getTemplateVariablePrefix()

ilAbstractBuddySystemRelationStateButtonRenderer::getTemplateVariablePrefix ( )

protected

Returns: string

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

Referenced by renderStateButton(), and renderTargetState().

Here is the caller graph for this function:

◆ render()

ilAbstractBuddySystemRelationStateButtonRenderer::render ( )

protected

Definition at line 59 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 79 of file class.ilAbstractBuddySystemRelationStateButtonRenderer.php.

References ilStr\convertUpperCamelCaseToUnderscoreCase(), and getTemplateVariablePrefix().

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

Parameters

ilBuddySystemRelationState $target_state

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

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

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),
             get_class($target_state)
         );
         $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
             )
         );
     }