Inheritance diagram for ilObjWiki:

Collaboration diagram for ilObjWiki:

Public Member Functions
	__construct ($a_id=0, $a_call_by_reference=true)
	Constructor public. More...

	setOnline ($a_online)
	Set Online. More...

	getOnline ()
	Get Online. More...

	setRatingOverall ($a_rating)
	Set Enable Rating For Object. More...

	getRatingOverall ()
	Get Enable Rating For Object. More...

	setRating ($a_rating)
	Set Enable Rating. More...

	getRating ()
	Get Enable Rating. More...

	setRatingAsBlock ($a_rating)
	Set Enable Rating Side Block. More...

	getRatingAsBlock ()
	Get Enable Rating Side Block. More...

	setRatingForNewPages ($a_rating)
	Set Enable Rating For New Pages. More...

	getRatingForNewPages ()
	Get Enable Rating For New Pages. More...

	setRatingCategories ($a_rating)
	Set Enable Rating Categories. More...

	getRatingCategories ()
	Get Enable Rating Categories. More...

	setPublicNotes ($a_val)
	Set public notes. More...

	getPublicNotes ()
	Get public notes. More...

	setImportantPages ($a_val)
	Set important pages. More...

	getImportantPages ()
	Get important pages. More...

	setStartPage ($a_startpage)
	Set Start Page. More...

	getStartPage ()
	Get Start Page. More...

	setShortTitle ($a_shorttitle)
	Set ShortTitle. More...

	getShortTitle ()
	Get ShortTitle. More...

	setIntroduction ($a_introduction)
	Set Introduction. More...

	getIntroduction ()
	Get Introduction. More...

	getStyleSheetId ()
	get ID of assigned style sheet object More...

	setStyleSheetId ($a_style_id)
	set ID of assigned style sheet object More...

	setPageToc ($a_val)
	Set page toc. More...

	getPageToc ()
	Get page toc. More...

	setEmptyPageTemplate ($a_val)
	Set empty page template. More...

	getEmptyPageTemplate ()
	Get empty page template. More...

	setLinkMetadataValues ($a_val)
	Set link md values. More...

	getLinkMetadataValues ()
	Get link md values. More...

	create ($a_prevent_start_page_creation=false)
	Create new wiki. More...

	update ($a_prevent_start_page_creation=false)
	update object data More...

	read ()
	Read wiki data. More...

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

	addImportantPage ($a_page_id, $a_nr=0, $a_indent=0)
	Add important page. More...

	isImportantPage ($a_page_id)
	Is page an important page? More...

	removeImportantPage ($a_id)
	Remove important page. More...

	saveOrderingAndIndentation ($a_ord, $a_indent)
	Save ordering and indentation. More...

	fixImportantPagesNumbering ()
	Fix important pages numbering. More...

	cloneObject ($a_target_id, $a_copy_id=0, $a_omit_tree=false)
	Clone wiki. More...

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

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

	initUserHTMLExport ()
	Init user html export. More...

	startUserHTMLExport ()
	Start user html export. More...

	getUserHTMLExportProgress ()
	Get user html export progress. More...

	deliverUserHTMLExport ()
	Send user html export file. More...

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

Public Member Functions inherited from ilObject
	__construct ($a_id=0, $a_reference=true)
	Constructor public. More...

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

	read ()
	read object data from db into object More...

	getId ()
	get object id public More...

	setId ($a_id)
	set object id public More...

	setRefId ($a_id)
	set reference id public More...

	getRefId ()
	get reference id public More...

	getType ()
	get object type public More...

	setType ($a_type)
	set object type public More...

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

	getTitle ()
	get object title public More...

	getUntranslatedTitle ()
	get untranslated object title public More...

	setTitle ($a_title)
	set object title More...

	getDescription ()
	get object description More...

	setDescription ($a_desc)
	set object description More...

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

	getImportId ()
	get import id More...

	setImportId ($a_import_id)
	set import id More...

	setOfflineStatus ($a_status)
	Set offline status. More...

	getOfflineStatus ()
	Get offline status. More...

	supportsOfflineHandling ()
	Check whether object supports offline handling. More...

	getOwner ()
	get object owner More...

	getOwnerName ()

	setOwner ($a_owner)
	set object owner More...

	getCreateDate ()
	get create date public More...

	getLastUpdateDate ()
	get last update date public More...

	getDiskUsage ()
	Gets the disk usage of the object in bytes. More...

	create ()
	create More...

	update ()
	update object in db More...

	MDUpdateListener ($a_element)
	Meta data update listener. More...

	createMetaData ()
	create meta data entry More...

	updateMetaData ()
	update meta data entry More...

	deleteMetaData ()
	delete meta data entry More...

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

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

	setPermissions ($a_parent_ref)
	set permissions of object More...

	setParentRolePermissions ($a_parent_ref)
	Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g courses, groups for building permission intersections with non_member templates. More...

	createReference ()
	creates reference for object More...

	countReferences ()
	count references of object 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 If you want to setup default local roles you MUST overwrite this method in derived object classes (see ilObjForum for an example) public More...

	applyDidacticTemplate ($a_tpl_id)
	Apply template. More...

	setRegisterMode ($a_bool)

	isUserRegistered ($a_user_id=0)

	requireRegistration ()

	getXMLZip ()

	getHTMLDirectory ()

	appendCopyInfo ($a_target_id, $a_copy_id)
	Prepend Copy info if object with same name exists in that container. More...

	cloneDependencies ($a_target_id, $a_copy_id)
	Clone object dependencies. More...

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

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

Static Public Member Functions
static	isOnlineHelpWiki ($a_ref_id)
	Is wiki an online help wiki? More...

