This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilObjWiki:

Collaboration diagram for ilObjWiki:

Public Member Functions
	__construct (int $a_id=0, bool $a_call_by_reference=true)

	setOnline (bool $a_online)

	getOnline ()

	setRatingOverall (bool $a_rating)

	setRating (bool $a_rating)

	getRatingOverall ()

	setRatingPages (bool $a_rating)

	getRatingPages ()

	setRatingAsBlock (bool $a_rating)

	getRatingAsBlock ()

	setRatingForNewPages (bool $a_rating)

	getRatingForNewPages ()

	setRatingCategories (bool $a_rating)

	getRatingCategories ()

	setPublicNotes (bool $a_val)

	getPublicNotes ()

	setStartPage (string $a_startpage)

	getStartPage ()

	setShortTitle (string $a_shorttitle)

	getShortTitle ()

	setIntroduction (string $a_introduction)

	getIntroduction ()

	setPageToc (bool $a_val)

	getPageToc ()

	setEmptyPageTemplate (bool $a_val)

	getEmptyPageTemplate ()

	setLinkMetadataValues (bool $a_val)

	getLinkMetadataValues ()

	create (bool $a_prevent_start_page_creation=false)

	update (bool $a_prevent_start_page_creation=false)

	read ()

	delete ()
	delete object and all related data More...

	isImportantPage (int $a_page_id)

	cloneObject (int $target_id, int $copy_id=0, bool $omit_tree=false)

	getTemplateSelectionOnCreation (string $lang="-")
	Get template selection on creation? If more than one template (including empty page template) is activated -> return true. More...

	createWikiPage (string $a_page_title, int $a_template_page=0)
	Create new wiki page. More...

	initUserHTMLExport (bool $with_comments=false)

	startUserHTMLExport (bool $with_comments=false)

	getUserHTMLExportProgress (bool $with_comments=false)
	Get user html export progress. More...

	deliverUserHTMLExport (bool $with_comments=false)

	decorateAdvMDValue (string $a_value)
	Decorate adv md value. More...

	isCommentsExportPossible ()
	Is export possible. More...

Public Member Functions inherited from ilObject
	getObjectProperties ()

	flushObjectProperties ()

	withReferences ()
	determines whether objects are referenced or not (got ref ids or not) More...

	processAutoRating ()

	read ()

	getId ()

	setId (int $id)

	setRefId (int $ref_id)

	getRefId ()

	getType ()

	setType (string $type)

	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions More...

	getTitle ()

	getUntranslatedTitle ()
	Get untranslated object title WebDAV needs to access the untranslated title of an object. More...

	setTitle (string $title)

	getDescription ()

	setDescription (string $description)

	getLongDescription ()
	get object long description (stored in object_description) More...

	getImportId ()

	setImportId (string $import_id)

	setOfflineStatus (bool $status)

	getOfflineStatus ()

	supportsOfflineHandling ()

	getOwner ()

	getOwnerName ()
	get full name of object owner More...

	setOwner (int $usr_id)

	getCreateDate ()
	Get create date in YYYY-MM-DD HH-MM-SS format. More...

	getLastUpdateDate ()
	Get last update date in YYYY-MM-DD HH-MM-SS format. More...

	create ()
	note: title, description and type should be set when this function is called More...

	update ()

	MDUpdateListener (string $element)
	Metadata update listener. More...

	createMetaData ()

	updateMetaData ()

	deleteMetaData ()

	updateOwner ()
	update owner of object in db More...

	putInTree (int $parent_ref_id)
	maybe this method should be in tree object!? More...

	setPermissions (int $parent_ref_id)

	setParentRolePermissions (int $parent_ref_id)
	Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g. More...

	createReference ()
	creates reference for object More...

	countReferences ()

	delete ()
	delete object or referenced object (in the case of a referenced object, object data is only deleted if last reference is deleted) This function removes an object entirely from system!! More...

	initDefaultRoles ()
	init default roles settings Purpose of this function is to create a local role folder and local roles, that are needed depending on the object type. More...

	applyDidacticTemplate (int $tpl_id)

	getXMLZip ()

	getHTMLDirectory ()

	appendCopyInfo (int $target_id, int $copy_id, int $new_obj_id)
	Prepend Copy info if object with same name exists in that container. More...

	cloneDependencies (int $target_id, int $copy_id)
	Clone object dependencies. More...

	cloneMetaData (ilObject $target_obj)
	Copy meta data. More...

	selfOrParentWithRatingEnabled ()

	getPossibleSubObjects (bool $filter=true)
	get all possible sub objects of this type the object can decide which types of sub objects are possible jut in time overwrite if the decision distinguish from standard model More...

Static Public Member Functions
static	checkShortTitleAvailability (string $a_short_title)

static	_lookupRatingOverall (int $a_wiki_id)
	Lookup whether rating is activated for whole object. More...

static	_lookupRating (int $a_wiki_id)
	Lookup whether rating is activated. More...

static	_lookupRatingCategories (int $a_wiki_id)
	Lookup whether rating categories are activated. More...

static	_lookupRatingAsBlock (int $a_wiki_id)
	Lookup whether rating side block is activated. More...

static	_lookupPublicNotes (int $a_wiki_id)
	Lookup whether public notes are activated. More...

static	_lookupLinkMetadataValues (int $a_wiki_id)
	Lookup whether metadata should be auto linked. More...

static	_lookupStartPage (int $a_wiki_id)

static	writeStartPage (int $a_id, string $a_name)

static	_performSearch (int $a_wiki_id, string $a_searchterm)
	Search in Wiki. More...

static	_lookupPageToc (int $a_wiki_id)

static	getAdvMDSubItemTitle (int $a_obj_id, string $a_sub_type, int $a_sub_id)

