Wiki module external functions. More...

Inheritance diagram for mod_wiki_external:

Static Public Member Functions
static	edit_page ($pageid, $content, $section=null)
	Edit a page contents.

static	edit_page_parameters ()
	Describes the parameters for edit_page.

static	edit_page_returns ()
	Describes the edit_page return value.

static	get_page_contents ($pageid)
	Get a page contents.

static	get_page_contents_parameters ()
	Describes the parameters for get_page_contents.

static	get_page_contents_returns ()
	Describes the get_page_contents return value.

static	get_page_for_editing ($pageid, $section=null, $lockonly=false)
	Locks and retrieves info of page-section to be edited.

static	get_page_for_editing_parameters ()
	Describes the parameters for get_page_for_editing.

static	get_page_for_editing_returns ()
	Describes the get_page_for_editing return value.

static	get_subwiki_files ($wikiid, $groupid=-1, $userid=0)
	Returns the list of files from a specific subwiki.

static	get_subwiki_files_parameters ()
	Describes the parameters for get_subwiki_files.

static	get_subwiki_files_returns ()
	Describes the get_subwiki_pages return value.

static	get_subwiki_pages ($wikiid, $groupid=-1, $userid=0, $options=array())
	Returns the list of pages from a specific subwiki.

static	get_subwiki_pages_parameters ()
	Describes the parameters for get_subwiki_pages.

static	get_subwiki_pages_returns ()
	Describes the get_subwiki_pages return value.

static	get_subwikis ($wikiid)
	Returns the list of subwikis the user can see in a specific wiki.

static	get_subwikis_parameters ()
	Describes the parameters for get_subwikis.

static	get_subwikis_returns ()
	Describes the get_subwikis return value.

static	get_wikis_by_courses ($courseids=array())
	Returns a list of wikis in a provided list of courses, if no list is provided all wikis that the user can view will be returned.

static	get_wikis_by_courses_parameters ()
	Describes the parameters for get_wikis_by_courses.

static	get_wikis_by_courses_returns ()
	Describes the get_wikis_by_courses return value.

static	new_page ($title, $content, $contentformat=null, $subwikiid=null, $wikiid=null, $userid=null, $groupid=null)
	Creates a new page.

static	new_page_parameters ()
	Describes the parameters for new_page.

static	new_page_returns ()
	Describes the new_page return value.

static	view_page ($pageid)
	Trigger the page viewed event and update the module completion status.

static	view_page_parameters ()
	Describes the parameters for view_page.

static	view_page_returns ()
	Describes the view_page return value.

static	view_wiki ($wikiid)
	Trigger the course module viewed event and update the module completion status.

static	view_wiki_parameters ()
	Describes the parameters for view_wiki.

static	view_wiki_returns ()
	Describes the view_wiki return value.

Static Protected Member Functions
static	determine_group_and_user ($cm, $wiki, $groupid=-1, $userid=0)
	Utility function for determining the groupid and userid to use.

Detailed Description

Wiki module external functions.

Copyright: 2015 Dani Palou dani@.nosp@m.mood.nosp@m.le.co.nosp@m.m

License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Since: Moodle 3.1

Member Function Documentation

◆ determine_group_and_user()

static mod_wiki_external::determine_group_and_user	(	$cm,
		$wiki,
		$groupid = -1,
		$userid = 0 )

staticprotected

Utility function for determining the groupid and userid to use.

Parameters

stdClass	$cm	The course module.
stdClass	$wiki	The wiki.
int	$groupid	Group ID. If not defined, use current group.
int	$userid	User ID. If not defined, use current user.

Return values

array Array containing the courseid and userid.

Since: Moodle 3.1

◆ edit_page()

static mod_wiki_external::edit_page	(	$pageid,
		$content,
		$section = null )

static

Edit a page contents.

Parameters

int	$pageid	The page ID.
string	$content	Page contents.
int	$section	Section to be edited.

Return values

array of warnings and page data.

Since: Moodle 3.1

◆ edit_page_parameters()

static mod_wiki_external::edit_page_parameters ( )

static

Describes the parameters for edit_page.

Return values

external_function_parameters

Since: Moodle 3.1

◆ edit_page_returns()

static mod_wiki_external::edit_page_returns ( )

