ILIAS\Blog\Contributor\ContributorGUI Class Reference

@ilCtrl_Calls ILIAS\Blog\Contributor\ContributorGUI: ilRepositorySearchGUI More...

Collaboration diagram for ILIAS\Blog\Contributor\ContributorGUI:

Public Member Functions
	__construct (protected InternalDataService $data, protected InternalDomainService $domain, protected InternalGUIService $gui, protected int $node_id, protected \ilObjBlog $blog)
	executeCommand ()
	contributors ()
	addUserFromAutoComplete ()
	Autocomplete submit. More...
	addContributor (array $a_user_ids=array(), ?string $a_user_type=null)
	Centralized method to add contributors. More...
	confirmRemoveContributor (array $ids=[])
	Used in ContributorTableBuilder. More...
	removeContributor ()
	addContributorContainerAction (array $ids=[])
	Used in ContributorTableBuilder. More...

Detailed Description

@ilCtrl_Calls ILIAS\Blog\Contributor\ContributorGUI: ilRepositorySearchGUI

Definition at line 33 of file ContributorGUI.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Blog\Contributor\ContributorGUI::__construct	(	protected InternalDataService	$data,
		protected InternalDomainService	$domain,
		protected InternalGUIService	$gui,
		protected int	$node_id,
		protected \ilObjBlog	$blog
	)

Definition at line 35 of file ContributorGUI.php.

      {
    }

Member Function Documentation

addContributor()

ILIAS\Blog\Contributor\ContributorGUI::addContributor	(	array	$a_user_ids = array(),
		?string	$a_user_type = null
	)

Centralized method to add contributors.

Definition at line 148 of file ContributorGUI.php.

     : void {
        $ilCtrl = $this->gui->ctrl();
        $lng = $this->domain->lng();
        $rbacreview = $this->domain->rbac()->review();
        $rbacadmin = $this->domain->rbac()->admin();
        $a_user_type = (int) $a_user_type;
 
        if (empty($a_user_ids)) {
            $a_user_ids = $this->gui->standardRequest()->getIds();
        }
 
        if (!count($a_user_ids) || !$a_user_type) {
            $this->gui->ui()->mainTemplate()->setOnScreenMessage('failure', $lng->txt("no_checkbox"));
            $this->contributors();
            return;
        }
 
        // get contributor role
        $local_roles = array_keys($this->blog->getAllLocalRoles($this->node_id));
        if (!in_array($a_user_type, $local_roles)) {
            $this->gui->ui()->mainTemplate()->setOnScreenMessage('failure', $lng->txt("missing_perm"));
            $this->contributors();
            return;
        }
 
        foreach ($a_user_ids as $user_id) {
            $user_id = (int) $user_id;
            $a_user_type = (int) $a_user_type;
            if (!$rbacreview->isAssigned($user_id, $a_user_type)) {
                $rbacadmin->assignUser($a_user_type, $user_id);
            }
        }
 
        $this->gui->ui()->mainTemplate()->setOnScreenMessage('success', $lng->txt("settings_saved"), true);
        $ilCtrl->redirect($this, "contributors");
    }

Referenced by ILIAS\Blog\Contributor\ContributorGUI\addUserFromAutoComplete().

Here is the caller graph for this function:

addContributorContainerAction()

ILIAS\Blog\Contributor\ContributorGUI::addContributorContainerAction

(

array

$ids = []

)

Used in ContributorTableBuilder.

Definition at line 252 of file ContributorGUI.php.

                                                                  : void
    {
        if (empty($ids)) {
            $ids = $this->gui->standardRequest()->getIds();
        }
 
        // This would typically add contributors from a container
        // For now, redirecting back to contributors as this seems to be a placeholder action
        $this->gui->ctrl()->redirect($this, "contributors");
    }

addUserFromAutoComplete()

ILIAS\Blog\Contributor\ContributorGUI::addUserFromAutoComplete

(

)

Autocomplete submit.

Definition at line 114 of file ContributorGUI.php.

                                             : void
    {
        $lng = $this->domain->lng();
        $req = $this->gui->standardRequest();
 
        $user_login = $req->getUserLogin();
        $user_type = $req->getUserType();
 
        if (trim($user_login) === '') {
            $this->gui->ui()->mainTemplate()->setOnScreenMessage('failure', $lng->txt('msg_no_search_string'));
            $this->contributors();
            return;
        }
        $users = explode(',', $user_login);
 
        $user_ids = array();
        foreach ($users as $user) {
            $user_id = ilObjUser::_lookupId($user);
 
            if (!$user_id) {
                $this->gui->ui()->mainTemplate()->setOnScreenMessage('failure', $lng->txt('user_not_known'));
                $this->contributors();
                return;
            }
 
            $user_ids[] = (int) $user_id;
        }
 
        $this->addContributor($user_ids, $user_type);
    }

References $lng, XapiProxy\$req, $user_id, ilObjUser\_lookupId(), ILIAS\Blog\Contributor\ContributorGUI\addContributor(), ILIAS\Blog\Contributor\ContributorGUI\contributors(), and ILIAS\Repository\int().

Here is the call graph for this function:

confirmRemoveContributor()

ILIAS\Blog\Contributor\ContributorGUI::confirmRemoveContributor

(

array

$ids = []

)

Used in ContributorTableBuilder.