Static Public Member Functions inherited from ilObject
static	_lookupObjIdByImportId (string $import_id)
	Get (latest) object id for an import id. More...

static	_lookupImportId (int $obj_id)

static	_lookupOwnerName (int $owner_id)
	Lookup owner name for owner id. More...

static	_getIdForImportId (string $import_id)

static	_getAllReferences (int $id)
	get all reference ids for object ID More...

static	_lookupTitle (int $obj_id)

static	lookupOfflineStatus (int $obj_id)
	Lookup offline status using objectDataCache. More...

static	_lookupOwner (int $obj_id)
	Lookup owner user ID for object ID. More...

static	_getIdsForTitle (string $title, string $type='', bool $partial_match=false)

static	_lookupDescription (int $obj_id)

static	_lookupLastUpdate (int $obj_id, bool $formatted=false)

static	_getLastUpdateOfObjects (array $obj_ids)

static	_lookupObjId (int $ref_id)

static	_setDeletedDate (int $ref_id, int $deleted_by)

static	setDeletedDates (array $ref_ids, int $user_id)

static	_resetDeletedDate (int $ref_id)

static	_lookupDeletedDate (int $ref_id)

static	_writeTitle (int $obj_id, string $title)
	write title to db (static) More...

static	_writeDescription (int $obj_id, string $desc)
	write description to db (static) More...

static	_writeImportId (int $obj_id, string $import_id)
	write import id to db (static) More...

static	_lookupType (int $id, bool $reference=false)

static	_isInTrash (int $ref_id)

static	_hasUntrashedReference (int $obj_id)
	checks whether an object has at least one reference that is not in trash More...

static	_lookupObjectId (int $ref_id)

static	_getObjectsDataForType (string $type, bool $omit_trash=false)
	get all objects of a certain type More...

static	_exists (int $id, bool $reference=false, ?string $type=null)
	checks if an object exists in object_data More...

static	_getObjectsByType (string $obj_type="", ?int $owner=null)

static	_prepareCloneSelection (array $ref_ids, string $new_type, bool $show_path=true)
	Prepare copy wizard object selection. More...

static	getIconForType (string $type)

static	_getIcon (int $obj_id=0, string $size="big", string $type="", bool $offline=false)
	Get icon for repository item. More...

static	collectDeletionDependencies (array &$deps, int $ref_id, int $obj_id, string $type, int $depth=0)
	Collect deletion dependencies. More...

static	getDeletionDependencies (int $obj_id)
	Get deletion dependencies. More...

static	getLongDescriptions (array $obj_ids)

static	getAllOwnedRepositoryObjects (int $user_id)

static	fixMissingTitles ($type, array &$obj_title_map)
	Try to fix missing object titles. More...

static	_lookupCreationDate (int $obj_id)

static	_getObjectTypeIdByTitle (string $type, ?\ilDBInterface $ilDB=null)

static	getAdvMDSubItemTitle (int $a_obj_id, string $a_sub_type, int $a_sub_id)

Protected Member Functions
	updateInternalLinksOnCopy (array $map)

Protected Member Functions inherited from ilObject
	doMDUpdateListener (string $a_element)

	beforeMDUpdateListener (string $a_element)

	doCreateMetaData ()

	beforeCreateMetaData ()

	doUpdateMetaData ()

	beforeUpdateMetaData ()

	doDeleteMetaData ()

	beforeDeleteMetaData ()

	handleAutoRating ()

	hasAutoRating ()

Protected Attributes
ILIAS Notes Service	$notes

ILIAS Wiki InternalDomainService	$domain

bool	$page_toc = false

int	$style_id = 0

string	$introduction = ""

string	$shorttitle = ""

string	$startpage = ""

bool	$rating_categories = false

bool	$rating_new_pages = false

bool	$rating = false

bool	$rating_block = false

bool	$rating_overall = false

ilObjUser	$user

bool	$online = false

bool	$public_notes = true

bool	$empty_page_templ = true

bool	$link_md_values = false

ilSetting	$setting

ILIAS Style Content DomainService	$content_style_service

Protected Attributes inherited from ilObject
ilLogger	$obj_log

ILIAS	$ilias

ilObjectDefinition	$obj_definition

ilDBInterface	$db

ilLogger	$log

ilErrorHandling	$error

ilTree	$tree

ilAppEventHandler	$app_event_handler

ilRbacAdmin	$rbac_admin

ilRbacReview	$rbac_review

ilObjUser	$user

ilLanguage	$lng

LOMServices	$lom_services

bool	$call_by_reference

int	$max_title = self::TITLE_LENGTH

int	$max_desc = self::DESC_LENGTH

bool	$add_dots = true

int	$ref_id = null

string	$type = ""

string	$title = ""

string	$desc = ""

string	$long_desc = ""

int	$owner = 0

string	$create_date = ""

string	$last_update = ""

string	$import_id = ""

bool	$register = false

Static Private Member Functions
static	_lookup (int $a_wiki_id, string $a_field)
	Lookup a data field. More...

Additional Inherited Members
Data Fields inherited from ilObject
const	TITLE_LENGTH = 255

const	DESC_LENGTH = 128

const	LONG_DESC_LENGTH = 4000

const	TABLE_OBJECT_DATA = "object_data"

array	$objectList

string	$untranslatedTitle

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Class ilObjWiki

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

◆ __construct()

ilObjWiki::__construct	(	int	$a_id = `0`,
		bool	$a_call_by_reference = `true`
	)

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

      {
        global $DIC;
 
        $this->domain = $DIC->wiki()->internal()->domain();
 
        $this->db = $DIC->database();
        $this->user = $DIC->user();
        $this->type = "wiki";
        $this->setting = $DIC->settings();
        $this->notes = $DIC->notes();
        parent::__construct($a_id, $a_call_by_reference);
 
        $this->content_style_service = $DIC
            ->contentStyle()
            ->domain();
    }

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

