class.ilObjWiki.php

Go to the documentation of this file.

<?php
/*
        +-----------------------------------------------------------------------------+
        | ILIAS open source                                                           |
        +-----------------------------------------------------------------------------+
        | Copyright (c) 1998-2008 ILIAS open source, University of Cologne            |
        |                                                                             |
        | This program is free software; you can redistribute it and/or               |
        | modify it under the terms of the GNU General Public License                 |
        | as published by the Free Software Foundation; either version 2              |
        | of the License, or (at your option) any later version.                      |
        |                                                                             |
        | This program is distributed in the hope that it will be useful,             |
        | but WITHOUT ANY WARRANTY; without even the implied warranty of              |
        | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               |
        | GNU General Public License for more details.                                |
        |                                                                             |
        | You should have received a copy of the GNU General Public License           |
        | along with this program; if not, write to the Free Software                 |
        | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA. |
        +-----------------------------------------------------------------------------+
*/

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

                parent::create();
                
                $query = "INSERT INTO il_wiki_data (".
                        " id".
                        ", online".
                        ", startpage".
                        ", short".
                        ", rating".
                        ", introduction".
                        " ) VALUES (".
                        $ilDB->quote($this->getId())
                        .",".$ilDB->quote($this->getOnline())
                        .",".$ilDB->quote($this->getStartPage())
                        .",".$ilDB->quote($this->getShortTitle())
                        .",".$ilDB->quote($this->getRating())
                        .",".$ilDB->quote($this->getIntroduction())
                        .")";
                $ilDB->query($query);
                
                // 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();
                }

        }

        function update()
        {
                global $ilDB;
                
                if (!parent::update())
                {                       
                        return false;
                }
                
                // update wiki data
                $st = $ilDB->prepareManip("UPDATE il_wiki_data SET ".
                        " online = ?, startpage = ?, short = ?, ".
                        " rating = ?, introduction = ? ".
                        " WHERE id = ?",
                        array("boolean","text","text","boolean","text","integer")); 
                $ilDB->execute($st, array(
                        $this->getOnline(),
                        $this->getStartPage(),
                        $this->getShortTitle(),
                        $this->getRating(),
                        $this->getIntroduction(),
                        $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();
                }

                return true;
        }
        
        function read()
        {
                global $ilDB;
                
                parent::read();
                
                $query = "SELECT * FROM il_wiki_data WHERE id = ".
                        $ilDB->quote($this->getId());
                $set = $ilDB->query($query);
                $rec = $set->fetchRow(DB_FETCHMODE_ASSOC);

                $this->setOnline($rec["online"]);
                $this->setStartPage($rec["startpage"]);
                $this->setShortTitle($rec["short"]);
                $this->setRating($rec["rating"]);
                $this->setIntroduction($rec["introduction"]);

        }


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

        static function checkShortTitleAvailability($a_short_title)
        {
                global $ilDB;
                
                $st = $ilDB->prepare("SELECT * FROM il_wiki_data WHERE short = ?",
                        array("text"));
                $res = $ilDB->execute($st, 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 * FROM il_wiki_data WHERE id = ".
                        $ilDB->quote($a_wiki_id);
                $set = $ilDB->query($query);
                $rec = $set->fetchRow(DB_FETCHMODE_ASSOC);
                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
?>