Definition at line 191 of file ContributorGUI.php.

                                                             : void
    {
        if (empty($ids)) {
            $ids = $this->gui->standardRequest()->getIds();
        }
        if (count($ids) === 0) {
            $this->gui->ui()->mainTemplate()->setOnScreenMessage('failure', $this->domain->lng()->txt("select_one"), true);
            $this->gui->ctrl()->redirect($this, "contributors");
        }
 
        $confirm = new ilConfirmationGUI();
        $confirm->setHeaderText($this->domain->lng()->txt('blog_confirm_delete_contributors'));
        $confirm->setFormAction($this->gui->ctrl()->getFormAction($this, 'removeContributor'));
        $confirm->setConfirm($this->domain->lng()->txt('delete'), 'removeContributor');
        $confirm->setCancel($this->domain->lng()->txt('cancel'), 'contributors');
 
        foreach ($ids as $user_id) {
            $confirm->addItem(
                'id[]',
                (string) $user_id,
                \ilUserUtil::getNamePresentation($user_id, false, false, "", true)
            );
        }
 
        $this->gui->ui()->mainTemplate()->setContent($confirm->getHTML());
    }

References $user_id, and ilUserUtil\getNamePresentation().

Here is the call graph for this function:

contributors()

ILIAS\Blog\Contributor\ContributorGUI::contributors

(

)

Definition at line 67 of file ContributorGUI.php.

                                  : void
    {
        $ilTabs = $this->gui->tabs();
        $ilToolbar = $this->gui->toolbar();
        $ilCtrl = $this->gui->ctrl();
        $lng = $this->domain->lng();
        $tpl = $this->gui->ui()->mainTemplate();
 
        $ilTabs->activateTab("contributors");
 
        $local_roles = $this->blog->getAllLocalRoles($this->node_id);
 
        // add member
        ilRepositorySearchGUI::fillAutoCompleteToolbar(
            $this,
            $ilToolbar,
            array(
                'auto_complete_name' => $lng->txt('user'),
                'submit_name' => $lng->txt('add'),
                'add_search' => true,
                'add_from_container' => $this->node_id,
                'user_type' => $local_roles
            ),
            true
        );
 
        $other_roles = $this->blog->getRolesWithContributeOrRedact($this->node_id);
        if ($other_roles) {
            $tpl->setOnScreenMessage('info', sprintf($lng->txt("blog_contribute_other_roles"), implode(", ", $other_roles)));
        }
 
        $table = $this->gui->contributor()->contributorTableBuilder(
            $this->blog->getAllLocalRoles($this->node_id),
            $this,
            "contributors"
        )->getTable();
 
        if ($table->handleCommand()) {
            return;
        }
 
        $tpl->setContent($table->render());
    }

References $lng, ILIAS\News\Common\Table\$tpl, ilRepositorySearchGUI\fillAutoCompleteToolbar(), ILIAS\UICore\GlobalTemplate\setContent(), and ILIAS\UICore\GlobalTemplate\setOnScreenMessage().

Referenced by ILIAS\Blog\Contributor\ContributorGUI\addUserFromAutoComplete().

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ILIAS\Blog\Contributor\ContributorGUI::executeCommand

(

)

Definition at line 44 of file ContributorGUI.php.

                                    : void
    {
        $ctrl = $this->gui->ctrl();
        $next_class = $ctrl->getNextClass($this);
        $cmd = $ctrl->getCmd("contributors");
 
        switch ($next_class) {
            case strtolower(\ilRepositorySearchGUI::class):
                $rep_search = new \ilRepositorySearchGUI();
                $rep_search->setTitle($this->domain->lng()->txt("blog_add_contributor"));
                $rep_search->setCallback($this, 'addContributor', $this->blog->getAllLocalRoles($this->node_id));
                $ctrl->setReturn($this, 'contributors');
                $ctrl->forwardCommand($rep_search);
                break;
 
            default:
                if (method_exists($this, $cmd)) {
                    $this->$cmd();
                }
                break;
        }
    }

removeContributor()

ILIAS\Blog\Contributor\ContributorGUI::removeContributor

(

)

Definition at line 218 of file ContributorGUI.php.

                                       : void
    {
        $ilCtrl = $this->gui->ctrl();
        $lng = $this->domain->lng();
        $rbacadmin = $this->domain->rbac()->admin();
 
        $ids = $this->gui->standardRequest()->getIds();
 
        if (count($ids) === 0) {
            $this->gui->ui()->mainTemplate()->setOnScreenMessage('failure', $lng->txt("select_one"), true);
            $ilCtrl->redirect($this, "contributors");
        }
 
        // get contributor role
        $local_roles = array_keys($this->blog->getAllLocalRoles($this->node_id));
        if (!$local_roles) {
            $this->gui->ui()->mainTemplate()->setOnScreenMessage('failure', $lng->txt("missing_perm"));
            $this->contributors();
            return;
        }
 
        foreach ($ids as $user_id) {
            foreach ($local_roles as $role_id) {
                $rbacadmin->deassignUser($role_id, $user_id);
            }
        }
 
        $this->gui->ui()->mainTemplate()->setOnScreenMessage('success', $lng->txt("settings_saved"), true);
        $this->gui->ctrl()->redirect($this, "contributors");
    }

References $lng, and $user_id.

---

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

• components/ILIAS/Blog/Contributor/ContributorGUI.php