◆ _lookup()

static ilObjWiki::_lookup	(	int	$a_wiki_id,
		string	$a_field
	)

staticprivate

Lookup a data field.

Returns: mixed

Definition at line 407 of file class.ilObjWiki.php.

    {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $query = "SELECT $a_field FROM il_wiki_data WHERE id = " .
            $ilDB->quote($a_wiki_id, "integer");
        $set = $ilDB->query($query);
        $rec = $ilDB->fetchAssoc($set);
        return $rec[$a_field] ?? null;
    }

References $DIC, and $ilDB.

◆ _lookupLinkMetadataValues()

static ilObjWiki::_lookupLinkMetadataValues ( int $a_wiki_id )

static

Lookup whether metadata should be auto linked.

Definition at line 398 of file class.ilObjWiki.php.

                                                                    : bool
    {
        return (bool) self::_lookup($a_wiki_id, "link_md_values");
    }

◆ _lookupPageToc()

static ilObjWiki::_lookupPageToc ( int $a_wiki_id )

static

Definition at line 492 of file class.ilObjWiki.php.

     : bool {
        return (bool) self::_lookup($a_wiki_id, "page_toc");
    }

Referenced by ilWikiPageConfig\configureByObjectId().

Here is the caller graph for this function:

◆ _lookupPublicNotes()

static ilObjWiki::_lookupPublicNotes ( int $a_wiki_id )

static

Lookup whether public notes are activated.

Definition at line 390 of file class.ilObjWiki.php.

                                                             : bool
    {
        return (bool) self::_lookup($a_wiki_id, "public_notes");
    }

Referenced by ilWikiPageGUI\getCommentsHTMLExport(), and ilWikiPageGUI\preview().

Here is the caller graph for this function:

◆ _lookupRating()

static ilObjWiki::_lookupRating ( int $a_wiki_id )

static

Lookup whether rating is activated.

Definition at line 366 of file class.ilObjWiki.php.

                                                        : bool
    {
        return (bool) self::_lookup($a_wiki_id, "rating");
    }

Referenced by ilWikiFunctionsBlockGUI\getLegacyContent().

Here is the caller graph for this function:

◆ _lookupRatingAsBlock()

static ilObjWiki::_lookupRatingAsBlock ( int $a_wiki_id )

static

Lookup whether rating side block is activated.

Definition at line 382 of file class.ilObjWiki.php.

                                                               : bool
    {
        return (bool) self::_lookup($a_wiki_id, "rating_side");
    }

◆ _lookupRatingCategories()

static ilObjWiki::_lookupRatingCategories ( int $a_wiki_id )

static

Lookup whether rating categories are activated.

Definition at line 374 of file class.ilObjWiki.php.

                                                                  : bool
    {
        return (bool) self::_lookup($a_wiki_id, "rating_ext");
    }

◆ _lookupRatingOverall()

static ilObjWiki::_lookupRatingOverall ( int $a_wiki_id )

static

Lookup whether rating is activated for whole object.

Definition at line 358 of file class.ilObjWiki.php.

                                                               : bool
    {
        return (bool) self::_lookup($a_wiki_id, "rating_overall");
    }

◆ _lookupStartPage()

static ilObjWiki::_lookupStartPage ( int $a_wiki_id )

static

Definition at line 420 of file class.ilObjWiki.php.

                                                           : string
    {
        return (string) self::_lookup($a_wiki_id, "startpage");
    }

Referenced by ilObjWikiGUI\getGotoLink(), and ilWikiFunctionsBlockGUI\getLegacyContent().

Here is the caller graph for this function:

◆ _performSearch()

static ilObjWiki::_performSearch	(	int	$a_wiki_id,
		string	$a_searchterm
	)

static

Search in Wiki.

Definition at line 441 of file class.ilObjWiki.php.

     : array {
        // query parser
        $query_parser = new ilQueryParser($a_searchterm);
        $query_parser->setCombination("or");
        $query_parser->parse();
 
        $search_result = new ilSearchResult();
        if ($query_parser->validate()) {
            $wiki_search = ilObjectSearchFactory::_getWikiContentSearchInstance($query_parser);
            $wiki_search->setFilter(array('wpg'));
            $r = $wiki_search->performSearch();
            $search_result->mergeEntries($r);
        }
 
        $entries = $search_result->getEntries();
 
        $found_pages = array();
        foreach ($entries as $entry) {
            if ($entry["obj_id"] == $a_wiki_id && is_array($entry["child"])) {
                foreach ($entry["child"] as $child) {
                    $found_pages[] = array("page_id" => $child);
                }
            }
        }
        return $found_pages;
    }

Referenced by ilObjWikiGUI\performSearchObject(), and ilWikiPageGUI\searchWikiLinkAC().

Here is the caller graph for this function:

◆ checkShortTitleAvailability()

static ilObjWiki::checkShortTitleAvailability ( string $a_short_title )

static

Definition at line 334 of file class.ilObjWiki.php.

     : bool {
        global $DIC;
        $ilDB = $DIC->database();
 
        if ($a_short_title === "") {
            return true;
        }
        $res = $ilDB->queryF(
            "SELECT id FROM il_wiki_data WHERE short = %s",
            array("text"),
            array($a_short_title)
        );
        if ($ilDB->fetchAssoc($res)) {
            return false;
        }
 
        return true;
    }

◆ cloneObject()

ilObjWiki::cloneObject	(	int	$target_id,
		int	$copy_id = `0`,
		bool	$omit_tree = `false`
	)

