ILIAS
Release_4_2_x_branch Revision 61807
|
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. | |
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. | |
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 | |
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. | |
addImportantPage ($a_page_id) | |
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. | |
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 | |
_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 | |
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. |
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 | _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 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 | _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, $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. |
Protected Attributes | |
$online = false | |
$public_notes = 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 = 128 |
max length of object title | |
$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 |
|
staticprivate |
Lookup a data field.
int | $a_wiki_id | Wiki ID |
string | $a_field | Field Name |
Definition at line 490 of file class.ilObjWiki.php.
Referenced by _lookupImportantPages(), _lookupPageToc(), _lookupPublicNotes(), _lookupRating(), and _lookupStartPage().
|
static |
Lookup whether important pages are activated.
int | $a_wiki_id | Wiki ID |
Definition at line 578 of file class.ilObjWiki.php.
References _lookup().
|
static |
Get important pages list.
@return |
Definition at line 589 of file class.ilObjWiki.php.
References $ilDB.
Referenced by ilImportantPagesTableGUI\__construct(), ilObjWikiGUI\editImportantPagesObject(), ilWikiImportantPagesBlockGUI\fillDataSection(), fixImportantPagesNumbering(), and saveOrderingAndIndentation().
|
static |
Get important pages list.
@return |
Definition at line 612 of file class.ilObjWiki.php.
References $ilDB.
Referenced by addImportantPage().
|
static |
Lookup whether important pages are activated.
int | $a_wiki_id | Wiki ID |
Definition at line 787 of file class.ilObjWiki.php.
References _lookup().
Referenced by ilWikiPageGUI\__construct().
|
static |
Lookup whether public notes are activated.
int | $a_wiki_id | Wiki ID |
Definition at line 477 of file class.ilObjWiki.php.
References _lookup().
Referenced by ilWikiPageGUI\addHeaderAction(), and ilWikiPageGUI\preview().
|
static |
Lookup whether rating is activated.
int | $a_wiki_id | Wiki ID |
Definition at line 465 of file class.ilObjWiki.php.
References _lookup().
Referenced by ilWikiPageGUI\addHeaderAction().
|
static |
Lookup start page.
int | $a_wiki_id | Wiki ID |
Definition at line 508 of file class.ilObjWiki.php.
References _lookup().
Referenced by ilWikiHandlerGUI\executeCommand(), ilWikiFunctionsBlockGUI\fillDataSection(), ilObjWikiGUI\getGotoLink(), ilWikiPage\getOrphanedPages(), and ilWikiPage\rename().
|
static |
Search in Wiki.
Definition at line 530 of file class.ilObjWiki.php.
References ilObjectSearchFactory\_getWikiContentSearchInstance().
Referenced by ilObjWikiGUI\performSearchObject().
ilObjWiki::addImportantPage | ( | $a_page_id | ) |
Add important page.
int | page id |
Definition at line 630 of file class.ilObjWiki.php.
References $ilDB, _lookupMaxOrdNrImportantPages(), ilObject\getId(), and isImportantPage().
|
static |
Check availability of short title.
Definition at line 352 of file class.ilObjWiki.php.
Referenced by ilObjWikiGUI\saveObject(), and ilObjWikiGUI\saveSettingsObject().
ilObjWiki::create | ( | $a_prevent_start_page_creation = false | ) |
Create new wiki.
Definition at line 211 of file class.ilObjWiki.php.
References $ilDB, ilObject\create(), ilObject\getId(), getIntroduction(), getOnline(), getPublicNotes(), getRating(), getShortTitle(), getStartPage(), getStyleSheetId(), and ilObjStyleSheet\writeStyleUsage().
ilObjWiki::delete | ( | ) |
delete object and all related data
public
Reimplemented from ilObject.
Definition at line 324 of file class.ilObjWiki.php.
References $ilDB, $query, ilWikiPage\deleteAllPagesOfWiki(), ilObject\getId(), ilNotification\removeForObject(), and ilNotification\TYPE_WIKI.
ilObjWiki::fixImportantPagesNumbering | ( | ) |
Fix important pages numbering.
Definition at line 743 of file class.ilObjWiki.php.
References $ilDB, _lookupImportantPagesList(), and ilObject\getId().
Referenced by removeImportantPage().
ilObjWiki::getImportantPages | ( | ) |
Get important pages.
Definition at line 107 of file class.ilObjWiki.php.
Referenced by update().
ilObjWiki::getIntroduction | ( | ) |
Get Introduction.
Definition at line 167 of file class.ilObjWiki.php.
Referenced by create(), and update().
ilObjWiki::getOnline | ( | ) |
Get Online.
Definition at line 51 of file class.ilObjWiki.php.
References $online.
Referenced by create(), and update().
ilObjWiki::getPageToc | ( | ) |
Get page toc.
Definition at line 203 of file class.ilObjWiki.php.
Referenced by update().
ilObjWiki::getPublicNotes | ( | ) |
Get public notes.
Definition at line 87 of file class.ilObjWiki.php.
References $public_notes.
Referenced by create(), and update().
ilObjWiki::getRating | ( | ) |
Get Enable Rating.
Definition at line 71 of file class.ilObjWiki.php.
Referenced by create(), and update().
ilObjWiki::getShortTitle | ( | ) |
Get ShortTitle.
Definition at line 147 of file class.ilObjWiki.php.
Referenced by create(), and update().
ilObjWiki::getStartPage | ( | ) |
Get Start Page.
Definition at line 127 of file class.ilObjWiki.php.
Referenced by create(), and update().
ilObjWiki::getStyleSheetId | ( | ) |
get ID of assigned style sheet object
Definition at line 175 of file class.ilObjWiki.php.
Referenced by create(), and update().
ilObjWiki::ilObjWiki | ( | $a_id = 0 , |
|
$a_call_by_reference = true |
|||
) |
Constructor public.
integer | reference_id or object_id |
boolean | treat the id as reference_id (true) or object_id (false) |
Definition at line 30 of file class.ilObjWiki.php.
References ilObject\ilObject().
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
Reimplemented from ilObject.
Definition at line 375 of file class.ilObjWiki.php.
ilObjWiki::isImportantPage | ( | $a_page_id | ) |
Is page an important page?
@return |
Definition at line 654 of file class.ilObjWiki.php.
References $ilDB.
Referenced by addImportantPage().
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
string | event |
integer | reference id of object where the event occured |
array | passes optional parameters if required |
Reimplemented from ilObject.
Definition at line 405 of file class.ilObjWiki.php.
References $_GET, and ilObject\getType().
ilObjWiki::read | ( | ) |
Read wiki data.
Definition at line 292 of file class.ilObjWiki.php.
References $ilDB, $query, ilObject\getId(), ilObjStyleSheet\lookupObjectStyle(), setImportantPages(), setIntroduction(), setOnline(), setPageToc(), setPublicNotes(), setRating(), setShortTitle(), setStartPage(), and setStyleSheetId().
ilObjWiki::removeImportantPage | ( | $a_id | ) |
Remove important page.
int | page id |
Definition at line 674 of file class.ilObjWiki.php.
References $ilDB, and fixImportantPagesNumbering().
ilObjWiki::saveOrderingAndIndentation | ( | $a_ord, | |
$a_indent | |||
) |
Save ordering and indentation.
@return |
Definition at line 692 of file class.ilObjWiki.php.
References $ilDB, _lookupImportantPagesList(), ilObject\getId(), and ilUtil\sortArray().
ilObjWiki::setImportantPages | ( | $a_val | ) |
Set important pages.
boolean | $a_val | important pages |
Definition at line 97 of file class.ilObjWiki.php.
Referenced by read().
ilObjWiki::setIntroduction | ( | $a_introduction | ) |
Set Introduction.
string | $a_introduction | Introduction |
Definition at line 157 of file class.ilObjWiki.php.
Referenced by read().
ilObjWiki::setOnline | ( | $a_online | ) |
Set Online.
boolean | $a_online | Online |
Definition at line 41 of file class.ilObjWiki.php.
Referenced by read().
ilObjWiki::setPageToc | ( | $a_val | ) |
Set page toc.
boolean | $a_val | page toc |
Definition at line 193 of file class.ilObjWiki.php.
Referenced by read().
ilObjWiki::setPublicNotes | ( | $a_val | ) |
Set public notes.
Definition at line 79 of file class.ilObjWiki.php.
Referenced by read().
ilObjWiki::setRating | ( | $a_rating | ) |
Set Enable Rating.
boolean | $a_rating | Enable Rating |
Definition at line 61 of file class.ilObjWiki.php.
Referenced by read().
ilObjWiki::setShortTitle | ( | $a_shorttitle | ) |
Set ShortTitle.
string | $a_shorttitle | ShortTitle |
Definition at line 137 of file class.ilObjWiki.php.
Referenced by read().
ilObjWiki::setStartPage | ( | $a_startpage | ) |
Set Start Page.
string | $a_startpage | Start Page |
Definition at line 117 of file class.ilObjWiki.php.
References ilWikiUtil\makeDbTitle().
Referenced by read().
ilObjWiki::setStyleSheetId | ( | $a_style_id | ) |
set ID of assigned style sheet object
Definition at line 183 of file class.ilObjWiki.php.
Referenced by read().
ilObjWiki::update | ( | $a_prevent_start_page_creation = false | ) |
update object data
public
Definition at line 250 of file class.ilObjWiki.php.
References $ilDB, ilWikiPage\exists(), ilObject\getId(), getImportantPages(), getIntroduction(), getOnline(), getPageToc(), getPublicNotes(), getRating(), getShortTitle(), getStartPage(), getStyleSheetId(), and ilObjStyleSheet\writeStyleUsage().
|
static |
Write start page.
Definition at line 516 of file class.ilObjWiki.php.
References $ilDB, and ilWikiUtil\makeDbTitle().
Referenced by ilWikiPage\rename().
|
protected |
Definition at line 21 of file class.ilObjWiki.php.
Referenced by getOnline().
|
protected |
Definition at line 22 of file class.ilObjWiki.php.
Referenced by getPublicNotes().