class.ilObjWiki.php

Go to the documentation of this file.

<?php

/* Copyright (c) 1998-2010 ILIAS open source, Extended GPL, see docs/LICENSE */

include_once "./classes/class.ilObject.php";
include_once ("./Modules/Wiki/classes/class.ilWikiUtil.php");

class ilObjWiki extends ilObject
{
        protected $online = false;
        
        function ilObjWiki($a_id = 0,$a_call_by_reference = true)
        {
                $this->type = "wiki";
                $this->ilObject($a_id,$a_call_by_reference);
        }

        function setOnline($a_online)
        {
                $this->online = $a_online;
        }

        function getOnline()
        {
                return $this->online;
        }

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

        function getRating()
        {
                return $this->rating;
        }

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

        function getStartPage()
        {
                return $this->startpage;
        }

        function setShortTitle($a_shorttitle)
        {
                $this->shorttitle = $a_shorttitle;
        }

        function getShortTitle()
        {
                return $this->shorttitle;
        }

        function setIntroduction($a_introduction)
        {
                $this->introduction = $a_introduction;
        }

        function getIntroduction()
        {
                return $this->introduction;
        }

        function getStyleSheetId()
        {
                return $this->style_id;
        }

        function setStyleSheetId($a_style_id)
        {
                $this->style_id = $a_style_id;
        }

        function create($a_prevent_start_page_creation = false)
        {
                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() != "" && !$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());
                }
        }

        function update($a_prevent_start_page_creation = false)
        {
                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())
                        && !$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;
        }
        
        function read()
        {
                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()));

        }


        function delete()
        {
                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;
        }

        static function checkShortTitleAvailability($a_short_title)
        {
                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;
        }
        
        function initDefaultRoles()
        {
                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();
        }

        function notify($a_event,$a_ref_id,$a_parent_non_rbac_id,$a_node_id,$a_params = 0)
        {
                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);
        }
        
        static function _lookupRating($a_wiki_id)
        {
                return ilObjWiki::_lookup($a_wiki_id, "rating");
        }

        private static function _lookup($a_wiki_id, $a_field)
        {
                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];
        }

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

        static function _performSearch($a_wiki_id, $a_searchterm)
        {
                // 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;
        }
        
} // END class.ilObjWiki
?>