Definition at line 498 of file class.ilObjWiki.php.

                                                                                          : ?ilObject
    {
        $new_obj = parent::cloneObject($target_id, $copy_id, $omit_tree);
 
        // Custom meta data activation is stored in a container setting
        ilContainer::_writeContainerSetting(
            $new_obj->getId(),
            ilObjectServiceSettingsGUI::CUSTOM_METADATA,
            ilContainer::_lookupContainerSetting(
                $this->getId(),
                ilObjectServiceSettingsGUI::CUSTOM_METADATA,
                0
            )
        );
 
        //copy online status if object is not the root copy object
        $cp_options = ilCopyWizardOptions::_getInstance($copy_id);
 
        if (!$cp_options->isRootNode($this->getRefId())) {
            $new_obj->setOnline($this->getOnline());
        }
 
        //$new_obj->setTitle($this->getTitle());                // see #20074
        $new_obj->setStartPage($this->getStartPage());
        $new_obj->setShortTitle($this->getShortTitle());
        $new_obj->setRatingOverall($this->getRatingOverall());
        $new_obj->setRatingPages($this->getRatingPages());
        $new_obj->setRatingAsBlock($this->getRatingAsBlock());
        $new_obj->setRatingForNewPages($this->getRatingForNewPages());
        $new_obj->setRatingCategories($this->getRatingCategories());
        $new_obj->setPublicNotes($this->getPublicNotes());
        $new_obj->setIntroduction($this->getIntroduction());
        $new_obj->setPageToc($this->getPageToc());
        $new_obj->update();
        $this->content_style_service
            ->styleForRefId($this->getRefId())
            ->cloneTo($new_obj->getId());
 
        // copy content
        $pages = ilWikiPage::getAllWikiPages($this->getId());
        if (count($pages) > 0) {
            // if we have any pages, delete the start page first
            $pg_id = ilWikiPage::getPageIdForTitle($new_obj->getId(), $new_obj->getStartPage());
            $start_page = new ilWikiPage($pg_id);
            $start_page->delete();
        }
        $map = array();
        foreach ($pages as $p) {
            $page = new ilWikiPage($p["id"]);
            $page->setWikiRefId($this->getRefId());
            $new_page = new ilWikiPage();
            $new_page->setWikiRefId($new_obj->getRefId());
            $new_page->setTitle($page->getTitle());
            $new_page->setWikiId($new_obj->getId());
            $new_page->setTitle($page->getTitle());
            $new_page->setBlocked($page->getBlocked());
            $new_page->setRating($page->getRating());
            $new_page->hideAdvancedMetadata($page->isAdvancedMetadataHidden());
            $new_page->create();
 
            $page->copy($new_page->getId(), "", 0, true);
            //$new_page->setXMLContent($page->copyXMLContent(true));
            //$new_page->buildDom(true);
            //$new_page->update();
            $map[$p["id"]] = $new_page->getId();
 
            ilAdvancedMDValues::_cloneValues(
                $copy_id,
                $this->getId(),
                $new_obj->getId(),
                "wpg",
                (int) $p["id"],
                $new_page->getId(),
            );
        }
 
        // copy important pages
        $imp_pages_manager = $this->domain->importantPage($this->getRefId());
        $imp_pages_manager->cloneTo($new_obj->getId(), $map);
        $this->updateInternalLinksOnCopy($map);
 
        // copy rating categories
        foreach (ilRatingCategory::getAllForObject($this->getId()) as $rc) {
            $new_rc = new ilRatingCategory();
            $new_rc->setParentId($new_obj->getId());
            $new_rc->setTitle((string) $rc["title"]);
            $new_rc->setDescription((string) $rc["description"]);
            $new_rc->save();
        }
 
        parent::cloneMetaData($new_obj);
 
        return $new_obj;
    }

References ilAdvancedMDValues\_cloneValues(), ilCopyWizardOptions\_getInstance(), ilContainer\_lookupContainerSetting(), ilContainer\_writeContainerSetting(), ilObjectServiceSettingsGUI\CUSTOM_METADATA, ilRatingCategory\getAllForObject(), ilWikiPage\getAllWikiPages(), ILIAS\Survey\Mode\getId(), and ilWikiPage\getPageIdForTitle().

Here is the call graph for this function:

◆ create()

ilObjWiki::create ( bool $a_prevent_start_page_creation = false )

Definition at line 203 of file class.ilObjWiki.php.

     : int {
        $ilDB = $this->db;
 
        $id = parent::create();
 
        $ilDB->insert("il_wiki_data", array(
            "id" => array("integer", $this->getId()),
            "is_online" => array("integer", (int) $this->getOnline()),
            "startpage" => array("text", $this->getStartPage()),
            "short" => array("text", $this->getShortTitle()),
            "rating" => array("integer", (int) $this->getRatingPages()),
            "public_notes" => array("integer", (int) $this->getPublicNotes()),
            "introduction" => array("clob", $this->getIntroduction()),
            "empty_page_templ" => array("integer", (int) $this->getEmptyPageTemplate()),
            ));
 
        // create start page
        if ($this->getStartPage() !== "" && !$a_prevent_start_page_creation) {
            $start_page = new ilWikiPage();
            $start_page->setWikiId($this->getId());
            $start_page->setTitle($this->getStartPage());
            $start_page->create();
        }
 
        $this->notes->domain()->activateComments($this->getId(), $this->getPublicNotes());
 
        parent::createMetaData();
 
        return $id;
    }

◆ createWikiPage()

ilObjWiki::createWikiPage	(	string	$a_page_title,
		int	$a_template_page = `0`
	)

Create new wiki page.

