core_block_external Class Reference

Blocks external functions. More...

Inheritance diagram for core_block_external:

Static Public Member Functions
static	get_course_blocks ($courseid, $returncontents=false)
	Returns blocks information for a course.
static	get_course_blocks_parameters ()
	Returns description of get_course_blocks parameters.
static	get_course_blocks_returns ()
	Returns description of get_course_blocks result values.
static	get_dashboard_blocks ($userid=0, $returncontents=false, $mypage=MY_PAGE_DEFAULT)
	Returns blocks information for the given user dashboard.
static	get_dashboard_blocks_parameters ()
	Returns description of get_dashboard_blocks parameters.
static	get_dashboard_blocks_returns ()
	Returns description of get_dashboard_blocks result values.

Detailed Description

Blocks external functions.

Copyright

2015 Juan Leyva juan@.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.3

Member Function Documentation

get_course_blocks()

static core_block_external::get_course_blocks ( $courseid, $returncontents = false )

static

Returns blocks information for a course.

Parameters

int	$courseid	The course id
bool	$returncontents	Whether to return the block contents

Return values

array

Blocks list and possible warnings

Exceptions

moodle_exception

Since

Moodle 3.3

get_course_blocks_parameters()

static core_block_external::get_course_blocks_parameters ( )

static

Returns description of get_course_blocks parameters.

Return values

external_function_parameters

Since

Moodle 3.3

get_course_blocks_returns()

static core_block_external::get_course_blocks_returns ( )

static

Returns description of get_course_blocks result values.

Return values

external_single_structure

Since

Moodle 3.3

get_dashboard_blocks()

static core_block_external::get_dashboard_blocks ( $userid = 0, $returncontents = false, $mypage = MY_PAGE_DEFAULT )

static

Returns blocks information for the given user dashboard.

Parameters

int	$userid	The user id to retrieve the blocks from, optional, default is to current user.
bool	$returncontents	Whether to return the block contents
string	$mypage	The page to get blocks of within my

Return values

array

Blocks list and possible warnings

Exceptions

moodle_exception

Since

Moodle 3.6

get_dashboard_blocks_parameters()

static core_block_external::get_dashboard_blocks_parameters ( )

static

Returns description of get_dashboard_blocks parameters.

Return values

external_function_parameters

Since

Moodle 3.6

get_dashboard_blocks_returns()

static core_block_external::get_dashboard_blocks_returns ( )

static

Returns description of get_dashboard_blocks result values.

Return values

external_single_structure

Since

Moodle 3.6

---

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

• blocks/classes/external.php