core_tag_external Class Reference

Inheritance diagram for core_tag_external:

Static Public Member Functions
static	get_tag_areas ()
	Retrieves existing tag areas.
static	get_tag_areas_parameters ()
	Returns description of get_tag_areas() parameters.
static	get_tag_areas_returns ()
	Returns description of get_tag_areas() result value.
static	get_tag_cloud ($tagcollid=0, $isstandard=false, $limit=150, $sort='name', $search='', $fromctx=0, $ctx=0, $rec=1)
	Retrieves a tag cloud for display.
static	get_tag_cloud_parameters ()
	Returns description of get_tag_cloud() parameters.
static	get_tag_cloud_returns ()
	Returns description of get_tag_cloud() result value.
static	get_tag_collections ()
	Retrieves existing tag collections.
static	get_tag_collections_parameters ()
	Returns description of get_tag_collections() parameters.
static	get_tag_collections_returns ()
	Returns description of get_tag_collections() result value.
static	get_tagindex ($params)
	Get tags by their ids.
static	get_tagindex_parameters ()
	Parameters for function get_tagindex()
static	get_tagindex_per_area ($params)
	Returns the tag index per multiple areas if requested.
static	get_tagindex_per_area_parameters ()
	Parameters for function get_tagindex_per_area()
static	get_tagindex_per_area_returns ()
	Return structure for get_tagindex_per_area.
static	get_tagindex_returns ()
	Return structure for get_tag()
static	get_tags ($tags)
	Get tags by their ids.
static	get_tags_parameters ()
	Parameters for function get_tags()
static	get_tags_returns ()
	Return structure for get_tag()
static	update_tags ($tags)
	Update tags.
static	update_tags_parameters ()
	Parameters for function update_tags()
static	update_tags_returns ()
	Return structure for update_tag()

Member Function Documentation

get_tag_areas()

static core_tag_external::get_tag_areas ( )

static

Retrieves existing tag areas.

Return values

array

an array of warnings and objects containing the plugin information

Exceptions

moodle_exception

Since

Moodle 3.7

get_tag_areas_parameters()

static core_tag_external::get_tag_areas_parameters ( )

static

Returns description of get_tag_areas() parameters.

Return values

external_function_parameters

Since

Moodle 3.7

get_tag_areas_returns()

static core_tag_external::get_tag_areas_returns ( )

static

Returns description of get_tag_areas() result value.

Return values

core_external\external_description

Since

Moodle 3.7

get_tag_cloud()

static core_tag_external::get_tag_cloud ( $tagcollid = 0, $isstandard = false, $limit = 150, $sort = 'name', $search = '', $fromctx = 0, $ctx = 0, $rec = 1 )

static

Retrieves a tag cloud for display.

Parameters

int	$tagcollid	tag collection id
bool	$isstandard	return only standard tags
int	$limit	maximum number of tags to retrieve, tags are sorted by the instance count descending here regardless of $sort parameter
string	$sort	sort order for display, default 'name' - tags will be sorted after they are retrieved
string	$search	search string
int	$fromctx	context id where this tag cloud is displayed
int	$ctx	only retrieve tag instances in this context
int	$rec	retrieve tag instances in the $ctx context and it's children (default 1)

Return values

array

an array of warnings and tag cloud information and items

Exceptions

moodle_exception

Since

Moodle 3.7

get_tag_cloud_parameters()

static core_tag_external::get_tag_cloud_parameters ( )

static

Returns description of get_tag_cloud() parameters.

Return values

external_function_parameters

Since

Moodle 3.7

get_tag_cloud_returns()

static core_tag_external::get_tag_cloud_returns ( )

static

Returns description of get_tag_cloud() result value.

Return values

core_external\external_description

Since

Moodle 3.7

get_tag_collections()

static core_tag_external::get_tag_collections ( )

static

Retrieves existing tag collections.

Return values

array

an array of warnings and tag collections

Exceptions

moodle_exception

Since

Moodle 3.7

get_tag_collections_parameters()

static core_tag_external::get_tag_collections_parameters ( )

static

Returns description of get_tag_collections() parameters.

Return values

external_function_parameters

Since

Moodle 3.7

get_tag_collections_returns()

static core_tag_external::get_tag_collections_returns ( )

static

Returns description of get_tag_collections() result value.

Return values

core_external\external_description

Since

Moodle 3.7

get_tagindex()

static core_tag_external::get_tagindex ( $params )

static

Get tags by their ids.

Parameters

array

$params

get_tagindex_parameters()

static core_tag_external::get_tagindex_parameters ( )

static

Parameters for function get_tagindex()

Return values

external_function_parameters

get_tagindex_per_area()

static core_tag_external::get_tagindex_per_area ( $params )

static

Returns the tag index per multiple areas if requested.

Parameters

array

$params

Tag index required information.

Exceptions

moodle_exception

Since

Moodle 3.7

get_tagindex_per_area_parameters()

static core_tag_external::get_tagindex_per_area_parameters ( )

static

Parameters for function get_tagindex_per_area()

Return values

external_function_parameters

Since

Moodle 3.7

get_tagindex_per_area_returns()

static core_tag_external::get_tagindex_per_area_returns ( )

static

Return structure for get_tagindex_per_area.

Return values

core_external\external_description

Since

Moodle 3.7

get_tagindex_returns()

static core_tag_external::get_tagindex_returns ( )

static

Return structure for get_tag()

Return values

core_external\external_description

get_tags()

static core_tag_external::get_tags ( $tags )

static

Get tags by their ids.

Parameters

array

$tags

get_tags_parameters()

static core_tag_external::get_tags_parameters ( )

static

Parameters for function get_tags()

Return values

external_function_parameters

get_tags_returns()

static core_tag_external::get_tags_returns ( )

static

Return structure for get_tag()

Return values

core_external\external_description

update_tags()

static core_tag_external::update_tags ( $tags )

static

Update tags.

Parameters

array

$tags

update_tags_parameters()

static core_tag_external::update_tags_parameters ( )

static

Parameters for function update_tags()

Return values

external_function_parameters

update_tags_returns()

static core_tag_external::update_tags_returns ( )

static

Return structure for update_tag()

Return values

core_external\external_description

---

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

• tag/classes/external.php