Definition at line 633 of file class.ilObjWiki.php.

     : ilWikiPage {
        // check if template has to be used
        if ($a_template_page === 0) {
            if (!$this->getEmptyPageTemplate()) {
                $wt = new ilWikiPageTemplate($this->getId());
                $ts = $wt->getAllInfo(ilWikiPageTemplate::TYPE_NEW_PAGES);
                if (count($ts) === 1) {
                    $t = current($ts);
                    $a_template_page = $t["wpage_id"];
                }
            }
        }
 
        // create the page
        $page = new ilWikiPage();
        $page->setWikiId($this->getId());
        $page->setTitle(ilWikiUtil::makeDbTitle($a_page_title));
        if ($this->getRatingPages() && $this->getRatingForNewPages()) {
            $page->setRating(true);
        }
 
        // needed for notification
        $page->setWikiRefId($this->getRefId());
        $page->create();
 
        // copy template into new page
        if ($a_template_page > 0) {
            $orig = new ilWikiPage($a_template_page);
            $orig->copy($page->getId());
 
            // #15718
            ilAdvancedMDValues::_cloneValues(
                0,
                $this->getId(),
                $this->getId(),
                "wpg",
                $a_template_page,
                $page->getId()
            );
        }
 
        return $page;
    }

References ILIAS\Survey\Mode\getId(), and ilWikiPageTemplate\TYPE_NEW_PAGES.

Here is the call graph for this function:

◆ decorateAdvMDValue()

ilObjWiki::decorateAdvMDValue ( string $a_value )

Decorate adv md value.

Parameters

string $a_value value

Returns: string decorated value (includes HTML)

Definition at line 746 of file class.ilObjWiki.php.

                                                       : string
    {
        if (ilWikiPage::_wikiPageExists($this->getId(), $a_value)) {
            $url = ilObjWikiGUI::getGotoLink($this->getRefId(), $a_value);
            return "<a href='" . $url . "'>" . $a_value . "</a>";
        }
 
        return $a_value;
    }

References $url, ilWikiPage\_wikiPageExists(), ilObjWikiGUI\getGotoLink(), and ILIAS\Survey\Mode\getId().

Here is the call graph for this function:

◆ delete()

ilObjWiki::delete ( )

delete object and all related data

Reimplemented from ilObject.

Definition at line 310 of file class.ilObjWiki.php.

                            : bool
    {
        $ilDB = $this->db;
 
        // always call parent delete function first!!
        if (!parent::delete()) {
            return false;
        }
 
        // delete record of table il_wiki_data
        $query = "DELETE FROM il_wiki_data" .
            " WHERE id = " . $ilDB->quote($this->getId(), "integer");
        $ilDB->manipulate($query);
 
        // remove all notifications
        ilNotification::removeForObject(ilNotification::TYPE_WIKI, $this->getId());
 
        ilWikiPage::deleteAllPagesOfWiki($this->getId());
 
        parent::deleteMetaData();
 
        return true;
    }

References $ilDB, ilWikiPage\deleteAllPagesOfWiki(), ILIAS\Survey\Mode\getId(), ilNotification\removeForObject(), and ilNotification\TYPE_WIKI.

Here is the call graph for this function:

◆ deliverUserHTMLExport()

ilObjWiki::deliverUserHTMLExport ( bool $with_comments = false )

Definition at line 730 of file class.ilObjWiki.php.

     : void {
        $ilDB = $this->db;
        $ilUser = $this->user;
 
        $user_export = new ilWikiUserHTMLExport($this, $ilDB, $ilUser, $with_comments);
        $user_export->deliverFile();
    }

◆ getAdvMDSubItemTitle()

static ilObjWiki::getAdvMDSubItemTitle	(	int	$a_obj_id,
		string	$a_sub_type,
		int	$a_sub_id
	)

static

Implements ilAdvancedMetaDataSubItems.

Definition at line 680 of file class.ilObjWiki.php.

     : string {
        global $DIC;
 
        $lng = $DIC->language();
 
        if ($a_sub_type === "wpg") {
            $lng->loadLanguageModule("wiki");
            return $lng->txt("wiki_wpg") . ' "' . ilWikiPage::lookupTitle($a_sub_id) . '"';
        }
        return "";
    }

References $lng, and ilWikiPage\lookupTitle().

Here is the call graph for this function:

◆ getEmptyPageTemplate()

ilObjWiki::getEmptyPageTemplate ( )

Definition at line 188 of file class.ilObjWiki.php.

                                          : bool
    {
        return $this->empty_page_templ;
    }

References $empty_page_templ.

◆ getIntroduction()

ilObjWiki::getIntroduction ( )

Definition at line 168 of file class.ilObjWiki.php.

                                     : string
    {
        return $this->introduction;
    }

References $introduction.

◆ getLinkMetadataValues()

ilObjWiki::getLinkMetadataValues ( )

Definition at line 198 of file class.ilObjWiki.php.

                                           : bool
    {
        return $this->link_md_values;
    }

References $link_md_values.

◆ getOnline()

ilObjWiki::getOnline ( )

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

                               : bool
    {
        return $this->online;
    }

References $online.

◆ getPageToc()

ilObjWiki::getPageToc ( )

Definition at line 178 of file class.ilObjWiki.php.

                                : bool
    {
        return $this->page_toc;
    }

References $page_toc.

◆ getPublicNotes()

ilObjWiki::getPublicNotes ( )

Definition at line 138 of file class.ilObjWiki.php.

                                    : bool
    {
        return $this->public_notes;
    }

References $public_notes.

◆ getRatingAsBlock()

ilObjWiki::getRatingAsBlock ( )

Definition at line 108 of file class.ilObjWiki.php.

                                      : bool
    {
        return $this->rating_block;
    }

References $rating_block.

◆ getRatingCategories()

ilObjWiki::getRatingCategories ( )

Definition at line 128 of file class.ilObjWiki.php.

                                         : bool
    {
        return $this->rating_categories;
    }

References $rating_categories.