static

Describes the edit_page return value.

Return values

external_single_structure

Since: Moodle 3.1

◆ get_page_contents()

static mod_wiki_external::get_page_contents ( $pageid )

static

Get a page contents.

Parameters

int $pageid The page ID.

Return values

array of warnings and page data.

Since: Moodle 3.1

◆ get_page_contents_parameters()

static mod_wiki_external::get_page_contents_parameters ( )

static

Describes the parameters for get_page_contents.

Return values

external_function_parameters

Since: Moodle 3.1

◆ get_page_contents_returns()

static mod_wiki_external::get_page_contents_returns ( )

static

Describes the get_page_contents return value.

Return values

external_single_structure

Since: Moodle 3.1

◆ get_page_for_editing()

static mod_wiki_external::get_page_for_editing	(	$pageid,
		$section = null,
		$lockonly = false )

static

Locks and retrieves info of page-section to be edited.

Parameters

int	$pageid	The page ID.
string	$section	Section page title.
boolean	$lockonly	If true: Just renew lock and not return content.

Return values

array of warnings and page data.

Since: Moodle 3.1

◆ get_page_for_editing_parameters()

static mod_wiki_external::get_page_for_editing_parameters ( )

static

Describes the parameters for get_page_for_editing.

Return values

external_function_parameters

Since: Moodle 3.1

◆ get_page_for_editing_returns()

static mod_wiki_external::get_page_for_editing_returns ( )

static

Describes the get_page_for_editing return value.

Return values

external_single_structure

Since: Moodle 3.1

◆ get_subwiki_files()

static mod_wiki_external::get_subwiki_files	(	$wikiid,
		$groupid = -1,
		$userid = 0 )

static

Returns the list of files from a specific subwiki.

Parameters

int	$wikiid	The wiki instance ID.
int	$groupid	The group ID. If not defined, use current group.
int	$userid	The user ID. If not defined, use current user.

Return values

array Containing a list of warnings and a list of files.

Since: Moodle 3.1

Exceptions

moodle_exception

◆ get_subwiki_files_parameters()

static mod_wiki_external::get_subwiki_files_parameters ( )

static

Describes the parameters for get_subwiki_files.

Return values

external_function_parameters

Since: Moodle 3.1

◆ get_subwiki_files_returns()

static mod_wiki_external::get_subwiki_files_returns ( )

static

Describes the get_subwiki_pages return value.

Return values

external_single_structure

Since: Moodle 3.1

◆ get_subwiki_pages()

static mod_wiki_external::get_subwiki_pages	(	$wikiid,
		$groupid = -1,
		$userid = 0,
		$options = array() )

static

Returns the list of pages from a specific subwiki.

Parameters

int	$wikiid	The wiki instance ID.
int	$groupid	The group ID. If not defined, use current group.
int	$userid	The user ID. If not defined, use current user.
array	$options	Several options like sort by, sort direction, ...

Return values

array Containing a list of warnings and a list of pages.

Since: Moodle 3.1

◆ get_subwiki_pages_parameters()

static mod_wiki_external::get_subwiki_pages_parameters ( )

static

Describes the parameters for get_subwiki_pages.

Return values

external_function_parameters

Since: Moodle 3.1

◆ get_subwiki_pages_returns()

static mod_wiki_external::get_subwiki_pages_returns ( )

static

Describes the get_subwiki_pages return value.

Return values

external_single_structure

Since: Moodle 3.1

◆ get_subwikis()

static mod_wiki_external::get_subwikis ( $wikiid )

static

Returns the list of subwikis the user can see in a specific wiki.

Parameters

int $wikiid The wiki instance ID.

Return values

array Containing a list of warnings and a list of subwikis.

Since: Moodle 3.1

◆ get_subwikis_parameters()

static mod_wiki_external::get_subwikis_parameters ( )

static

Describes the parameters for get_subwikis.

Return values

external_function_parameters

Since: Moodle 3.1

◆ get_subwikis_returns()

static mod_wiki_external::get_subwikis_returns ( )

static

Describes the get_subwikis return value.

Return values

external_single_structure

Since: Moodle 3.1

◆ get_wikis_by_courses()

static mod_wiki_external::get_wikis_by_courses ( $courseids = array() )

static

