ILIAS  Release_5_0_x_branch Revision 61816
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions | Static Public Member Functions | Protected Attributes | Static Private Member Functions
ilObjWiki Class Reference
Modules/Wiki

Class ilObjWiki. More...

+ Inheritance diagram for ilObjWiki:
+ Collaboration diagram for ilObjWiki:

Public Member Functions

 ilObjWiki ($a_id=0, $a_call_by_reference=true)
 Constructor public.
 setOnline ($a_online)
 Set Online.
 getOnline ()
 Get Online.
 setRatingOverall ($a_rating)
 Set Enable Rating For Object.
 getRatingOverall ()
 Get Enable Rating For Object.
 setRating ($a_rating)
 Set Enable Rating.
 getRating ()
 Get Enable Rating.
 setRatingAsBlock ($a_rating)
 Set Enable Rating Side Block.
 getRatingAsBlock ()
 Get Enable Rating Side Block.
 setRatingForNewPages ($a_rating)
 Set Enable Rating For New Pages.
 getRatingForNewPages ()
 Get Enable Rating For New Pages.
 setRatingCategories ($a_rating)
 Set Enable Rating Categories.
 getRatingCategories ()
 Get Enable Rating Categories.
 setPublicNotes ($a_val)
 Set public notes.
 getPublicNotes ()
 Get public notes.
 setImportantPages ($a_val)
 Set important pages.
 getImportantPages ()
 Get important pages.
 setStartPage ($a_startpage)
 Set Start Page.
 getStartPage ()
 Get Start Page.
 setShortTitle ($a_shorttitle)
 Set ShortTitle.
 getShortTitle ()
 Get ShortTitle.
 setIntroduction ($a_introduction)
 Set Introduction.
 getIntroduction ()
 Get Introduction.
 getStyleSheetId ()
 get ID of assigned style sheet object
 setStyleSheetId ($a_style_id)
 set ID of assigned style sheet object
 setPageToc ($a_val)
 Set page toc.
 getPageToc ()
 Get page toc.
 setEmptyPageTemplate ($a_val)
 Set empty page template.
 getEmptyPageTemplate ()
 Get empty page template.
 create ($a_prevent_start_page_creation=false)
 Create new wiki.
 update ($a_prevent_start_page_creation=false)
 update object data
 read ()
 Read wiki data.
 delete ()
 delete object and all related data
 notify ($a_event, $a_ref_id, $a_parent_non_rbac_id, $a_node_id, $a_params=0)
 notifys an object about an event occured Based on the event happend, each object may decide how it reacts.
 addImportantPage ($a_page_id, $a_nr=0, $a_indent=0)
 Add important page.
 isImportantPage ($a_page_id)
 Is page an important page?
 removeImportantPage ($a_id)
 Remove important page.
 saveOrderingAndIndentation ($a_ord, $a_indent)
 Save ordering and indentation.
 fixImportantPagesNumbering ()
 Fix important pages numbering.
 cloneObject ($a_target_id, $a_copy_id=0)
 Clone wiki.
 getTemplateSelectionOnCreation ()
 Get template selection on creation? If more than one template (including empty page template) is activated -> return true.
 createWikiPage ($a_page_title, $a_template_page=0)
 Create new wiki page.