◆ getRatingForNewPages()

ilObjWiki::getRatingForNewPages ( )

Definition at line 118 of file class.ilObjWiki.php.

                                          : bool
    {
        return $this->rating_new_pages;
    }

References $rating_new_pages.

◆ getRatingOverall()

ilObjWiki::getRatingOverall ( )

Definition at line 87 of file class.ilObjWiki.php.

                                      : bool
    {
        return $this->rating_overall;
    }

References $rating_overall.

◆ getRatingPages()

ilObjWiki::getRatingPages ( )

Definition at line 98 of file class.ilObjWiki.php.

                                    : bool
    {
        return $this->rating;
    }

References $rating.

◆ getShortTitle()

ilObjWiki::getShortTitle ( )

Definition at line 158 of file class.ilObjWiki.php.

                                   : string
    {
        return $this->shorttitle;
    }

References $shorttitle.

◆ getStartPage()

ilObjWiki::getStartPage ( )

Definition at line 148 of file class.ilObjWiki.php.

                                  : string
    {
        return $this->startpage;
    }

References $startpage.

◆ getTemplateSelectionOnCreation()

ilObjWiki::getTemplateSelectionOnCreation ( string $lang = "-" )

Get template selection on creation? If more than one template (including empty page template) is activated -> return true.

Returns: bool true, if manual template selection needed

Definition at line 618 of file class.ilObjWiki.php.

                                                                      : bool
    {
        $num = (int) $this->getEmptyPageTemplate();
        $wt = new ilWikiPageTemplate($this->getId());
        $ts = $wt->getAllInfo(ilWikiPageTemplate::TYPE_NEW_PAGES, $lang);
        $num += count($ts);
        if ($num > 1) {
            return true;
        }
        return false;
    }

References $lang, ILIAS\Survey\Mode\getId(), ILIAS\Repository\int(), and ilWikiPageTemplate\TYPE_NEW_PAGES.

Here is the call graph for this function:

◆ getUserHTMLExportProgress()

ilObjWiki::getUserHTMLExportProgress ( bool $with_comments = false )

Get user html export progress.

Returns: array progress info

Definition at line 720 of file class.ilObjWiki.php.

     : array {
        $ilDB = $this->db;
        $ilUser = $this->user;
 
        $user_export = new ilWikiUserHTMLExport($this, $ilDB, $ilUser, $with_comments);
        return $user_export->getProgress();
    }

◆ initUserHTMLExport()

ilObjWiki::initUserHTMLExport ( bool $with_comments = false )

Definition at line 696 of file class.ilObjWiki.php.

     : void {
        $ilDB = $this->db;
        $ilUser = $this->user;
 
        $user_export = new ilWikiUserHTMLExport($this, $ilDB, $ilUser, $with_comments);
        $user_export->initUserHTMLExport();
    }

◆ isCommentsExportPossible()

ilObjWiki::isCommentsExportPossible ( )

Is export possible.

Definition at line 759 of file class.ilObjWiki.php.

                                              : bool
    {
        $setting = $this->setting;
        $privacy = ilPrivacySettings::getInstance();
        if ($setting->get("disable_comments")) {
            return false;
        }
 
        if (!$this->getPublicNotes()) {
            return false;
        }
        if (!$privacy->enabledCommentsExport()) {
            return false;
        }
        return true;
    }

References ilSetting\get(), and ilPrivacySettings\getInstance().

Here is the call graph for this function:

◆ isImportantPage()

ilObjWiki::isImportantPage ( int $a_page_id )

Definition at line 471 of file class.ilObjWiki.php.

     : bool {
        $ilDB = $this->db;
 
        $set = $ilDB->query(
            "SELECT * FROM il_wiki_imp_pages WHERE " .
            " wiki_id = " . $ilDB->quote($this->getId(), "integer") . " AND " .
            " page_id = " . $ilDB->quote($a_page_id, "integer")
        );
        if ($ilDB->fetchAssoc($set)) {
            return true;
        }
        return false;
    }

◆ read()

ilObjWiki::read ( )

Reimplemented from ilObject.

Definition at line 279 of file class.ilObjWiki.php.

                          : void
    {
        $ilDB = $this->db;
 
        parent::read();
 
        $query = "SELECT * FROM il_wiki_data WHERE id = " .
            $ilDB->quote($this->getId(), "integer");
        $set = $ilDB->query($query);
        $rec = $ilDB->fetchAssoc($set);
 
        $this->setOnline((bool) $rec["is_online"]);
        $this->setStartPage((string) $rec["startpage"]);
        $this->setShortTitle((string) $rec["short"]);
        $this->setRatingOverall((bool) $rec["rating_overall"]);
        $this->setRatingPages((bool) $rec["rating"]);
        $this->setRatingAsBlock((bool) $rec["rating_side"]);
        $this->setRatingForNewPages((bool) $rec["rating_new"]);
        $this->setRatingCategories((bool) $rec["rating_ext"]);
        //$this->setPublicNotes((bool) $rec["public_notes"]);
        $this->setIntroduction((string) $rec["introduction"]);
        $this->setPageToc((bool) $rec["page_toc"]);
        $this->setEmptyPageTemplate((bool) $rec["empty_page_templ"]);
        $this->setLinkMetadataValues((bool) $rec["link_md_values"]);
        $this->setPublicNotes($this->notes->domain()->commentsActive($this->getId()));
    }

References $ilDB, and ILIAS\Survey\Mode\getId().

Here is the call graph for this function:

◆ setEmptyPageTemplate()

ilObjWiki::setEmptyPageTemplate ( bool $a_val )

Definition at line 183 of file class.ilObjWiki.php.

                                                     : void
    {
        $this->empty_page_templ = $a_val;
    }

◆ setIntroduction()

