core_customfield_external Class Reference

External interface library for customfields component. More...

Inheritance diagram for core_customfield_external:

Static Public Member Functions
static	create_category ($component, $area, $itemid)
	Create category function.
static	create_category_parameters ()
	Parameters for create category.
static	create_category_returns ()
	Return for create category.
static	delete_category ($id)
	Delete category function.
static	delete_category_parameters ()
	Parameters for delete category.
static	delete_category_returns ()
	Return for delete category.
static	delete_field ($id)
	Delete custom field function.
static	delete_field_parameters ()
	Parameters for delete_field.
static	delete_field_returns ()
	Return for delete_field.
static	move_category (int $id, int $beforeid)
	Reorder categories.
static	move_category_parameters ()
	Return for move category.
static	move_category_returns ()
	Return for move category.
static	move_field ($id, $categoryid, $beforeid)
	Move/reorder field.
static	move_field_parameters ()
	Parameters for move field.
static	move_field_returns ()
	Return for move field.
static	reload_template ($component, $area, $itemid)
	Reload template function.
static	reload_template_parameters ()
	Parameters for reload template function.
static	reload_template_returns ()
	Ajax returns on reload template.

Detailed Description

External interface library for customfields component.

Copyright

2018 David Matamoros david.nosp@m.mc@m.nosp@m.oodle.nosp@m..com

License

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

Member Function Documentation

create_category()

static core_customfield_external::create_category ( $component, $area, $itemid )

static

Create category function.

Parameters

string	$component
string	$area
int	$itemid

Return values

mixed

create_category_parameters()

static core_customfield_external::create_category_parameters ( )

static

Parameters for create category.

Return values

external_function_parameters

delete_category()

static core_customfield_external::delete_category ( $id )

static

Delete category function.

Parameters

int

$id

delete_category_parameters()

static core_customfield_external::delete_category_parameters ( )

static

Parameters for delete category.

Return values

external_function_parameters

delete_field()

static core_customfield_external::delete_field ( $id )

static

Delete custom field function.

Parameters

int

$id

delete_field_parameters()

static core_customfield_external::delete_field_parameters ( )

static

Parameters for delete_field.

Return values

external_function_parameters

move_category()

static core_customfield_external::move_category ( int $id, int $beforeid )

static

Reorder categories.

Move category to the new position

Parameters

int	$id	category id
int	$beforeid

move_category_parameters()

static core_customfield_external::move_category_parameters ( )

static

Return for move category.

Return values

external_function_parameters

move_field()

static core_customfield_external::move_field ( $id, $categoryid, $beforeid )

static

Move/reorder field.

Move a field to another category and/or change sortorder of fields

Parameters

int	$id	field id
int	$categoryid
int	$beforeid

move_field_parameters()

static core_customfield_external::move_field_parameters ( )

static

Parameters for move field.

Return values

external_function_parameters

reload_template()

static core_customfield_external::reload_template ( $component, $area, $itemid )

static

Reload template function.

Parameters

string	$component
string	$area
int	$itemid

Return values

array|object|stdClass

reload_template_parameters()

static core_customfield_external::reload_template_parameters ( )

static

Parameters for reload template function.

Return values

external_function_parameters

reload_template_returns()

static core_customfield_external::reload_template_returns ( )

static

Ajax returns on reload template.

Return values

external_single_structure

---

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

• customfield/externallib.php