ilObjWiki Class Reference

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.
	setRating ($a_rating)
	Set Enable Rating.
	getRating ()
	Get Enable Rating.
	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
	create ()
	Create new wiki.
	update ()
	update object data
	read ()
	Read wiki data.
	delete ()
	delete object and all related data
	initDefaultRoles ()
	init default roles settings
	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.
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
	_lookupObjIdByImportId ($a_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)
	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)
	_getAllReferences ($a_id)
	get all reference ids of object
	_lookupOwner ($a_id)
	lookup object owner
	_lookupDescription ($a_id)
	lookup object description
	_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
	_lookupObjectId ($a_ref_id)
	lookup object id
	_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
	createReference ()
	creates reference for object
	countReferences ()
	count references of object
	createRoleFolder ()
	creates a local role folder
	setRegisterMode ($a_bool)
	isUserRegistered ($a_user_id=0)
	requireRegistration ()
	getXMLZip ()
	getHTMLDirectory ()
	cloneObject ($a_target_id, $a_copy_id=0)
	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.

Static Public Member Functions
static	checkShortTitleAvailability ($a_short_title)
	Check availability of short title.
static	_lookupRating ($a_wiki_id)
	Lookup whether rating is activated.
static	_lookupStartPage ($a_wiki_id)
	Lookup start page.
static	_performSearch ($a_wiki_id, $a_searchterm)
	Search in Wiki.
Static Public Member Functions inherited from ilObject
static	_lookupTitle ($a_id)
	lookup object title
static	_getIdsForTitle ($title, $type= '', $partialmatch=false)
static	_lookupObjId ($a_id)
static	_lookupType ($a_id, $a_reference=false)
	lookup object type
	_exists ($a_id, $a_reference=false)
	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)
	Prepare copy wizard object selection.
static	_getIcon ($a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
	Get icon for repository item.

Protected Attributes
	$online = false

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

Additional Inherited Members
Data Fields inherited from ilObject
	$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 38 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_id	Wiki ID
string	$a_field	Field Name

Returns

mixed field value

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

References $ilDB, and $query.

Referenced by _lookupRating(), 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::_lookupRating (   $a_wiki_id )

static

Lookup whether rating is activated.

Parameters

int

$a_wiki_id

Wiki ID

Returns

boolean Rating activated?

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

References _lookup().

Referenced by ilWikiPageGUI\preview().

        {
                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::_lookupStartPage (   $a_wiki_id )

static

Lookup start page.

Parameters

int

$a_wiki_id

Wiki ID

Returns

boolean Rating activated?

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

References _lookup().

Referenced by ilObjWikiGUI\getGotoLink(), ilWikiPage\getOrphanedPages(), and ilWikiPageGUI\preview().

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

References ilObjectSearchFactory\_getWikiContentSearchInstance().

Referenced by ilObjWikiGUI\performSearchObject().

        {
                // 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[] = $child;
                                }
                        }
                }

                return $found_pages;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

static ilObjWiki::checkShortTitleAvailability (   $a_short_title )

static

Check availability of short title.

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

(

)

Create new wiki.

Reimplemented from ilObject.

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

References $ilDB, ilObject\getId(), getIntroduction(), getOnline(), 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()),
                        "introduction" => array("clob", $this->getIntroduction())
                        ));
                
                // create start page
                if ($this->getStartPage() != "")
                {
                        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::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 278 of file class.ilObjWiki.php.

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

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

Here is the call graph for this function:

ilObjWiki::getIntroduction

(

)

Get Introduction.

Returns

string Introduction

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

Referenced by create(), and update().

        {
                return $this->introduction;
        }

Here is the caller graph for this function:

ilObjWiki::getOnline

(

)

Get Online.

Returns

boolean Online

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

References $online.

Referenced by create(), and update().

        {
                return $this->online;
        }

Here is the caller graph for this function:

ilObjWiki::getRating

(

)

Get Enable Rating.

Returns

boolean Enable Rating

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

Referenced by create(), and update().

        {
                return $this->rating;
        }

Here is the caller graph for this function:

ilObjWiki::getShortTitle

(

)

Get ShortTitle.

Returns

string ShortTitle

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

Referenced by 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 109 of file class.ilObjWiki.php.

Referenced by 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 157 of file class.ilObjWiki.php.

Referenced by create(), and update().

        {
                return $this->style_id;
        }

Here is the caller graph for this function:

ilObjWiki::ilObjWiki	(		$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 48 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::initDefaultRoles

(

)

init default roles settings

If your module does not require any default roles, delete this method (For an example how this method is used, look at ilObjForum)

public

Returns

array object IDs of created local roles.

Reimplemented from ilObject.

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

        {
                global $rbacadmin;
                
                // create a local role folder
                //$rfoldObj = $this->createRoleFolder("Local roles","Role Folder of forum obj_no.".$this->getId());

                // create moderator role and assign role to rolefolder...
                //$roleObj = $rfoldObj->createRole("Moderator","Moderator of forum obj_no.".$this->getId());
                //$roles[] = $roleObj->getId();

                //unset($rfoldObj);
                //unset($roleObj);

                return $roles ? $roles : array();
        }

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

string	event
integer	reference id of object where the event occured
array	passes optional parameters if required

Returns

boolean

Reimplemented from ilObject.

Definition at line 355 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 249 of file class.ilObjWiki.php.

References $ilDB, $query, ilObject\getId(), ilObjStyleSheet\lookupObjectStyle(), setIntroduction(), setOnline(), setRating(), 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->setRating($rec["rating"]);
                $this->setIntroduction($rec["introduction"]);

                include_once("./Services/Style/classes/class.ilObjStyleSheet.php");
                $this->setStyleSheetId((int) ilObjStyleSheet::lookupObjectStyle($this->getId()));

        }

Here is the call graph for this function:

ilObjWiki::setIntroduction

(

$a_introduction

)

Set Introduction.

Parameters

string

$a_introduction

Introduction

Definition at line 139 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_online

Online

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

Referenced by read().

        {
                $this->online = $a_online;
        }

Here is the caller graph for this function:

ilObjWiki::setRating

(

$a_rating

)

Set Enable Rating.

Parameters

boolean

$a_rating

Enable Rating

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

Referenced by read().

        {
                $this->rating = $a_rating;
        }

Here is the caller graph for this function:

ilObjWiki::setShortTitle

(

$a_shorttitle

)

Set ShortTitle.

Parameters

string

$a_shorttitle

ShortTitle

Definition at line 119 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_startpage

Start Page

Definition at line 99 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 165 of file class.ilObjWiki.php.

Referenced by read().

        {
                $this->style_id = $a_style_id;
        }

Here is the caller graph for this function:

ilObjWiki::update

(

)

update object data

public

Returns

boolean

Reimplemented from ilObject.

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

References $ilDB, ilWikiPage\exists(), ilObject\getId(), getIntroduction(), getOnline(), getRating(), 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" => array("integer", $this->getRating()),
                        "introduction" => array("clob", $this->getIntroduction())
                        ), 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()))
                {
                        $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:

Field Documentation

ilObjWiki::$online = false

protected

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

Referenced by getOnline().

---

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

• Modules/Wiki/classes/class.ilObjWiki.php