ilObjWiki::setIntroduction ( string $a_introduction )

Definition at line 163 of file class.ilObjWiki.php.

                                                           : void
    {
        $this->introduction = $a_introduction;
    }

◆ setLinkMetadataValues()

ilObjWiki::setLinkMetadataValues ( bool $a_val )

Definition at line 193 of file class.ilObjWiki.php.

                                                      : void
    {
        $this->link_md_values = $a_val;
    }

◆ setOnline()

ilObjWiki::setOnline ( bool $a_online )

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

                                             : void
    {
        $this->online = $a_online;
    }

◆ setPageToc()

ilObjWiki::setPageToc ( bool $a_val )

Definition at line 173 of file class.ilObjWiki.php.

                                           : void
    {
        $this->page_toc = $a_val;
    }

◆ setPublicNotes()

ilObjWiki::setPublicNotes ( bool $a_val )

Definition at line 133 of file class.ilObjWiki.php.

                                               : void
    {
        $this->public_notes = $a_val;
    }

◆ setRating()

ilObjWiki::setRating ( bool $a_rating )

Definition at line 82 of file class.ilObjWiki.php.

                                             : void     // this is called by ilObject->handleAutoRating
    {
        $this->setRatingOverall($a_rating);
    }

References setRatingOverall().

Here is the call graph for this function:

◆ setRatingAsBlock()

ilObjWiki::setRatingAsBlock ( bool $a_rating )

Definition at line 103 of file class.ilObjWiki.php.

                                                    : void
    {
        $this->rating_block = $a_rating;
    }

◆ setRatingCategories()

ilObjWiki::setRatingCategories ( bool $a_rating )

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

                                                       : void
    {
        $this->rating_categories = $a_rating;
    }

◆ setRatingForNewPages()

ilObjWiki::setRatingForNewPages ( bool $a_rating )

Definition at line 113 of file class.ilObjWiki.php.

                                                        : void
    {
        $this->rating_new_pages = $a_rating;
    }

◆ setRatingOverall()

ilObjWiki::setRatingOverall ( bool $a_rating )

Definition at line 77 of file class.ilObjWiki.php.

                                                    : void
    {
        $this->rating_overall = $a_rating;
    }

Referenced by setRating().

Here is the caller graph for this function:

◆ setRatingPages()

ilObjWiki::setRatingPages ( bool $a_rating )

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

                                                  : void
    {
        $this->rating = $a_rating;
    }

◆ setShortTitle()

ilObjWiki::setShortTitle ( string $a_shorttitle )

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

                                                       : void
    {
        $this->shorttitle = $a_shorttitle;
    }

◆ setStartPage()

ilObjWiki::setStartPage ( string $a_startpage )

Definition at line 143 of file class.ilObjWiki.php.

                                                     : void
    {
        $this->startpage = ilWikiUtil::makeDbTitle($a_startpage);
    }

References ilWikiUtil\makeDbTitle().

Here is the call graph for this function:

◆ startUserHTMLExport()

ilObjWiki::startUserHTMLExport ( bool $with_comments = false )

Definition at line 706 of file class.ilObjWiki.php.

     : void {
        $ilDB = $this->db;
        $ilUser = $this->user;
 
        $user_export = new ilWikiUserHTMLExport($this, $ilDB, $ilUser, $with_comments);
        $user_export->startUserHTMLExport();
    }

◆ update()

ilObjWiki::update ( bool $a_prevent_start_page_creation = false )

Definition at line 236 of file class.ilObjWiki.php.

     : bool {
        $ilDB = $this->db;
 
        if (!parent::update()) {
            return false;
        }
 
        $ilDB->update("il_wiki_data", array(
            "is_online" => array("integer", $this->getOnline()),
            "startpage" => array("text", $this->getStartPage()),
            "short" => array("text", $this->getShortTitle()),
            "rating_overall" => array("integer", $this->getRatingOverall()),
            "rating" => array("integer", $this->getRatingPages()),
            "rating_side" => array("integer", $this->getRatingAsBlock()), // #13455
            "rating_new" => array("integer", $this->getRatingForNewPages()),
            "rating_ext" => array("integer", $this->getRatingCategories()),
            "public_notes" => array("integer", $this->getPublicNotes()),
            "introduction" => array("clob", $this->getIntroduction()),
            "page_toc" => array("integer", $this->getPageToc()),
            "link_md_values" => array("integer", $this->getLinkMetadataValues()),
            "empty_page_templ" => array("integer", $this->getEmptyPageTemplate())
            ), array(
            "id" => array("integer", $this->getId())
            ));
 
        // check whether start page exists
        if (!ilWikiPage::exists($this->getId(), $this->getStartPage())
            && !$a_prevent_start_page_creation) {
            $start_page = new ilWikiPage();
            $start_page->setWikiId($this->getId());
            $start_page->setTitle($this->getStartPage());
            $start_page->setWikiRefId($this->getRefId());
            $start_page->create();
        }
        $this->notes->domain()->activateComments($this->getId(), $this->getPublicNotes());
 
        parent::updateMetaData();
 
        return true;
    }

◆ updateInternalLinksOnCopy()

ilObjWiki::updateInternalLinksOnCopy ( array $map )

protected

Definition at line 593 of file class.ilObjWiki.php.

                                                            : void
    {
        foreach ($map as $old_page_id => $new_page_id) {
            // get links with targets inside the wiki
            $targets = ilInternalLink::_getTargetsOfSource(
                "wpg:pg",
                $old_page_id,
                "-"
            );
            foreach ($targets as $t) {
                if ((int) $t["inst"] === 0 && in_array($t["type"], ["wpag", "wpage"]) && isset($map[(int) $t["id"]])) {
                    $new_page = new ilWikiPage($new_page_id);
                    if ($new_page->moveIntLinks([$t["id"] => $map[(int) $t["id"]]])) {
                        $new_page->update(true, true);
                    }
                }
            }
        }
    }