static	checkShortTitleAvailability ($a_short_title)
	Check availability of short title. More...

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

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

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

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

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

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

static	_lookupStartPage ($a_wiki_id)
	Lookup start page. More...

static	writeStartPage ($a_id, $a_name)
	Write start page. More...

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

static	_lookupImportantPages ($a_wiki_id)
	Lookup whether important pages are activated. More...

static	_lookupImportantPagesList ($a_wiki_id)
	Get important pages list. More...

static	_lookupMaxOrdNrImportantPages ($a_wiki_id)
	Get important pages list. More...

static	_lookupPageToc ($a_wiki_id)
	Lookup whether important pages are activated. More...

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

Static Public Member Functions inherited from ilObject
static	_lookupObjIdByImportId ($a_import_id)

static	_lookupImportId ($a_obj_id)

static	_lookupOwnerName ($a_owner_id)
	lookup owner name for owner id More...

static	_getIdForImportId ($a_import_id)
	get current object id for import id (static) More...

static	_getAllReferences ($a_id)
	get all reference ids of object More...

static	_lookupTitle ($a_id)
	lookup object title More...

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

static	_lookupOwner ($a_id)
	lookup object owner More...

static	_getIdsForTitle ($title, $type='', $partialmatch=false)

static	_lookupDescription ($a_id)
	lookup object description More...

static	_lookupLastUpdate ($a_id, $a_as_string=false)
	lookup last update More...

static	_getLastUpdateOfObjects ($a_objs)
	Get last update for a set of media objects. More...

static	_lookupObjId ($a_id)

static	_setDeletedDate ($a_ref_id)
	only called in ilTree::saveSubTree More...

static	setDeletedDates ($a_ref_ids)
	Set deleted date. More...

static	_resetDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...

static	_lookupDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...

static	_writeTitle ($a_obj_id, $a_title)
	write title to db (static) More...

static	_writeDescription ($a_obj_id, $a_desc)
	write description to db (static) More...

static	_writeImportId ($a_obj_id, $a_import_id)
	write import id to db (static) More...

static	_lookupType ($a_id, $a_reference=false)
	lookup object type More...

static	_isInTrash ($a_ref_id)
	checks wether object is in trash More...

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

static	_lookupObjectId ($a_ref_id)
	lookup object id More...

static	_getObjectsDataForType ($a_type, $a_omit_trash=false)
	get all objects of a certain type More...

static	_exists ($a_id, $a_reference=false, $a_type=null)
	checks if an object exists in object_data More...

static	_getObjectsByType ($a_obj_type="", $a_owner="")
	Get objects by type. More...

static	_prepareCloneSelection ($a_ref_ids, $new_type, $show_path=true)
	Prepare copy wizard object selection. More...

static	collectDeletionDependencies (&$deps, $a_ref_id, $a_obj_id, $a_type, $a_depth=0)
	Collect deletion dependencies. More...

static	getDeletionDependencies ($a_obj_id)
	Get deletion dependencies. More...

static	getLongDescriptions (array $a_obj_ids)
	Get long description data. More...

static	getAllOwnedRepositoryObjects ($a_user_id)
	Get all ids of objects user owns. More...

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

static	_lookupCreationDate ($a_id)
	Lookup creation date. More...

static	hasAutoRating ($a_type, $a_ref_id)
	Check if auto rating is active for parent group/course. More...

Protected Attributes
	$user

	$online = false

	$public_notes = true

	$empty_page_templ = true

	$link_md_values = false

Protected Attributes inherited from ilObject
	$objDefinition

	$db

	$log

	$error

	$tree

	$app_event_handler

	$rbacadmin

	$rbacreview

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

Additional Inherited Members
Data Fields inherited from ilObject
const	TITLE_LENGTH = 255
	max length of object title More...

const	DESC_LENGTH = 128

	$lng

	$id

	$ref_id

	$type

	$title

	$untranslatedTitle

	$desc

	$long_desc

	$owner

	$create_date

	$last_update

	$import_id

	$register = false

	$referenced

	$objectList

	$max_title

	$max_desc

	$add_dots

Detailed Description

Class ilObjWiki.

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

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

Constructor public.

Parameters

integer	reference_id or object_id
boolean	treat the id as reference_id (true) or object_id (false)

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

References $DIC, and user().

     {
         global $DIC;
 
         $this->db = $DIC->database();
         $this->user = $DIC->user();
         $this->type = "wiki";
         parent::__construct($a_id, $a_call_by_reference);
     }

Here is the call graph for this function:

Member Function Documentation

◆ _lookup()

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

staticprivate

Lookup a data field.

Parameters

int	$a_wiki_id	Wiki ID
string	$a_field	Field Name

Returns: mixed field value

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

References $DIC, $ilDB, and $query.

Referenced by _lookupImportantPages(), _lookupLinkMetadataValues(), _lookupPageToc(), _lookupPublicNotes(), _lookupRating(), _lookupRatingAsBlock(), _lookupRatingCategories(), _lookupRatingOverall(), and _lookupStartPage().

     {
         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];
     }

Here is the caller graph for this function:

◆ _lookupImportantPages()

static ilObjWiki::_lookupImportantPages ( $a_wiki_id )

static

Lookup whether important pages are activated.

Parameters

int $a_wiki_id Wiki ID

Returns: boolean Important pages activated?

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

References _lookup().

     {
         return ilObjWiki::_lookup($a_wiki_id, "imp_pages");
     }

Here is the call graph for this function:

◆ _lookupImportantPagesList()

static ilObjWiki::_lookupImportantPagesList ( $a_wiki_id )

static

Get important pages list.

Parameters

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

References $DIC, and $ilDB.

