ilBulkEditQuestionsGUI: ilFormPropertyDispatchGUI More...

Collaboration diagram for ilBulkEditQuestionsGUI:

Public Member Functions
	__construct (protected ilGlobalTemplateInterface $tpl, protected ilCtrl $ctrl, protected ilLanguage $lng, protected UIFactory $ui_factory, protected UIRenderer $ui_renderer, protected Refinery $refinery, protected ServerRequestInterface $request, protected RequestWrapper $request_wrapper, protected int $qpl_obj_id,)

	executeCommand ()

Data Fields
const	PARAM_IDS = 'qids'

const	CMD_EDITTAUTHOR = 'bulkedit_author'

const	CMD_SAVEAUTHOR = 'bulksave_author'

const	CMD_EDITLIFECYCLE = 'bulkedit_lifecycle'

const	CMD_SAVELIFECYCLE = 'bulksave_lifecycle'

const	CMD_EDITTAXONOMIES = 'bulkedit_taxonomies'

const	CMD_SAVETAXONOMIES = 'bulksave_taxonomies'

const	CMD_SAVETAXONOMIESADD = 'bulksave_taxonomies_add'

Protected Member Functions
	getQuestionIds ()

	store (Form\Standard $form, Closure $update)

	getQuestions ()

	getShiftTrafo ()

	getFormAuthor ()

	getAuthorUpdater ()

	getFormLifecycle ()

	getLifecycleUpdater ()

	getFormTaxonomies ()

	storeTaxonomies (ilPropertyFormGUI $form)

Protected Attributes
array	$question_ids = []

Detailed Description

ilBulkEditQuestionsGUI: ilFormPropertyDispatchGUI

Definition at line 33 of file class.ilBulkEditQuestionsGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilBulkEditQuestionsGUI::__construct	(	protected ilGlobalTemplateInterface	$tpl,
		protected ilCtrl	$ctrl,
		protected ilLanguage	$lng,
		protected UIFactory	$ui_factory,
		protected UIRenderer	$ui_renderer,
		protected Refinery	$refinery,
		protected ServerRequestInterface	$request,
		protected RequestWrapper	$request_wrapper,
		protected int	$qpl_obj_id
	)

Definition at line 44 of file class.ilBulkEditQuestionsGUI.php.

54 {

55 }

Member Function Documentation

◆ executeCommand()

ilBulkEditQuestionsGUI::executeCommand ( )

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

References $out, ILIAS\Repository\ctrl(), getAuthorUpdater(), getFormAuthor(), getFormLifecycle(), getFormTaxonomies(), getLifecycleUpdater(), getQuestionIds(), ILIAS\Repository\lng(), store(), and storeTaxonomies().

                                     : void
     {
         $cmd = $this->ctrl->getCmd();
         $this->ctrl->saveParameter($this, self::PARAM_IDS);
 
         $this->question_ids = $this->getQuestionIds();
 
         $out = [];
 
         if ($this->question_ids === []) {
             $out[] = $this->ui_factory->messageBox()->failure(
                 $this->lng->txt('qpl_bulkedit_no_ids')
             );
 
         } else {
 
             switch ($cmd) {
                 case self::CMD_EDITTAUTHOR:
                     $out[] = $this->getFormAuthor();
                     break;
                 case self::CMD_SAVEAUTHOR:
                     $out = array_merge($out, $this->store(
                         $this->getFormAuthor(),
                         $this->getAuthorUpdater()
                     ));
                     break;
 
                 case self::CMD_EDITLIFECYCLE:
                     $out[] = $this->getFormLifecycle();
                     break;
                 case self::CMD_SAVELIFECYCLE:
                     $out = array_merge($out, $this->store(
                         $this->getFormLifecycle(),
                         $this->getLifecycleUpdater()
                     ));
                     break;
 
                 case self::CMD_EDITTAXONOMIES:
                     $out[] = $this->ui_factory->legacy()->content($this->getFormTaxonomies()->getHTML());
                     break;
                 case self::CMD_SAVETAXONOMIES:
                 case self::CMD_SAVETAXONOMIESADD:
                     $out = array_merge($out, $this->storeTaxonomies($this->getFormTaxonomies()));
                     break;
 
                 default:
                     throw new \Exception("'$cmd'" . " not implemented");
             }
         }
 
         $this->tpl->setContent($this->ui_renderer->render($out));
     }

Here is the call graph for this function:

◆ getAuthorUpdater()

ilBulkEditQuestionsGUI::getAuthorUpdater ( )

protected

Definition at line 166 of file class.ilBulkEditQuestionsGUI.php.