- Public Member Functions inherited from ilObject
 ilObject ($a_id=0, $a_reference=true)
 Constructor public.
 withReferences ()
 determines wehter objects are referenced or not (got ref ids or not)
 read ($a_force_db=false)
 read object data from db into object
 getId ()
 get object id public
 setId ($a_id)
 set object id public
 setRefId ($a_id)
 set reference id public
 getRefId ()
 get reference id public
 getType ()
 get object type public
 setType ($a_type)
 set object type public
 getPresentationTitle ()
 get presentation title Normally same as title Overwritten for sessions
 getTitle ()
 get object title public
 getUntranslatedTitle ()
 get untranslated object title public
 setTitle ($a_title)
 set object title
 getDescription ()
 get object description
 setDescription ($a_desc)
 set object description
 getLongDescription ()
 get object long description (stored in object_description)
 getImportId ()
 get import id
 setImportId ($a_import_id)
 set import id
 getOwner ()
 get object owner
 getOwnerName ()
 _lookupOwnerName ($a_owner_id)
 lookup owner name for owner id
 setOwner ($a_owner)
 set object owner
 getCreateDate ()
 get create date public
 getLastUpdateDate ()
 get last update date public
 getDiskUsage ()
 Gets the disk usage of the object in bytes.
 setObjDataRecord ($a_record)
 set object_data record (note: this method should only be called from the ilObjectFactory class)
 create ()
 create
 update ()
 update object in db
 MDUpdateListener ($a_element)
 Meta data update listener.
 createMetaData ()
 create meta data entry
 updateMetaData ()
 update meta data entry
 deleteMetaData ()
 delete meta data entry
 updateOwner ()
 update owner of object in db
 _getIdForImportId ($a_import_id)
 get current object id for import id (static)
 _lookupOwner ($a_id)
 lookup object owner
 _lookupLastUpdate ($a_id, $a_as_string=false)
 lookup last update
 _getLastUpdateOfObjects ($a_objs)
 Get last update for a set of media objects.
 _setDeletedDate ($a_ref_id)
 only called in ilTree::saveSubTree
 _resetDeletedDate ($a_ref_id)
 only called in ilObjectGUI::insertSavedNodes
 _lookupDeletedDate ($a_ref_id)
 only called in ilObjectGUI::insertSavedNodes
 _writeTitle ($a_obj_id, $a_title)
 write title to db (static)
 _writeDescription ($a_obj_id, $a_desc)
 write description to db (static)
 _writeImportId ($a_obj_id, $a_import_id)
 write import id to db (static)
 _isInTrash ($a_ref_id)
 checks wether object is in trash
 _hasUntrashedReference ($a_obj_id)
 checks wether an object has at least one reference that is not in trash
 _getObjectsDataForType ($a_type, $a_omit_trash=false)
 get all objects of a certain type
 putInTree ($a_parent_ref)
 maybe this method should be in tree object!?
 setPermissions ($a_parent_ref)
 set permissions of object
 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.
 createReference ()
 creates reference for object
 countReferences ()
 count references of object
 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
 applyDidacticTemplate ($a_tpl_id)
 Apply template.
 setRegisterMode ($a_bool)
 isUserRegistered ($a_user_id=0)
 requireRegistration ()
 getXMLZip ()
 getHTMLDirectory ()
 cloneObject ($a_target_id, $a_copy_id=0, $a_omit_tree=false)
 Clone object permissions, put in tree ...
 appendCopyInfo ($a_target_id, $a_copy_id)
 Prepend Copy info if object with same name exists in that container.
 cloneDependencies ($a_target_id, $a_copy_id)
 Clone object dependencies.
 cloneMetaData ($target_obj)
 Copy meta data.
 _lookupCreationDate ($a_id)
 Lookup creation date.

Static Public Member Functions

static isOnlineHelpWiki ($a_ref_id)
 Is wiki an online help wiki?
static checkShortTitleAvailability ($a_short_title)
 Check availability of short title.
static _lookupRatingOverall ($a_wiki_id)
 Lookup whether rating is activated for whole object.
static _lookupRating ($a_wiki_id)
 Lookup whether rating is activated.
static _lookupRatingCategories ($a_wiki_id)
 Lookup whether rating categories are activated.
static _lookupRatingAsBlock ($a_wiki_id)
 Lookup whether rating side block is activated.
static _lookupPublicNotes ($a_wiki_id)
 Lookup whether public notes are activated.
static _lookupStartPage ($a_wiki_id)
 Lookup start page.
static writeStartPage ($a_id, $a_name)
 Write start page.
static _performSearch ($a_wiki_id, $a_searchterm)
 Search in Wiki.
static _lookupImportantPages ($a_wiki_id)
 Lookup whether important pages are activated.
static _lookupImportantPagesList ($a_wiki_id)
 Get important pages list.
static _lookupMaxOrdNrImportantPages ($a_wiki_id)
 Get important pages list.
static _lookupPageToc ($a_wiki_id)
 Lookup whether important pages are activated.