Referenced by ilImportantPagesTableGUI\__construct(), cloneObject(), ilObjWikiGUI\editImportantPagesObject(), ilWikiImportantPagesBlockGUI\fillDataSection(), fixImportantPagesNumbering(), and saveOrderingAndIndentation().

     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $set = $ilDB->query(
             "SELECT * FROM il_wiki_imp_pages WHERE " .
             " wiki_id = " . $ilDB->quote($a_wiki_id, "integer") . " ORDER BY ord ASC "
         );
 
         $imp_pages = array();
 
         while ($rec = $ilDB->fetchAssoc($set)) {
             $imp_pages[] = $rec;
         }
         return $imp_pages;
     }

Here is the caller graph for this function:

◆ _lookupLinkMetadataValues()

static ilObjWiki::_lookupLinkMetadataValues ( $a_wiki_id )

static

Lookup whether metadata should be auto linked.

Parameters

int $a_wiki_id Wiki ID

Returns: boolean auto linking activated?

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

References _lookup().

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

Here is the call graph for this function:

◆ _lookupMaxOrdNrImportantPages()

static ilObjWiki::_lookupMaxOrdNrImportantPages ( $a_wiki_id )

static

Get important pages list.

Parameters

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

References $DIC, and $ilDB.

Referenced by addImportantPage().

     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $set = $ilDB->query(
             "SELECT MAX(ord) as m FROM il_wiki_imp_pages WHERE " .
             " wiki_id = " . $ilDB->quote($a_wiki_id, "integer")
         );
 
         $rec = $ilDB->fetchAssoc($set);
         return (int) $rec["m"];
     }

Here is the caller graph for this function:

◆ _lookupPageToc()

static ilObjWiki::_lookupPageToc ( $a_wiki_id )

static

Lookup whether important pages are activated.

Parameters

int $a_wiki_id Wiki ID

Returns: boolean Important pages activated?

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

References _lookup().

Referenced by ilWikiPageConfig\configureByObjectId().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _lookupPublicNotes()

static ilObjWiki::_lookupPublicNotes ( $a_wiki_id )

static

Lookup whether public notes are activated.

Parameters

int $a_wiki_id Wiki ID

Returns: boolean public notes activated?

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

References _lookup().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _lookupRating()

static ilObjWiki::_lookupRating ( $a_wiki_id )

static

Lookup whether rating is activated.

Parameters

int $a_wiki_id Wiki ID

Returns: boolean Rating activated?

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

References _lookup().

Referenced by ilWikiFunctionsBlockGUI\fillDataSection(), and ilObjWikiGUI\renderSideBlock().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _lookupRatingAsBlock()

static ilObjWiki::_lookupRatingAsBlock ( $a_wiki_id )

static

Lookup whether rating side block is activated.

Parameters

int $a_wiki_id Wiki ID

Returns: boolean Rating side block activated?

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

References _lookup().

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

Here is the call graph for this function:

◆ _lookupRatingCategories()

static ilObjWiki::_lookupRatingCategories ( $a_wiki_id )

static

Lookup whether rating categories are activated.

Parameters

int $a_wiki_id Wiki ID

Returns: boolean Rating categories activated?

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

References _lookup().

Referenced by ilObjWikiGUI\renderSideBlock().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _lookupRatingOverall()

static ilObjWiki::_lookupRatingOverall ( $a_wiki_id )

static

Lookup whether rating is activated for whole object.

Parameters

int $a_wiki_id Wiki ID

Returns: boolean Rating activated?

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

References _lookup().

Referenced by ilWikiPageGUI\addHeaderAction().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _lookupStartPage()

static ilObjWiki::_lookupStartPage ( $a_wiki_id )

static

Lookup start page.

Parameters

int $a_wiki_id Wiki ID

Returns: boolean

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

References _lookup().

Referenced by ilWikiHandlerGUI\executeCommand(), ilWikiImportantPagesBlockGUI\fillDataSection(), ilWikiFunctionsBlockGUI\fillDataSection(), ilObjWikiGUI\getGotoLink(), ilWikiPage\getOrphanedPages(), and ilWikiPage\rename().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _performSearch()

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

static

Search in Wiki.

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