References $q.

Referenced by executeCommand().

                                          : \Closure
     {
         return function (array $questions, string $author) {
             foreach ($questions as $q) {
                 $q->setAuthor($author);
                 $q->saveQuestionDataToDb();
             }
             return true;
         };
     }

Here is the caller graph for this function:

◆ getFormAuthor()

ilBulkEditQuestionsGUI::getFormAuthor ( )

protected

Definition at line 153 of file class.ilBulkEditQuestionsGUI.php.

References ILIAS\Repository\ctrl(), getShiftTrafo(), ILIAS\Repository\lng(), and ILIAS\UI\Implementation\Component\Input\ViewControl\withAdditionalTransformation().

Referenced by executeCommand().

                                       : Form\Standard
     {
         return $this->ui_factory->input()->container()->form()->standard(
             $this->ctrl->getFormAction($this, self::CMD_SAVEAUTHOR),
             [
                 $this->ui_factory->input()->field()
                     ->text($this->lng->txt('author'))
                     ->withRequired(true)
             ]
         )
         ->withAdditionalTransformation($this->getShiftTrafo());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFormLifecycle()

ilBulkEditQuestionsGUI::getFormLifecycle ( )

protected

Definition at line 177 of file class.ilBulkEditQuestionsGUI.php.

References $lifecycle, ILIAS\Repository\ctrl(), ilAssQuestionLifecycle\getDraftInstance(), getShiftTrafo(), ILIAS\Repository\lng(), and ILIAS\UI\Implementation\Component\Input\ViewControl\withAdditionalTransformation().

Referenced by executeCommand().

                                          : Form\Standard
     {
         $lifecycle = \ilAssQuestionLifecycle::getDraftInstance();
         $options = $lifecycle->getSelectOptions($this->lng);
         return $this->ui_factory->input()->container()->form()->standard(
             $this->ctrl->getFormAction($this, self::CMD_SAVELIFECYCLE),
             [
                 $this->ui_factory->input()->field()
                     ->select($this->lng->txt('qst_lifecycle'), $options)
                     ->withRequired(true)
             ]
         )
         ->withAdditionalTransformation($this->getShiftTrafo());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFormTaxonomies()

ilBulkEditQuestionsGUI::getFormTaxonomies ( )

protected

Definition at line 204 of file class.ilBulkEditQuestionsGUI.php.

References ILIAS\Repository\ctrl(), ilObjTaxonomy\getUsageOfObject(), ILIAS\Repository\lng(), and ilFormPropertyGUI\setTitle().

Referenced by executeCommand().

                                           : ilPropertyFormGUI
     {
         $form = new ilPropertyFormGUI();
         $form->setFormAction($this->ctrl->getFormAction($this, self::CMD_SAVETAXONOMIES));
         $taxonomy_ids = \ilObjTaxonomy::getUsageOfObject($this->qpl_obj_id);
 
         //taken from assQuestionGUI::populateTaxonomyFormSection
         foreach ($taxonomy_ids as $taxonomy_id) {
             $taxonomy = new ilObjTaxonomy($taxonomy_id);
             $label = sprintf($this->lng->txt('qpl_qst_edit_form_taxonomy'), $taxonomy->getTitle());
             $postvar = "tax_node_assign_$taxonomy_id";
             // selector not working due to failing modals, actually:
             // $taxSelect = new ilTaxSelectInputGUI($taxonomy->getId(), $postvar, true);
             $taxSelect = new ilTaxAssignInputGUI($taxonomy->getId(), true, $label, $postvar, true);
             $taxSelect->setTitle($label);
             $form->addItem($taxSelect);
         }
         $form->addCommandButton(self::CMD_SAVETAXONOMIES, $this->lng->txt("qpl_bulk_save_overwrite"));
         $form->addCommandButton(self::CMD_SAVETAXONOMIESADD, $this->lng->txt("qpl_bulk_save_add"));
         return $form;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLifecycleUpdater()

ilBulkEditQuestionsGUI::getLifecycleUpdater ( )

protected

Definition at line 192 of file class.ilBulkEditQuestionsGUI.php.

References $lifecycle, $q, and ilAssQuestionLifecycle\getInstance().

Referenced by executeCommand().

                                             : \Closure
     {
         return function (array $questions, string $lifecycle) {
             $lc = ilAssQuestionLifecycle::getInstance($lifecycle);
             foreach ($questions as $q) {
                 $q->setLifecycle($lc);
                 $q->saveToDb();
             }
             return true;
         };
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getQuestionIds()

ilBulkEditQuestionsGUI::getQuestionIds ( )

protected

Definition at line 112 of file class.ilBulkEditQuestionsGUI.php.

References ILIAS\Repository\refinery().

Referenced by executeCommand().

                                        : array
     {
         if (!$this->request_wrapper->has(self::PARAM_IDS)) {
             return [];
         }
         $trafo = $this->refinery->custom()->transformation(
             fn($v) => array_map('intval', explode(',', $v))
         );
         return $this->request_wrapper->retrieve(self::PARAM_IDS, $trafo);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getQuestions()

ilBulkEditQuestionsGUI::getQuestions ( )

protected

Definition at line 137 of file class.ilBulkEditQuestionsGUI.php.

References assQuestion\instantiateQuestion().

Referenced by store(), and storeTaxonomies().

                                      : array
     {
         $questions = [];
         foreach ($this->question_ids as $qid) {
             $questions[] = \assQuestion::instantiateQuestion($qid);
         }
         return $questions;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getShiftTrafo()

ilBulkEditQuestionsGUI::getShiftTrafo ( )

protected

Definition at line 146 of file class.ilBulkEditQuestionsGUI.php.

References ILIAS\Repository\refinery().

Referenced by getFormAuthor(), and getFormLifecycle().

                                       : Transformation
     {
         return $this->refinery->custom()->transformation(
             fn(array $v) => array_shift($v)
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ store()

ilBulkEditQuestionsGUI::store	(	Form\Standard	$form,
		Closure	$update
	)

protected

Definition at line 123 of file class.ilBulkEditQuestionsGUI.php.

References $data, $out, ILIAS\Repository\ctrl(), ilObjQuestionPoolGUI\DEFAULT_CMD, getQuestions(), ILIAS\Repository\lng(), and null.

Referenced by executeCommand().

                                                                   : array
     {
         $out = [];
         $form = $form->withRequest($this->request);
         $data = $form->getData();
         $questions = $this->getQuestions();
         if ($data !== null && $update($questions, $data)) {
             $this->tpl->setOnScreenMessage('success', $this->lng->txt('qpl_bulkedit_success'), true);
             $this->ctrl->redirectByClass(ilObjQuestionPoolGUI::class, ilObjQuestionPoolGUI::DEFAULT_CMD);
         }
         $out[] = $form;
         return $out;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ storeTaxonomies()

ilBulkEditQuestionsGUI::storeTaxonomies ( ilPropertyFormGUI $form )

protected

Definition at line 226 of file class.ilBulkEditQuestionsGUI.php.

References $post, $q, ilObject\_lookupType(), ILIAS\Repository\ctrl(), ilObjQuestionPoolGUI\DEFAULT_CMD, ilTaxNodeAssignment\getAssignmentsOfItem(), getQuestions(), ilObjTaxonomy\getUsageOfObject(), ILIAS\Repository\int(), and ILIAS\Repository\lng().

Referenced by executeCommand().

                                                                : void
     {
         $questions = $this->getQuestions();
         $post = $this->request->getParsedBody();
         $form_cmd = array_shift($post['cmd']);
         $overwrite = ($form_cmd === $this->lng->txt('qpl_bulk_save_overwrite'));
 
         $taxonomy_ids = \ilObjTaxonomy::getUsageOfObject($this->qpl_obj_id);
         foreach ($taxonomy_ids as $taxonomy_id) {
             $postvar = "tax_node_assign_$taxonomy_id";
             foreach ($questions as $q) {
                 $assignments = new ilTaxNodeAssignment(ilObject::_lookupType($q->getObjId()), $q->getObjId(), 'quest', $taxonomy_id);
                 $assigned_nodes = $assignments->getAssignmentsOfItem($q->getId());
 
                 $skip = [];
                 foreach ($assigned_nodes as $existing) {
                     if ($overwrite && !in_array($existing["node_id"], $post[$postvar])
                     ) {
                         $assignments->deleteAssignment((int) $existing["node_id"], $q->getId());
                     } else {
                         $skip[] = (int) $existing["node_id"];
                     }
                 }
 
                 $values = $post[$postvar];
                 foreach ($values as $value) {
                     if (!in_array((int) $value, $skip)) {
                         $assignments->addAssignment((int) $value, $q->getId());
                     }
                 }
             }
         }
         $this->tpl->setOnScreenMessage('success', $this->lng->txt('qpl_bulkedit_success'), true);
         $this->ctrl->redirectByClass(ilObjQuestionPoolGUI::class, ilObjQuestionPoolGUI::DEFAULT_CMD);
     }