References ilInternalLink\_getTargetsOfSource().

Here is the call graph for this function:

◆ writeStartPage()

static ilObjWiki::writeStartPage	(	int	$a_id,
		string	$a_name
	)

static

Definition at line 425 of file class.ilObjWiki.php.

                                                                    : void
    {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $ilDB->manipulate(
            "UPDATE il_wiki_data SET " .
            " startpage = " . $ilDB->quote(ilWikiUtil::makeDbTitle($a_name), "text") .
            " WHERE id = " . $ilDB->quote($a_id, "integer")
        );
    }

References $DIC, $ilDB, and ilWikiUtil\makeDbTitle().

Here is the call graph for this function:

Field Documentation

◆ $content_style_service

ILIAS Style Content DomainService ilObjWiki::$content_style_service

protected

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

◆ $domain

ILIAS Wiki InternalDomainService ilObjWiki::$domain

protected

Definition at line 27 of file class.ilObjWiki.php.

◆ $empty_page_templ

bool ilObjWiki::$empty_page_templ = true

protected

Definition at line 41 of file class.ilObjWiki.php.

Referenced by getEmptyPageTemplate().

◆ $introduction

string ilObjWiki::$introduction = ""

protected

Definition at line 30 of file class.ilObjWiki.php.

Referenced by getIntroduction().

◆ $link_md_values

bool ilObjWiki::$link_md_values = false

protected

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

Referenced by getLinkMetadataValues().

◆ $notes

ILIAS Notes Service ilObjWiki::$notes

protected

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

◆ $online

bool ilObjWiki::$online = false

protected

Definition at line 39 of file class.ilObjWiki.php.

Referenced by getOnline().

◆ $page_toc

bool ilObjWiki::$page_toc = false

protected

Definition at line 28 of file class.ilObjWiki.php.

Referenced by getPageToc().

◆ $public_notes

bool ilObjWiki::$public_notes = true

protected

Definition at line 40 of file class.ilObjWiki.php.

Referenced by getPublicNotes().

◆ $rating

bool ilObjWiki::$rating = false

protected

Definition at line 35 of file class.ilObjWiki.php.

Referenced by getRatingPages().

◆ $rating_block

bool ilObjWiki::$rating_block = false

protected

Definition at line 36 of file class.ilObjWiki.php.

Referenced by getRatingAsBlock().

◆ $rating_categories

bool ilObjWiki::$rating_categories = false

protected

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

Referenced by getRatingCategories().

◆ $rating_new_pages

bool ilObjWiki::$rating_new_pages = false

protected

Definition at line 34 of file class.ilObjWiki.php.

Referenced by getRatingForNewPages().

◆ $rating_overall

bool ilObjWiki::$rating_overall = false

protected

Definition at line 37 of file class.ilObjWiki.php.

Referenced by getRatingOverall().

◆ $setting

ilSetting ilObjWiki::$setting

protected

Definition at line 43 of file class.ilObjWiki.php.

◆ $shorttitle

string ilObjWiki::$shorttitle = ""

protected

Definition at line 31 of file class.ilObjWiki.php.

Referenced by getShortTitle().

◆ $startpage

string ilObjWiki::$startpage = ""

protected

Definition at line 32 of file class.ilObjWiki.php.

Referenced by getStartPage().

◆ $style_id

int ilObjWiki::$style_id = 0

protected

Definition at line 29 of file class.ilObjWiki.php.

◆ $user

ilObjUser ilObjWiki::$user

protected

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

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

components/ILIAS/Wiki/classes/class.ilObjWiki.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _lookup()

◆ _lookupLinkMetadataValues()

◆ _lookupPageToc()

◆ _lookupPublicNotes()

◆ _lookupRating()

◆ _lookupRatingAsBlock()

◆ _lookupRatingCategories()

◆ _lookupRatingOverall()

◆ _lookupStartPage()

◆ _performSearch()

◆ checkShortTitleAvailability()

◆ cloneObject()

◆ create()

◆ createWikiPage()

◆ decorateAdvMDValue()

◆ delete()

◆ deliverUserHTMLExport()

◆ getAdvMDSubItemTitle()

◆ getEmptyPageTemplate()

◆ getIntroduction()

◆ getLinkMetadataValues()

◆ getOnline()

◆ getPageToc()

◆ getPublicNotes()

◆ getRatingAsBlock()

◆ getRatingCategories()

◆ getRatingForNewPages()

◆ getRatingOverall()

◆ getRatingPages()

◆ getShortTitle()

◆ getStartPage()

◆ getTemplateSelectionOnCreation()

◆ getUserHTMLExportProgress()

◆ initUserHTMLExport()

◆ isCommentsExportPossible()

◆ isImportantPage()

◆ read()

◆ setEmptyPageTemplate()

◆ setIntroduction()

◆ setLinkMetadataValues()

◆ setOnline()

◆ setPageToc()

◆ setPublicNotes()

◆ setRating()

◆ setRatingAsBlock()

◆ setRatingCategories()

◆ setRatingForNewPages()

◆ setRatingOverall()

◆ setRatingPages()

◆ setShortTitle()

◆ setStartPage()

◆ startUserHTMLExport()

◆ update()

◆ updateInternalLinksOnCopy()

◆ writeStartPage()

Field Documentation

◆ $content_style_service

◆ $domain

◆ $empty_page_templ

◆ $introduction

◆ $link_md_values

◆ $notes

◆ $online

◆ $page_toc

◆ $public_notes

◆ $rating

◆ $rating_block

◆ $rating_categories

◆ $rating_new_pages

◆ $rating_overall