References ilObjectSearchFactory\_getWikiContentSearchInstance().

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

     {
         // query parser
         include_once 'Services/Search/classes/class.ilQueryParser.php';
 
         $query_parser = new ilQueryParser($a_searchterm);
         $query_parser->setCombination("or");
         $query_parser->parse();
 
         include_once 'Services/Search/classes/class.ilSearchResult.php';
         $search_result = new ilSearchResult();
         if ($query_parser->validate()) {
             include_once 'Services/Search/classes/class.ilObjectSearchFactory.php';
             $wiki_search = ilObjectSearchFactory::_getWikiContentSearchInstance($query_parser);
             $wiki_search->setFilter(array('wpg'));
             $search_result->mergeEntries($wiki_search->performSearch());
         }
         
         $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;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addImportantPage()

ilObjWiki::addImportantPage	(	$a_page_id,
		$a_nr = `0`,
		$a_indent = `0`
	)

Add important page.

Parameters

int page id

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

References ilObject\$db, $ilDB, _lookupMaxOrdNrImportantPages(), ilObject\getId(), and isImportantPage().

     {
         $ilDB = $this->db;
 
         if (!$this->isImportantPage($a_page_id)) {
             if ($a_nr == 0) {
                 $a_nr = ilObjWiki::_lookupMaxOrdNrImportantPages($this->getId()) + 10;
             }
 
             $ilDB->manipulate("INSERT INTO il_wiki_imp_pages " .
                 "(wiki_id, ord, indent, page_id) VALUES (" .
                 $ilDB->quote($this->getId(), "integer") . "," .
                 $ilDB->quote($a_nr, "integer") . "," .
                 $ilDB->quote($a_indent, "integer") . "," .
                 $ilDB->quote($a_page_id, "integer") .
                 ")");
         }
     }

Here is the call graph for this function:

◆ checkShortTitleAvailability()

static ilObjWiki::checkShortTitleAvailability ( $a_short_title )

static

Check availability of short title.

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

References $DIC, $ilDB, and $res.

Referenced by ilObjWikiGUI\saveObject(), and ilObjWikiGUI\saveSettingsObject().

     {
         global $DIC;
 
         $ilDB = $DIC->database();
         
         $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;
     }

Here is the caller graph for this function:

◆ cloneObject()

ilObjWiki::cloneObject	(	$a_target_id,
		$a_copy_id = `0`,
		$a_omit_tree = `false`
	)

Clone wiki.

Parameters

int	target ref_id
int	copy id

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

References $map, ilCopyWizardOptions\_getInstance(), _lookupImportantPagesList(), ilObjStyleSheet\_lookupStandard(), ilRatingCategory\getAllForObject(), ilWikiPage\getAllWikiPages(), ilObject\getId(), getImportantPages(), ilObjectFactory\getInstanceByObjId(), getIntroduction(), getOnline(), ilWikiPage\getPageIdForTitle(), getPageToc(), getPublicNotes(), getRating(), getRatingAsBlock(), getRatingCategories(), getRatingForNewPages(), getRatingOverall(), getShortTitle(), getStartPage(), and getStyleSheetId().

     {
         $new_obj = parent::cloneObject($a_target_id, $a_copy_id, $a_omit_tree);
 
         //copy online status if object is not the root copy object
         $cp_options = ilCopyWizardOptions::_getInstance($a_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->setRating($this->getRating());
         $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->setImportantPages($this->getImportantPages());
         $new_obj->setPageToc($this->getPageToc());
         $new_obj->update();
 
         // set/copy stylesheet
         include_once("./Services/Style/Content/classes/class.ilObjStyleSheet.php");
         $style_id = $this->getStyleSheetId();
         if ($style_id > 0 && !ilObjStyleSheet::_lookupStandard($style_id)) {
             $style_obj = ilObjectFactory::getInstanceByObjId($style_id);
             $new_id = $style_obj->ilClone();
             $new_obj->setStyleSheetId($new_id);
             $new_obj->update();
         }
 
         // copy content
         include_once("./Modules/Wiki/classes/class.ilWikiPage.php");
         $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"]);
             $new_page = new ilWikiPage();
             $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();
         }
         
         // copy important pages
         foreach (ilObjWiki::_lookupImportantPagesList($this->getId()) as $ip) {
             $new_obj->addImportantPage($map[$ip["page_id"]], $ip["ord"], $ip["indent"]);
         }
 
         // copy rating categories
         include_once("./Services/Rating/classes/class.ilRatingCategory.php");
         foreach (ilRatingCategory::getAllForObject($this->getId()) as $rc) {
             $new_rc = new ilRatingCategory();
             $new_rc->setParentId($new_obj->getId());
             $new_rc->setTitle($rc["title"]);
             $new_rc->setDescription($rc["description"]);
             $new_rc->save();
         }
         
         return $new_obj;
     }

Here is the call graph for this function:

◆ create()

ilObjWiki::create ( $a_prevent_start_page_creation = false )

Create new wiki.

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

References ilObject\$db, $ilDB, getEmptyPageTemplate(), ilObject\getId(), getIntroduction(), getOnline(), getPublicNotes(), getRating(), getShortTitle(), getStartPage(), getStyleSheetId(), and ilObjStyleSheet\writeStyleUsage().

     {
         $ilDB = $this->db;
 
         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->getRating()),
             "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) {
             include_once("./Modules/Wiki/classes/class.ilWikiPage.php");
             $start_page = new ilWikiPage();
             $start_page->setWikiId($this->getId());
             $start_page->setTitle($this->getStartPage());
             $start_page->create();
         }
 
         if (((int) $this->getStyleSheetId()) > 0) {
             include_once("./Services/Style/Content/classes/class.ilObjStyleSheet.php");
             ilObjStyleSheet::writeStyleUsage($this->getId(), $this->getStyleSheetId());
         }
     }

Here is the call graph for this function:

◆ createWikiPage()

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

Create new wiki page.

Parameters

string	$a_page_title	page title
int	$a_template_page	template page id

Returns: ilWikiPage new wiki page

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

