Collaboration diagram for ilRepositoryObjectSearchGUI:

Public Member Functions
	__construct (int $a_ref_id, object $a_parent_obj, string $a_parent_cmd)

	executeCommand ()

	getLang ()

	getCtrl ()

	getRefId ()

	getObject ()

	getParentGUI ()

	getParentCmd ()

	getResultTableInstance ()

Static Public Member Functions
static	getSearchBlockHTML (string $a_title)

Protected Member Functions
	performSearch ()

Protected Attributes
ilLanguage	$lng

ilCtrl	$ctrl

ilAccess	$access

ilGlobalTemplateInterface	$tpl

ilObjectDefinition	$obj_definition

GlobalHttpState	$http

Factory	$refinery

Private Attributes
int	$ref_id

ilObject	$object

object	$parent_obj

string	$parent_cmd

Detailed Description

Definition at line 19 of file class.ilRepositoryObjectSearchGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilRepositoryObjectSearchGUI::__construct	(	int	$a_ref_id,
		object	$a_parent_obj,
		string	$a_parent_cmd
	)

Definition at line 38 of file class.ilRepositoryObjectSearchGUI.php.

References $DIC, Vendor\Package\$e, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ilObjectFactory\getInstanceByRefId(), getRefId(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

     {
         global $DIC;
 
         $this->lng = $DIC->language();
         $this->ctrl = $DIC->ctrl();
         $this->access = $DIC->access();
         $this->tpl = $DIC->ui()->mainTemplate();
         $this->obj_definition = $DIC['objDefinition'];
 
         $this->ref_id = $a_ref_id;
         $this->http = $DIC->http();
         $this->refinery = $DIC->refinery();
 
         try {
             $repo_object = ilObjectFactory::getInstanceByRefId($this->getRefId());
             if ($repo_object instanceof ilObject) {
                 $this->object = $repo_object;
             }
         } catch (ilObjectNotFoundException $e) {
             throw $e;
         }
         $this->parent_obj = $a_parent_obj;
         $this->parent_cmd = $a_parent_cmd;
     }

Here is the call graph for this function:

Member Function Documentation

◆ executeCommand()

ilRepositoryObjectSearchGUI::executeCommand ( )

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

References ILIAS\Repository\access(), getCtrl(), getParentGUI(), and ILIAS\Repository\lng().

                                     : void
     {
         if (!$this->access->checkAccess('read', '', $this->getObject()->getRefId())) {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt("permission_denied"), true);
             $this->getCtrl()->returnToParent($this->getParentGUI());
         }
 
         $next_class = $this->getCtrl()->getNextClass();
         $cmd = $this->getCtrl()->getCmd();
 
 
         switch ($next_class) {
             default:
                 $this->$cmd();
                 break;
         }
     }

Here is the call graph for this function:

◆ getCtrl()

ilRepositoryObjectSearchGUI::getCtrl ( )

Definition at line 93 of file class.ilRepositoryObjectSearchGUI.php.

References $ctrl.

Referenced by executeCommand(), and performSearch().

                              : ilCtrl
     {
         return $this->ctrl;
     }

Here is the caller graph for this function:

◆ getLang()

ilRepositoryObjectSearchGUI::getLang ( )

Definition at line 88 of file class.ilRepositoryObjectSearchGUI.php.

References $lng.

                              : ilLanguage
     {
         return $this->lng;
     }

◆ getObject()

ilRepositoryObjectSearchGUI::getObject ( )

Definition at line 104 of file class.ilRepositoryObjectSearchGUI.php.

References $object.

Referenced by getResultTableInstance().

                                : ilObject
     {
         return $this->object;
     }

Here is the caller graph for this function:

◆ getParentCmd()

ilRepositoryObjectSearchGUI::getParentCmd ( )

Definition at line 114 of file class.ilRepositoryObjectSearchGUI.php.

References $parent_cmd.

                                   : string
     {
         return $this->parent_cmd;
     }

◆ getParentGUI()

ilRepositoryObjectSearchGUI::getParentGUI ( )

Definition at line 109 of file class.ilRepositoryObjectSearchGUI.php.

References $parent_obj.

Referenced by executeCommand().

                                   : object
     {
         return $this->parent_obj;
     }

Here is the caller graph for this function:

◆ getRefId()

ilRepositoryObjectSearchGUI::getRefId ( )

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

References $ref_id.

Referenced by __construct(), getResultTableInstance(), and performSearch().

                               : int
     {
         return $this->ref_id;
     }

Here is the caller graph for this function:

◆ getResultTableInstance()

ilRepositoryObjectSearchGUI::getResultTableInstance ( )

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

References $location, getObject(), and getRefId().

Referenced by performSearch().

                                             : ?object
     {
         $class = $this->obj_definition->getClassName($this->getObject()->getType());
         $location = $this->obj_definition->getLocation($this->getObject()->getType());
         $full_class = "ilObj" . $class . "SearchResultTableGUI";
 
         if (include_once($location . "/class." . $full_class . ".php")) {
             return new $full_class(
                 $this,
                 'performSearch',
                 $this->getRefId()
             );
         }
         return null;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSearchBlockHTML()

static ilRepositoryObjectSearchGUI::getSearchBlockHTML ( string $a_title )

static

Definition at line 64 of file class.ilRepositoryObjectSearchGUI.php.

Referenced by ilObjWikiGUI\renderSideBlock(), and ilObjForumGUI\setSideBlocks().

                                                               : string
     {
         $block = new ilRepositoryObjectSearchBlockGUI($a_title);
         return $block->getHTML();
     }

Here is the caller graph for this function:

◆ performSearch()

ilRepositoryObjectSearchGUI::performSearch ( )

protected

Exceptions

Exception

Definition at line 122 of file class.ilRepositoryObjectSearchGUI.php.

References Vendor\Package\$e, ilObject\_lookupObjId(), getCtrl(), getRefId(), getResultTableInstance(), ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

                                       : bool
     {
         try {
             $search = new ilRepositoryObjectDetailSearch(ilObject::_lookupObjId($this->getRefId()));
 
             $search_term = '';
             if ($this->http->wrapper()->post()->has('search_term')) {
                 $search_term = $this->http->wrapper()->post()->retrieve(
                     'search_term',
                     $this->refinery->kindlyTo()->string()
                 );
             }
             $search->setQueryString($search_term);
             $result = $search->performSearch();
         } catch (Exception $e) {
             $this->tpl->setOnScreenMessage('failure', $e->getMessage(), true);
             $this->getCtrl()->returnToParent($this);
             return false;
         }
         // @todo: add a factory to allow overwriting of search result presentation
         $result_table = $this->getResultTableInstance();
         $result_table->setSearchTerm($search_term);
         $result_table->setResults($result);
 
         $result_table->init();
         $result_table->parse();
 
         $this->tpl->setContent($result_table->getHTML());
         return true;
     }