static getAdvMDSubItemTitle ($a_obj_id, $a_sub_type, $a_sub_id)
- Static Public Member Functions inherited from ilObject
static _lookupObjIdByImportId ($a_import_id)
static _getAllReferences ($a_id)
 get all reference ids of object
static _lookupTitle ($a_id)
 lookup object title
static _getIdsForTitle ($title, $type= '', $partialmatch=false)
static _lookupDescription ($a_id)
 lookup object description
static _lookupObjId ($a_id)
static setDeletedDates ($a_ref_ids)
 Set deleted date type $ilDB.
static _lookupType ($a_id, $a_reference=false)
 lookup object type
static _lookupObjectId ($a_ref_id)
 lookup object id
static _exists ($a_id, $a_reference=false, $a_type=null)
 checks if an object exists in object_data
static _getObjectsByType ($a_obj_type="", $a_owner="")
 Get objects by type.
static _prepareCloneSelection ($a_ref_ids, $new_type, $show_path=true)
 Prepare copy wizard object selection.
static _getIcon ($a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
 Get icon for repository item.
static collectDeletionDependencies (&$deps, $a_ref_id, $a_obj_id, $a_type, $a_depth=0)
 Collect deletion dependencies.
static getDeletionDependencies ($a_obj_id)
 Get deletion dependencies.
static getLongDescriptions (array $a_obj_ids)
 Get long description data.
static getAllOwnedRepositoryObjects ($a_user_id)
 Get all ids of objects user owns.
static hasAutoRating ($a_type, $a_ref_id)
 Check if auto rating is active for parent group/course.

Protected Attributes

 $online = false
 $public_notes = true
 $empty_page_templ = true

Static Private Member Functions

static _lookup ($a_wiki_id, $a_field)
 Lookup a data field.

Additional Inherited Members

- Data Fields inherited from ilObject
const TITLE_LENGTH = 255
 max length of object title
const DESC_LENGTH = 128
 $ilias
 $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
 $obj_data_record
 object_data record

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.

Member Function Documentation

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

Lookup a data field.

Parameters
int$a_wiki_idWiki ID
string$a_fieldField Name
Returns
mixed field value

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

References $ilDB, and $query.

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

{
global $ilDB;
$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:

static ilObjWiki::_lookupImportantPages (   $a_wiki_id)
static

Lookup whether important pages are activated.

Parameters
int$a_wiki_idWiki ID
Returns
boolean Important pages activated?

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

References _lookup().

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

+ Here is the call graph for this function:

static ilObjWiki::_lookupImportantPagesList (   $a_wiki_id)
static

Get important pages list.

Parameters
@return

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

References $ilDB.

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

{
global $ilDB;
$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:

static ilObjWiki::_lookupMaxOrdNrImportantPages (   $a_wiki_id)
static

Get important pages list.

Parameters
@return

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

References $ilDB.

Referenced by addImportantPage().

{
global $ilDB;
$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:

static ilObjWiki::_lookupPageToc (   $a_wiki_id)
static

Lookup whether important pages are activated.

Parameters
int$a_wiki_idWiki ID
Returns
boolean Important pages activated?

Definition at line 928 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:

static ilObjWiki::_lookupPublicNotes (   $a_wiki_id)
static

Lookup whether public notes are activated.

Parameters
int$a_wiki_idWiki ID
Returns
boolean public notes activated?

Definition at line 615 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:

static ilObjWiki::_lookupRating (   $a_wiki_id)
static

Lookup whether rating is activated.

Parameters
int$a_wiki_idWiki ID
Returns
boolean Rating activated?

Definition at line 579 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:

static ilObjWiki::_lookupRatingAsBlock (   $a_wiki_id)
static

Lookup whether rating side block is activated.

Parameters
int$a_wiki_idWiki ID
Returns
boolean Rating side block activated?

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

References _lookup().

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

+ Here is the call graph for this function:

static ilObjWiki::_lookupRatingCategories (   $a_wiki_id)
static

Lookup whether rating categories are activated.

Parameters
int$a_wiki_idWiki ID
Returns
boolean Rating categories activated?

Definition at line 591 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:

static ilObjWiki::_lookupRatingOverall (   $a_wiki_id)
static

Lookup whether rating is activated for whole object.

Parameters
int$a_wiki_idWiki ID
Returns
boolean Rating activated?

Definition at line 567 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:

static ilObjWiki::_lookupStartPage (   $a_wiki_id)
static

Lookup start page.

Parameters
int$a_wiki_idWiki ID
Returns
boolean

Definition at line 646 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:

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

Search in Wiki.

Definition at line 668 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:

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

Add important page.

Parameters
intpage id

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

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

{
global $ilDB;
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:

static ilObjWiki::checkShortTitleAvailability (   $a_short_title)
static

Check availability of short title.

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

References $ilDB, and $res.

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

{
global $ilDB;
$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:

ilObjWiki::cloneObject (   $a_target_id,
  $a_copy_id = 0 
)

Clone wiki.

Parameters
inttarget ref_id
intcopy id

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

References $ilDB, ilObject\$ilias, $ilUser, ilCopyWizardOptions\_getInstance(), _lookupImportantPagesList(), ilObjStyleSheet\_lookupStandard(), ilRatingCategory\getAllForObject(), ilWikiPage\getAllPages(), ilObject\getId(), getImportantPages(), getIntroduction(), getOnline(), ilWikiPage\getPageIdForTitle(), getPageToc(), getPublicNotes(), getRating(), getRatingAsBlock(), getRatingCategories(), getRatingForNewPages(), getRatingOverall(), getShortTitle(), getStartPage(), getStyleSheetId(), and ilObject\getTitle().

{
global $ilDB, $ilUser, $ilias;
$new_obj = parent::cloneObject($a_target_id,$a_copy_id);
//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());
$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/classes/class.ilObjStyleSheet.php");
$style_id = $this->getStyleSheetId();
if ($style_id > 0 && !ilObjStyleSheet::_lookupStandard($style_id))
{
$style_obj = $ilias->obj_factory->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::getAllPages($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:

ilObjWiki::create (   $a_prevent_start_page_creation = false)

Create new wiki.

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

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

{
global $ilDB;
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/classes/class.ilObjStyleSheet.php");
ilObjStyleSheet::writeStyleUsage($this->getId(), $this->getStyleSheetId());
}
}

+ Here is the call graph for this function:

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

Create new wiki page.

Parameters
string$a_page_titlepage title
int$a_template_pagetemplate page id
Returns
ilWikiPage new wiki page

Definition at line 1055 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:

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

Reimplemented from ilObject.

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

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

{
global $ilDB;
// 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:

ilObjWiki::fixImportantPagesNumbering ( )

Fix important pages numbering.

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

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

Referenced by removeImportantPage().

{
global $ilDB;
$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:

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

Implements ilAdvancedMetaDataSubItems.

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

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

{
global $lng;
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:

ilObjWiki::getEmptyPageTemplate ( )

Get empty page template.

Returns
boolean empty page template

Definition at line 305 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:

ilObjWiki::getImportantPages ( )

Get important pages.

Returns
boolean important pages

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

Referenced by cloneObject(), and update().

{
return $this->imp_pages;
}

+ Here is the caller graph for this function:

ilObjWiki::getIntroduction ( )

Get Introduction.

Returns
string Introduction

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

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

{
return $this->introduction;
}

+ Here is the caller graph for this function:

ilObjWiki::getOnline ( )

Get Online.

Returns
boolean Online

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

References $online.

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

{
return $this->online;
}

+ Here is the caller graph for this function:

ilObjWiki::getPageToc ( )

Get page toc.

Returns
boolean page toc

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

Referenced by cloneObject(), and update().

{
return $this->page_toc;
}

+ Here is the caller graph for this function:

ilObjWiki::getPublicNotes ( )

Get public notes.

Definition at line 169 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:

ilObjWiki::getRating ( )

Get Enable Rating.

Returns
boolean Enable Rating

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

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

{
return $this->rating;
}

+ Here is the caller graph for this function:

ilObjWiki::getRatingAsBlock ( )

Get Enable Rating Side Block.

Returns
boolean

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

Referenced by cloneObject(), and update().

{
return $this->rating_block;
}

+ Here is the caller graph for this function:

ilObjWiki::getRatingCategories ( )

Get Enable Rating Categories.

Returns
boolean

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

Referenced by cloneObject(), and update().

{
return $this->rating_categories;
}

+ Here is the caller graph for this function:

ilObjWiki::getRatingForNewPages ( )

Get Enable Rating For New Pages.

Returns
boolean

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

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

{
return $this->rating_new_pages;
}

+ Here is the caller graph for this function:

ilObjWiki::getRatingOverall ( )

Get Enable Rating For Object.

Returns
boolean Enable Rating

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

Referenced by cloneObject(), and update().

{
return $this->rating_overall;
}

+ Here is the caller graph for this function:

ilObjWiki::getShortTitle ( )

Get ShortTitle.

Returns
string ShortTitle

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

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

{
return $this->shorttitle;
}

+ Here is the caller graph for this function:

ilObjWiki::getStartPage ( )

Get Start Page.

Returns
string Start Page

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

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

{
return $this->startpage;
}

+ Here is the caller graph for this function:

ilObjWiki::getStyleSheetId ( )

get ID of assigned style sheet object

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

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

{
return $this->style_id;
}

+ Here is the caller graph for this function:

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 1034 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:

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

Constructor public.

Parameters
integerreference_id or object_id
booleantreat the id as reference_id (true) or object_id (false)

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

References ilObject\ilObject().

{
$this->type = "wiki";
$this->ilObject($a_id,$a_call_by_reference);
}

+ Here is the call graph for this function:

ilObjWiki::isImportantPage (   $a_page_id)

Is page an important page?

Parameters
@return

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

References $ilDB.

Referenced by addImportantPage().

{
global $ilDB;
$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:

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 315 of file class.ilObjWiki.php.

{
if ($a_ref_id > 0 && $a_ref_id == OH_REF_ID)
{
// return true;
}
return false;
}
ilObjWiki::notify (   $a_event,
  $a_ref_id,
  $a_parent_non_rbac_id,
  $a_node_id,
  $a_params = 0 
)

notifys an object about an event occured Based on the event happend, each object may decide how it reacts.

If you are not required to handle any events related to your module, just delete this method. (For an example how this method is used, look at ilObjGroup)

public

Parameters
stringevent
integerreference id of object where the event occured
arraypasses optional parameters if required
Returns
boolean

Reimplemented from ilObject.

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

References $_GET, and ilObject\getType().

{
global $tree;
switch ($a_event)
{
case "link":
//var_dump("<pre>",$a_params,"</pre>");
//echo "Module name ".$this->getRefId()." triggered by link event. Objects linked into target object ref_id: ".$a_ref_id;
//exit;
break;
case "cut":
//echo "Module name ".$this->getRefId()." triggered by cut event. Objects are removed from target object ref_id: ".$a_ref_id;
//exit;
break;
case "copy":
//var_dump("<pre>",$a_params,"</pre>");
//echo "Module name ".$this->getRefId()." triggered by copy event. Objects are copied into target object ref_id: ".$a_ref_id;
//exit;
break;
case "paste":
//echo "Module name ".$this->getRefId()." triggered by paste (cut) event. Objects are pasted into target object ref_id: ".$a_ref_id;
//exit;
break;
case "new":
//echo "Module name ".$this->getRefId()." triggered by paste (new) event. Objects are applied to target object ref_id: ".$a_ref_id;
//exit;
break;
}
// At the beginning of the recursive process it avoids second call of the notify function with the same parameter
if ($a_node_id==$_GET["ref_id"])
{
$parent_obj =& $this->ilias->obj_factory->getInstanceByRefId($a_node_id);
$parent_type = $parent_obj->getType();
if($parent_type == $this->getType())
{
$a_node_id = (int) $tree->getParentId($a_node_id);
}
}
parent::notify($a_event,$a_ref_id,$a_parent_non_rbac_id,$a_node_id,$a_params);
}

+ Here is the call graph for this function:

ilObjWiki::read ( )

Read wiki data.

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

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

{
global $ilDB;
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"]);
include_once("./Services/Style/classes/class.ilObjStyleSheet.php");
$this->setStyleSheetId((int) ilObjStyleSheet::lookupObjectStyle($this->getId()));
}

+ Here is the call graph for this function:

ilObjWiki::removeImportantPage (   $a_id)

Remove important page.

Parameters
intpage id

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

References $ilDB, and fixImportantPagesNumbering().

{
global $ilDB;
$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:

ilObjWiki::saveOrderingAndIndentation (   $a_ord,
  $a_indent 
)

Save ordering and indentation.

Parameters
@return

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

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

{
global $ilDB;
$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:

ilObjWiki::setEmptyPageTemplate (   $a_val)

Set empty page template.

Parameters
boolean$a_valempty page template

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

Referenced by read().

{
$this->empty_page_templ = $a_val;
}

+ Here is the caller graph for this function:

ilObjWiki::setImportantPages (   $a_val)

Set important pages.

Parameters
boolean$a_valimportant pages

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

Referenced by read().

{
$this->imp_pages = $a_val;
}

+ Here is the caller graph for this function:

ilObjWiki::setIntroduction (   $a_introduction)

Set Introduction.

Parameters
string$a_introductionIntroduction

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

Referenced by read().

{
$this->introduction = $a_introduction;
}

+ Here is the caller graph for this function:

ilObjWiki::setOnline (   $a_online)

Set Online.

Parameters
boolean$a_onlineOnline

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

Referenced by read().

{
$this->online = $a_online;
}

+ Here is the caller graph for this function:

ilObjWiki::setPageToc (   $a_val)

Set page toc.

Parameters
boolean$a_valpage toc

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

Referenced by read().

{
$this->page_toc = $a_val;
}

+ Here is the caller graph for this function:

ilObjWiki::setPublicNotes (   $a_val)

Set public notes.

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

Referenced by read().

{
$this->public_notes = $a_val;
}

+ Here is the caller graph for this function:

ilObjWiki::setRating (   $a_rating)

Set Enable Rating.

Parameters
boolean$a_ratingEnable Rating

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

Referenced by read().

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

+ Here is the caller graph for this function:

ilObjWiki::setRatingAsBlock (   $a_rating)

Set Enable Rating Side Block.

Parameters
boolean$a_rating

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

Referenced by read().

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

+ Here is the caller graph for this function:

ilObjWiki::setRatingCategories (   $a_rating)

Set Enable Rating Categories.

Parameters
boolean$a_rating

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

Referenced by read().

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

+ Here is the caller graph for this function:

ilObjWiki::setRatingForNewPages (   $a_rating)

Set Enable Rating For New Pages.

Parameters
boolean$a_rating

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

Referenced by read().

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

+ Here is the caller graph for this function:

ilObjWiki::setRatingOverall (   $a_rating)

Set Enable Rating For Object.

Parameters
boolean$a_ratingEnable Rating

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

Referenced by read().

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

+ Here is the caller graph for this function:

ilObjWiki::setShortTitle (   $a_shorttitle)

Set ShortTitle.

Parameters
string$a_shorttitleShortTitle

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

Referenced by read().

{
$this->shorttitle = $a_shorttitle;
}

+ Here is the caller graph for this function:

ilObjWiki::setStartPage (   $a_startpage)

Set Start Page.

Parameters
string$a_startpageStart Page

Definition at line 199 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:

ilObjWiki::setStyleSheetId (   $a_style_id)

set ID of assigned style sheet object

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

Referenced by read().

{
$this->style_id = $a_style_id;
}

+ Here is the caller graph for this function:

ilObjWiki::update (   $a_prevent_start_page_creation = false)

update object data

public

Returns
boolean

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

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

{
global $ilDB;
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()),
"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/classes/class.ilObjStyleSheet.php");
ilObjStyleSheet::writeStyleUsage($this->getId(), $this->getStyleSheetId());
return true;
}

+ Here is the call graph for this function:

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

Write start page.

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

References $ilDB, and ilWikiUtil\makeDbTitle().

Referenced by ilWikiPage\rename().

{
global $ilDB;
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

ilObjWiki::$empty_page_templ = true
protected

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

Referenced by getEmptyPageTemplate().

ilObjWiki::$online = false
protected

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

Referenced by getOnline().

ilObjWiki::$public_notes = true
protected

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

Referenced by getPublicNotes().

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