References $t, ilAdvancedMDValues\_cloneValues(), getEmptyPageTemplate(), ilObject\getId(), getRating(), getRatingForNewPages(), ilObject\getRefId(), ilWikiUtil\makeDbTitle(), and ilWikiPageTemplate\TYPE_NEW_PAGES.

     {
         // check if template has to be used
         if ($a_template_page == 0) {
             if (!$this->getEmptyPageTemplate()) {
                 include_once("./Modules/Wiki/classes/class.ilWikiPageTemplate.php");
                 $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->getRating() && $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
             include_once "Services/AdvancedMetaData/classes/class.ilAdvancedMDValues.php";
             ilAdvancedMDValues::_cloneValues(
                 $this->getId(),
                 $this->getId(),
                 "wpg",
                 $a_template_page,
                 $page->getId()
             );
         }
 
         return $page;
     }

Here is the call graph for this function:

◆ decorateAdvMDValue()

ilObjWiki::decorateAdvMDValue ( $a_value )

Decorate adv md value.

Parameters

string $a_value value

Returns: string decorated value (includes HTML)

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

References $url, ilWikiPage\_wikiPageExists(), ilObjWikiGUI\getGotoLink(), ilObject\getId(), and ilObject\getRefId().

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

Here is the call graph for this function:

◆ delete()

ilObjWiki::delete ( )

delete object and all related data

public

Returns: boolean true if all object data were removed; false if only a references were removed

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

References ilObject\$db, $ilDB, $query, ilWikiPage\deleteAllPagesOfWiki(), ilObject\getId(), ilNotification\removeForObject(), and ilNotification\TYPE_WIKI.

     {
         $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
         include_once "./Services/Notification/classes/class.ilNotification.php";
         ilNotification::removeForObject(ilNotification::TYPE_WIKI, $this->getId());
         
         include_once("./Modules/Wiki/classes/class.ilWikiPage.php");
         ilWikiPage::deleteAllPagesOfWiki($this->getId());
         
         return true;
     }

Here is the call graph for this function:

◆ deliverUserHTMLExport()

ilObjWiki::deliverUserHTMLExport ( )

Send user html export file.

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

References ilObject\$db, $ilDB, $ilUser, and $user.

     {
         $ilDB = $this->db;
         $ilUser = $this->user;
 
         include_once("./Modules/Wiki/classes/class.ilWikiUserHTMLExport.php");
 
         $user_export = new ilWikiUserHTMLExport($this, $ilDB, $ilUser);
         return $user_export->deliverFile();
     }

◆ fixImportantPagesNumbering()

ilObjWiki::fixImportantPagesNumbering ( )

Fix important pages numbering.

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

References ilObject\$db, $ilDB, _lookupImportantPagesList(), and ilObject\getId().

Referenced by removeImportantPage().

     {
         $ilDB = $this->db;
 
         $ipages = ilObjWiki::_lookupImportantPagesList($this->getId());
 
         // fix indentation: no 2 is allowed after a 0
         $c_indent = 0;
         $fixed = false;
         foreach ($ipages as $k => $v) {
             if ($ipages[$k]["indent"] == 2 && $c_indent == 0) {
                 $ipages[$k]["indent"] = 1;
                 $fixed = true;
             }
             $c_indent = $ipages[$k]["indent"];
         }
 
         $ord = 10;
         foreach ($ipages as $k => $v) {
             $ilDB->manipulate(
                 $q = "UPDATE il_wiki_imp_pages SET " .
                 " ord = " . $ilDB->quote($ord, "integer") .
                 ", indent = " . $ilDB->quote($v["indent"], "integer") .
                 " WHERE wiki_id = " . $ilDB->quote($v["wiki_id"], "integer") .
                 " AND page_id = " . $ilDB->quote($v["page_id"], "integer")
             );
             $ord += 10;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAdvMDSubItemTitle()

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

static

Implements ilAdvancedMetaDataSubItems.

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

References $DIC, ilObject\$lng, and ilWikiPage\lookupTitle().

     {
         global $DIC;
 
         $lng = $DIC->language();
     
         if ($a_sub_type == "wpg") {
             $lng->loadLanguageModule("wiki");
             include_once "./Modules/Wiki/classes/class.ilWikiPage.php";
             return $lng->txt("wiki_wpg") . ' "' . ilWikiPage::lookupTitle($a_sub_id) . '"';
         }
     }

Here is the call graph for this function:

◆ getEmptyPageTemplate()

ilObjWiki::getEmptyPageTemplate ( )

Get empty page template.

Returns: boolean empty page template

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

References $empty_page_templ.

Referenced by create(), createWikiPage(), getTemplateSelectionOnCreation(), and update().

     {
         return $this->empty_page_templ;
     }

Here is the caller graph for this function:

◆ getImportantPages()

ilObjWiki::getImportantPages ( )

Get important pages.

Returns: boolean important pages

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

Referenced by cloneObject(), and update().

     {
         return $this->imp_pages;
     }

Here is the caller graph for this function:

◆ getIntroduction()

ilObjWiki::getIntroduction ( )

Get Introduction.

Returns: string Introduction

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

Referenced by cloneObject(), create(), and update().

     {
         return $this->introduction;
     }

Here is the caller graph for this function:

◆ getLinkMetadataValues()

ilObjWiki::getLinkMetadataValues ( )

Get link md values.

Returns: bool link metadata values

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

References $link_md_values.

Referenced by update().

     {
         return $this->link_md_values;
     }

Here is the caller graph for this function:

◆ getOnline()

ilObjWiki::getOnline ( )

Get Online.

Returns: boolean Online

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

References $online.

Referenced by cloneObject(), create(), and update().

     {
         return $this->online;
     }

Here is the caller graph for this function:

◆ getPageToc()

ilObjWiki::getPageToc ( )

Get page toc.

Returns: boolean page toc

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

Referenced by cloneObject(), and update().

     {
         return $this->page_toc;
     }

Here is the caller graph for this function:

◆ getPublicNotes()

ilObjWiki::getPublicNotes ( )

Get public notes.

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

References $public_notes.

Referenced by cloneObject(), create(), and update().

     {
         return $this->public_notes;
     }

Here is the caller graph for this function:

◆ getRating()

ilObjWiki::getRating ( )

Get Enable Rating.

Returns: boolean Enable Rating

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

Referenced by cloneObject(), create(), createWikiPage(), and update().

     {
         return $this->rating;
     }

Here is the caller graph for this function:

◆ getRatingAsBlock()

ilObjWiki::getRatingAsBlock ( )

Get Enable Rating Side Block.

Returns: boolean

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

Referenced by cloneObject(), and update().

     {
         return $this->rating_block;
     }

Here is the caller graph for this function:

◆ getRatingCategories()

ilObjWiki::getRatingCategories ( )

Get Enable Rating Categories.

Returns: boolean

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

Referenced by cloneObject(), and update().

     {
         return $this->rating_categories;
     }

Here is the caller graph for this function:

◆ getRatingForNewPages()

ilObjWiki::getRatingForNewPages ( )

Get Enable Rating For New Pages.

Returns: boolean

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

Referenced by cloneObject(), createWikiPage(), and update().

     {
         return $this->rating_new_pages;
     }

Here is the caller graph for this function:

◆ getRatingOverall()

ilObjWiki::getRatingOverall ( )

Get Enable Rating For Object.

Returns: boolean Enable Rating

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

Referenced by cloneObject(), and update().

     {
         return $this->rating_overall;
     }

Here is the caller graph for this function:

◆ getShortTitle()

ilObjWiki::getShortTitle ( )

Get ShortTitle.

Returns: string ShortTitle

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

Referenced by cloneObject(), create(), and update().

     {
         return $this->shorttitle;
     }

Here is the caller graph for this function:

◆ getStartPage()

ilObjWiki::getStartPage ( )

Get Start Page.

Returns: string Start Page

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

Referenced by cloneObject(), create(), and update().

     {
         return $this->startpage;
     }

Here is the caller graph for this function:

◆ getStyleSheetId()

ilObjWiki::getStyleSheetId ( )

get ID of assigned style sheet object

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

Referenced by cloneObject(), create(), and update().

     {
         return $this->style_id;
     }

Here is the caller graph for this function:

◆ getTemplateSelectionOnCreation()

ilObjWiki::getTemplateSelectionOnCreation ( )

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

Returns: boolean true, if manual template selection needed

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

References getEmptyPageTemplate(), ilObject\getId(), and ilWikiPageTemplate\TYPE_NEW_PAGES.

     {
         $num = (int) $this->getEmptyPageTemplate();
         include_once("./Modules/Wiki/classes/class.ilWikiPageTemplate.php");
         $wt = new ilWikiPageTemplate($this->getId());
         $ts = $wt->getAllInfo(ilWikiPageTemplate::TYPE_NEW_PAGES);
         $num += count($ts);
         if ($num > 1) {
             return true;
         }
         return false;
     }

Here is the call graph for this function:

◆ getUserHTMLExportProgress()

ilObjWiki::getUserHTMLExportProgress ( )

Get user html export progress.

Returns: array progress info

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

References ilObject\$db, $ilDB, $ilUser, and $user.

     {
         $ilDB = $this->db;
         $ilUser = $this->user;
 
         include_once("./Modules/Wiki/classes/class.ilWikiUserHTMLExport.php");
 
         $user_export = new ilWikiUserHTMLExport($this, $ilDB, $ilUser);
         return $user_export->getProgress();
     }

◆ initUserHTMLExport()

ilObjWiki::initUserHTMLExport ( )

Init user html export.

Parameters

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

References ilObject\$db, $ilDB, $ilUser, and $user.

     {
         $ilDB = $this->db;
         $ilUser = $this->user;
 
         include_once("./Modules/Wiki/classes/class.ilWikiUserHTMLExport.php");
 
         $user_export = new ilWikiUserHTMLExport($this, $ilDB, $ilUser);
         $user_export->initUserHTMLExport();
     }

◆ isImportantPage()

ilObjWiki::isImportantPage ( $a_page_id )

Is page an important page?

Parameters

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

References ilObject\$db, and $ilDB.

Referenced by addImportantPage().

     {
         $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 ($rec = $ilDB->fetchAssoc($set)) {
             return true;
         }
         return false;
     }

Here is the caller graph for this function:

◆ isOnlineHelpWiki()

static ilObjWiki::isOnlineHelpWiki ( $a_ref_id )

static

Is wiki an online help wiki?

Returns: boolean true, if current wiki is an online help wiki

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

Referenced by ilObjWikiGUI\isOnlineHelpWiki().

     {
         if ($a_ref_id > 0 && $a_ref_id == OH_REF_ID) {
             //                  return true;
         }
         return false;
     }

Here is the caller graph for this function:

◆ read()

ilObjWiki::read ( )

Read wiki data.

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

References ilObject\$db, $ilDB, $query, ilObject\getId(), ilObjStyleSheet\lookupObjectStyle(), setEmptyPageTemplate(), setImportantPages(), setIntroduction(), setLinkMetadataValues(), setOnline(), setPageToc(), setPublicNotes(), setRating(), setRatingAsBlock(), setRatingCategories(), setRatingForNewPages(), setRatingOverall(), setShortTitle(), setStartPage(), and setStyleSheetId().

     {
         $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($rec["is_online"]);
         $this->setStartPage($rec["startpage"]);
         $this->setShortTitle($rec["short"]);
         $this->setRatingOverall($rec["rating_overall"]);
         $this->setRating($rec["rating"]);
         $this->setRatingAsBlock($rec["rating_side"]);
         $this->setRatingForNewPages($rec["rating_new"]);
         $this->setRatingCategories($rec["rating_ext"]);
         $this->setPublicNotes($rec["public_notes"]);
         $this->setIntroduction($rec["introduction"]);
         $this->setImportantPages($rec["imp_pages"]);
         $this->setPageToc($rec["page_toc"]);
         $this->setEmptyPageTemplate($rec["empty_page_templ"]);
         $this->setLinkMetadataValues($rec["link_md_values"]);
 
         include_once("./Services/Style/Content/classes/class.ilObjStyleSheet.php");
         $this->setStyleSheetId((int) ilObjStyleSheet::lookupObjectStyle($this->getId()));
     }

Here is the call graph for this function:

◆ removeImportantPage()

ilObjWiki::removeImportantPage ( $a_id )

Remove important page.

Parameters

int page id

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

References ilObject\$db, $ilDB, and fixImportantPagesNumbering().

     {
         $ilDB = $this->db;
 
         $ilDB->manipulate(
             "DELETE FROM il_wiki_imp_pages WHERE "
             . " wiki_id = " . $ilDB->quote($this->getId(), "integer")
             . " AND page_id = " . $ilDB->quote($a_id, "integer")
         );
 
         $this->fixImportantPagesNumbering();
     }

Here is the call graph for this function:

◆ saveOrderingAndIndentation()

ilObjWiki::saveOrderingAndIndentation	(	$a_ord,
		$a_indent
	)

Save ordering and indentation.

Parameters

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

References ilObject\$db, $ilDB, _lookupImportantPagesList(), ilObject\getId(), and ilUtil\sortArray().

     {
         $ilDB = $this->db;
 
         $ipages = ilObjWiki::_lookupImportantPagesList($this->getId());
 
         foreach ($ipages as $k => $v) {
             if (isset($a_ord[$v["page_id"]])) {
                 $ipages[$k]["ord"] = (int) $a_ord[$v["page_id"]];
             }
             if (isset($a_indent[$v["page_id"]])) {
                 $ipages[$k]["indent"] = (int) $a_indent[$v["page_id"]];
             }
         }
         $ipages = ilUtil::sortArray($ipages, "ord", "asc", true);
 
         // fix indentation: no 2 is allowed after a 0
         $c_indent = 0;
         $fixed = false;
         foreach ($ipages as $k => $v) {
             if ($ipages[$k]["indent"] == 2 && $c_indent == 0) {
                 $ipages[$k]["indent"] = 1;
                 $fixed = true;
             }
             $c_indent = $ipages[$k]["indent"];
         }
         
         $ord = 10;
         reset($ipages);
         foreach ($ipages as $k => $v) {
             $ilDB->manipulate(
                 $q = "UPDATE il_wiki_imp_pages SET " .
                 " ord = " . $ilDB->quote($ord, "integer") . "," .
                 " indent = " . $ilDB->quote($v["indent"], "integer") .
                 " WHERE wiki_id = " . $ilDB->quote($v["wiki_id"], "integer") .
                 " AND page_id = " . $ilDB->quote($v["page_id"], "integer")
             );
             $ord += 10;
         }
         
         return $fixed;
     }

Here is the call graph for this function:

◆ setEmptyPageTemplate()

ilObjWiki::setEmptyPageTemplate ( $a_val )

Set empty page template.

Parameters

boolean $a_val empty page template

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

Referenced by read().

     {
         $this->empty_page_templ = $a_val;
     }

Here is the caller graph for this function:

◆ setImportantPages()

ilObjWiki::setImportantPages ( $a_val )

Set important pages.

Parameters

boolean $a_val important pages

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

Referenced by read().

     {
         $this->imp_pages = $a_val;
     }

Here is the caller graph for this function:

◆ setIntroduction()

ilObjWiki::setIntroduction ( $a_introduction )

Set Introduction.

Parameters

string $a_introduction Introduction

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

Referenced by read().

     {
         $this->introduction = $a_introduction;
     }

Here is the caller graph for this function:

◆ setLinkMetadataValues()

ilObjWiki::setLinkMetadataValues ( $a_val )

Set link md values.

Parameters

bool $a_val link metadata values

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

Referenced by read().

     {
         $this->link_md_values = $a_val;
     }

Here is the caller graph for this function:

◆ setOnline()

ilObjWiki::setOnline ( $a_online )

Set Online.

Parameters

boolean $a_online Online

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

Referenced by read().

     {
         $this->online = $a_online;
     }

Here is the caller graph for this function:

◆ setPageToc()

ilObjWiki::setPageToc ( $a_val )

Set page toc.

Parameters

boolean $a_val page toc

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

Referenced by read().

     {
         $this->page_toc = $a_val;
     }

Here is the caller graph for this function:

◆ setPublicNotes()

ilObjWiki::setPublicNotes ( $a_val )

Set public notes.

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

Referenced by read().

     {
         $this->public_notes = $a_val;
     }

Here is the caller graph for this function:

◆ setRating()

ilObjWiki::setRating ( $a_rating )

Set Enable Rating.

Parameters

boolean $a_rating Enable Rating

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

Referenced by read().

     {
         $this->rating = (bool) $a_rating;
     }

Here is the caller graph for this function:

◆ setRatingAsBlock()

ilObjWiki::setRatingAsBlock ( $a_rating )

Set Enable Rating Side Block.

Parameters

boolean $a_rating

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

Referenced by read().

     {
         $this->rating_block = (bool) $a_rating;
     }

Here is the caller graph for this function:

◆ setRatingCategories()

ilObjWiki::setRatingCategories ( $a_rating )

Set Enable Rating Categories.

Parameters

boolean $a_rating

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

Referenced by read().

     {
         $this->rating_categories = (bool) $a_rating;
     }

Here is the caller graph for this function:

◆ setRatingForNewPages()

ilObjWiki::setRatingForNewPages ( $a_rating )

Set Enable Rating For New Pages.

Parameters

boolean $a_rating

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

Referenced by read().

     {
         $this->rating_new_pages = (bool) $a_rating;
     }

Here is the caller graph for this function:

◆ setRatingOverall()

ilObjWiki::setRatingOverall ( $a_rating )

Set Enable Rating For Object.

Parameters

boolean $a_rating Enable Rating

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

Referenced by read().

     {
         $this->rating_overall = (bool) $a_rating;
     }

Here is the caller graph for this function:

◆ setShortTitle()

ilObjWiki::setShortTitle ( $a_shorttitle )

Set ShortTitle.

Parameters

string $a_shorttitle ShortTitle

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

Referenced by read().

     {
         $this->shorttitle = $a_shorttitle;
     }

Here is the caller graph for this function:

◆ setStartPage()

ilObjWiki::setStartPage ( $a_startpage )

Set Start Page.

Parameters

string $a_startpage Start Page

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

References ilWikiUtil\makeDbTitle().

Referenced by read().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setStyleSheetId()

ilObjWiki::setStyleSheetId ( $a_style_id )

set ID of assigned style sheet object

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

Referenced by read().

     {
         $this->style_id = $a_style_id;
     }

Here is the caller graph for this function:

◆ startUserHTMLExport()

ilObjWiki::startUserHTMLExport ( )

Start user html export.

Parameters

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

References ilObject\$db, $ilDB, $ilUser, and $user.

     {
         $ilDB = $this->db;
         $ilUser = $this->user;
 
         include_once("./Modules/Wiki/classes/class.ilWikiUserHTMLExport.php");
 
         $user_export = new ilWikiUserHTMLExport($this, $ilDB, $ilUser);
         $user_export->startUserHTMLExport();
     }

◆ update()

ilObjWiki::update ( $a_prevent_start_page_creation = false )

update object data

public

Returns: boolean

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

References ilObject\$db, $ilDB, ilWikiPage\exists(), getEmptyPageTemplate(), ilObject\getId(), getImportantPages(), getIntroduction(), getLinkMetadataValues(), getOnline(), getPageToc(), getPublicNotes(), getRating(), getRatingAsBlock(), getRatingCategories(), getRatingForNewPages(), getRatingOverall(), getShortTitle(), getStartPage(), getStyleSheetId(), League\Flysystem\Adapter\Polyfill\update(), and ilObjStyleSheet\writeStyleUsage().

     {
         $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->getRating()),
             "rating_side" => array("integer", (bool) $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()),
             "imp_pages" => array("integer", $this->getImportantPages()),
             "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
         include_once("./Modules/Wiki/classes/class.ilWikiPage.php");
         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->create();
         }
 
         include_once("./Services/Style/Content/classes/class.ilObjStyleSheet.php");
         ilObjStyleSheet::writeStyleUsage($this->getId(), $this->getStyleSheetId());
 
         return true;
     }

Here is the call graph for this function:

◆ writeStartPage()

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

static

Write start page.

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

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

Referenced by ilWikiPage\rename().

     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         include_once("./Modules/Wiki/classes/class.ilWikiUtil.php");
         $ilDB->manipulate(
             "UPDATE il_wiki_data SET " .
             " startpage = " . $ilDB->quote(ilWikiUtil::makeDbTitle($a_name), "text") .
             " WHERE id = " . $ilDB->quote($a_id, "integer")
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $empty_page_templ

ilObjWiki::$empty_page_templ = true

protected

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

Referenced by getEmptyPageTemplate().

◆ $link_md_values

ilObjWiki::$link_md_values = false

protected

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

Referenced by getLinkMetadataValues().

◆ $online

ilObjWiki::$online = false

protected

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

Referenced by getOnline().

◆ $public_notes

ilObjWiki::$public_notes = true

protected

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

Referenced by getPublicNotes().

◆ $user

ilObjWiki::$user

protected

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

Referenced by deliverUserHTMLExport(), getUserHTMLExportProgress(), initUserHTMLExport(), and startUserHTMLExport().

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

Modules/Wiki/classes/class.ilObjWiki.php

Public Member Functions

Static Public Member Functions

Protected Attributes

Static Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _lookup()

◆ _lookupImportantPages()

◆ _lookupImportantPagesList()

◆ _lookupLinkMetadataValues()

◆ _lookupMaxOrdNrImportantPages()

◆ _lookupPageToc()

◆ _lookupPublicNotes()

◆ _lookupRating()

◆ _lookupRatingAsBlock()

◆ _lookupRatingCategories()

◆ _lookupRatingOverall()

◆ _lookupStartPage()

◆ _performSearch()

◆ addImportantPage()

◆ checkShortTitleAvailability()

◆ cloneObject()

◆ create()

◆ createWikiPage()

◆ decorateAdvMDValue()

◆ delete()

◆ deliverUserHTMLExport()

◆ fixImportantPagesNumbering()

◆ getAdvMDSubItemTitle()

◆ getEmptyPageTemplate()

◆ getImportantPages()

◆ getIntroduction()

◆ getLinkMetadataValues()

◆ getOnline()

◆ getPageToc()

◆ getPublicNotes()

◆ getRating()

◆ getRatingAsBlock()

◆ getRatingCategories()

◆ getRatingForNewPages()

◆ getRatingOverall()

◆ getShortTitle()

◆ getStartPage()

◆ getStyleSheetId()

◆ getTemplateSelectionOnCreation()

◆ getUserHTMLExportProgress()

◆ initUserHTMLExport()

◆ isImportantPage()

◆ isOnlineHelpWiki()

◆ read()

◆ removeImportantPage()

◆ saveOrderingAndIndentation()

◆ setEmptyPageTemplate()

◆ setImportantPages()

◆ setIntroduction()

◆ setLinkMetadataValues()

◆ setOnline()

◆ setPageToc()

◆ setPublicNotes()

◆ setRating()

◆ setRatingAsBlock()

◆ setRatingCategories()

◆ setRatingForNewPages()

◆ setRatingOverall()

◆ setShortTitle()

◆ setStartPage()

◆ setStyleSheetId()

◆ startUserHTMLExport()

◆ update()

◆ writeStartPage()

Field Documentation

◆ $empty_page_templ

◆ $link_md_values

◆ $online

◆ $public_notes

◆ $user