Returns a list of wikis in a provided list of courses, if no list is provided all wikis that the user can view will be returned.

Parameters

array $courseids The courses IDs.

Return values

array Containing a list of warnings and a list of wikis.

Since: Moodle 3.1

◆ get_wikis_by_courses_parameters()

static mod_wiki_external::get_wikis_by_courses_parameters ( )

static

Describes the parameters for get_wikis_by_courses.

Return values

external_function_parameters

Since: Moodle 3.1

◆ get_wikis_by_courses_returns()

static mod_wiki_external::get_wikis_by_courses_returns ( )

static

Describes the get_wikis_by_courses return value.

Return values

external_single_structure

Since: Moodle 3.1

◆ new_page()

static mod_wiki_external::new_page	(	$title,
		$content,
		$contentformat = null,
		$subwikiid = null,
		$wikiid = null,
		$userid = null,
		$groupid = null )

static

Creates a new page.

Parameters

string	$title	New page title.
string	$content	Page contents.
int	$contentformat	Page contents format. If an invalid format is provided, default wiki format is used.
int	$subwikiid	The Subwiki ID where to store the page.
int	$wikiid	Page::'s wiki ID. Used if subwiki does not exists.
int	$userid	Subwiki::'s user ID. Used if subwiki does not exists.
int	$groupid	Subwiki::'s group ID. Used if subwiki does not exists.

Return values

array of warnings and page data.

Since: Moodle 3.1

◆ new_page_parameters()

static mod_wiki_external::new_page_parameters ( )

static

Describes the parameters for new_page.

Return values

external_function_parameters

Since: Moodle 3.1

◆ new_page_returns()

static mod_wiki_external::new_page_returns ( )

static

Describes the new_page return value.

Return values

external_single_structure

Since: Moodle 3.1

◆ view_page()

static mod_wiki_external::view_page ( $pageid )

static

Trigger the page viewed event and update the module completion status.

Parameters

int $pageid The page ID.

Return values

array of warnings and status result.

Since: Moodle 3.1

Exceptions

moodle_exception if page is not valid.

◆ view_page_parameters()

static mod_wiki_external::view_page_parameters ( )

static

Describes the parameters for view_page.

Return values

external_function_parameters

Since: Moodle 3.1

◆ view_page_returns()

static mod_wiki_external::view_page_returns ( )

static

Describes the view_page return value.

Return values

external_single_structure

Since: Moodle 3.1

◆ view_wiki()

static mod_wiki_external::view_wiki ( $wikiid )

static

Trigger the course module viewed event and update the module completion status.

Parameters

int $wikiid The wiki instance ID.

Return values

array of warnings and status result.

Since: Moodle 3.1

◆ view_wiki_parameters()

static mod_wiki_external::view_wiki_parameters ( )

static

Describes the parameters for view_wiki.

Return values

external_function_parameters

Since: Moodle 3.1

◆ view_wiki_returns()

static mod_wiki_external::view_wiki_returns ( )

static

Describes the view_wiki return value.

Return values

external_single_structure

Since: Moodle 3.1

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

mod/wiki/classes/external.php

Static Public Member Functions

Static Protected Member Functions

Detailed Description

Member Function Documentation

◆ determine_group_and_user()

◆ edit_page()

◆ edit_page_parameters()

◆ edit_page_returns()

◆ get_page_contents()

◆ get_page_contents_parameters()

◆ get_page_contents_returns()

◆ get_page_for_editing()

◆ get_page_for_editing_parameters()

◆ get_page_for_editing_returns()

◆ get_subwiki_files()

◆ get_subwiki_files_parameters()

◆ get_subwiki_files_returns()

◆ get_subwiki_pages()

◆ get_subwiki_pages_parameters()

◆ get_subwiki_pages_returns()

◆ get_subwikis()

◆ get_subwikis_parameters()

◆ get_subwikis_returns()

◆ get_wikis_by_courses()

◆ get_wikis_by_courses_parameters()

◆ get_wikis_by_courses_returns()

◆ new_page()

◆ new_page_parameters()

◆ new_page_returns()

◆ view_page()

◆ view_page_parameters()

◆ view_page_returns()

◆ view_wiki()

◆ view_wiki_parameters()

◆ view_wiki_returns()