glossary_full_portfolio_caller Class Reference

class to handle exporting an entire glossary database More...

Inheritance diagram for glossary_full_portfolio_caller:

Public Member Functions
	check_permissions ()
	make sure that the current user is allowed to do this
	expected_time ()
	how long might we expect this export to take
	expected_time_file ()
	Helper method to calculate expected time for multi or single file exports.
	export_config_form (&$mform, $instance)
	If this caller wants any additional config items, they should be defined here.
	export_config_validation ($data)
	Just like the moodle form validation function, this is passed in the data array from the form and if a non empty array is returned, form processing will stop.
	get ($key)
	Override the parent get function to make sure when we're asked for a course, We retrieve the object from the database as needed.
	get_allowed_export_config ()
	Similar to the other allowed_config functions if you need export config, you must provide a list of what the fields are.
	get_export_config ($key)
	Returns a particular export config value.
	get_export_summary ()
	After the user submits their config, they're given a confirm screen summarising what they've chosen.
	get_mimetype ()
	Gets mimetype.
	get_navigation ()
	Navigation passed to print_header.
	get_return_url ()
	The url to return to after export or on cancel.
	get_sha1 ()
	return the sha1 of this content
	get_sha1_file ()
	Helper function to calculate the sha1 for multi or single file exports.
	has_export_config ()
	Whether this caller wants any additional config during export (eg options or metadata)
	heading_summary ()
	Return a string to put at the header summarising this export.
	load_data ()
	load up all data required for this export.
	prepare_package ()
	prepare the package ready to be passed off to the portfolio plugin
	prepare_package_file ()
	Helper function to copy files into the temp area for single or multi file exports.
	set ($field, &$value)
	Generic setter for properties belonging to this instance outside the subclass like name, visible, etc.
	set_context ($PAGE)
	Overridden to return the course module context.
	set_export_config ($config)
	Stores the config generated at export time.
	set_file_and_format_data ($ids=null)
	Set up the required files for this export.
	set_formats_from_button ($formats)
	The button-location always knows best what the formats are... so it should be trusted.
	supported_formats ()
	Array of formats this caller supports.

Static Public Member Functions
static	base_supported_formats ()
	what formats this function generally supports
static	display_name ()
	return a nice name to be displayed about this export location
static	expected_callbackargs ()
	return array of expected call back arguments and whether they are required or not

Protected Member Functions
	add_format ($format)
	Adds a new format to the list of supported formats.

Protected Attributes
object	$cm
	coursemodule object.
stdclass	$course
	course object
array	$exportconfig = array()
	configuration used for export.
stdClass	$exporter
	a reference to the exporter object
int	$id
	cmid
string	$intendedmimetype
	set this for generated-file exports
stored_file object	$multifiles
	set this for multi file exports
stored_file	$singlefile
	single file exports configuration
array	$supportedformats
	can be optionally overridden by subclass constructors
stdclass	$user
	user currently exporting content

Detailed Description

class to handle exporting an entire glossary database

Member Function Documentation

add_format()

portfolio_caller_base::add_format ( $format )

protectedinherited

Adds a new format to the list of supported formats.

This functions also handles removing conflicting and less specific formats at the same time.

Parameters

string

$format

one of PORTFOLIO_FORMAT_XX

Return values

void

base_supported_formats()

static glossary_full_portfolio_caller::base_supported_formats ( )

static

what formats this function generally supports

Return values

array

Reimplemented from portfolio_caller_base.

check_permissions()

glossary_full_portfolio_caller::check_permissions

(

)

make sure that the current user is allowed to do this

Return values

boolean

Reimplemented from portfolio_caller_base.

display_name()

static glossary_full_portfolio_caller::display_name ( )

static

return a nice name to be displayed about this export location

Return values

string

Reimplemented from portfolio_caller_base.

expected_callbackargs()

static glossary_full_portfolio_caller::expected_callbackargs ( )

static

return array of expected call back arguments and whether they are required or not

Return values

array

Reimplemented from portfolio_caller_base.

expected_time()

glossary_full_portfolio_caller::expected_time

(

)

how long might we expect this export to take

Return values

constant

one of PORTFOLIO_TIME_XX

Reimplemented from portfolio_caller_base.

expected_time_file()

portfolio_caller_base::expected_time_file ( )

inherited

Helper method to calculate expected time for multi or single file exports.

Return values

string

file time expectation

export_config_form()

portfolio_caller_base::export_config_form ( & $mform, $instance )

inherited

If this caller wants any additional config items, they should be defined here.

Parameters

moodleform	$mform	passed by reference, add elements to it.
portfolio_plugin_base	$instance	subclass of portfolio_plugin_base

Reimplemented in data_portfolio_caller.

export_config_validation()

portfolio_caller_base::export_config_validation ( $data )

inherited

Just like the moodle form validation function, this is passed in the data array from the form and if a non empty array is returned, form processing will stop.

Parameters

array

$data

data from form.

get()

portfolio_module_caller_base::get ( $key )

inherited

Override the parent get function to make sure when we're asked for a course, We retrieve the object from the database as needed.

Parameters

string

$key

the name of get function

Return values

stdClass

Reimplemented from portfolio_caller_base.

get_allowed_export_config()

portfolio_caller_base::get_allowed_export_config ( )

inherited

Similar to the other allowed_config functions if you need export config, you must provide a list of what the fields are.

Even if you want to store stuff during export without displaying a form to the user, you can use this.

Return values

array

array of allowed keys

Reimplemented in data_portfolio_caller.

get_export_config()

portfolio_caller_base::get_export_config ( $key )

finalinherited

Returns a particular export config value.

Subclasses shouldn't need to override this

Parameters

string

$key

the config item to fetch

Return values

null|mixed

of export configuration

get_export_summary()

portfolio_caller_base::get_export_summary ( )

inherited

After the user submits their config, they're given a confirm screen summarising what they've chosen.

This function should return a table of nice strings => values of what they've chosen to be displayed in a table.

Return values

bool

get_mimetype()

portfolio_caller_base::get_mimetype ( )

inherited

Gets mimetype.

Return values

string

get_navigation()

portfolio_module_caller_base::get_navigation ( )

inherited

Navigation passed to print_header.

Override this to do something more specific than the module view page like adding more links to the breadcrumb.

Return values

array

Reimplemented from portfolio_caller_base.

Reimplemented in forum_portfolio_caller, and mod_workshop_portfolio_caller.

get_return_url()

portfolio_module_caller_base::get_return_url ( )

inherited

The url to return to after export or on cancel.

Defaults value is set to the module 'view' page. Override this if it's deeper inside the module.

Return values

string

Reimplemented from portfolio_caller_base.

Reimplemented in chat_portfolio_caller, forum_portfolio_caller, and mod_workshop_portfolio_caller.

get_sha1()

glossary_full_portfolio_caller::get_sha1

(

)

return the sha1 of this content

Return values

string

Reimplemented from portfolio_caller_base.

get_sha1_file()

portfolio_caller_base::get_sha1_file ( )

inherited

Helper function to calculate the sha1 for multi or single file exports.

Return values

string

sha1 file exports

has_export_config()

portfolio_caller_base::has_export_config ( )

inherited

Whether this caller wants any additional config during export (eg options or metadata)

Return values

bool

Reimplemented in data_portfolio_caller.

heading_summary()

portfolio_module_caller_base::heading_summary ( )

inherited

Return a string to put at the header summarising this export.

by default, this function just display the name and module instance name. Override this to do something more specific

Return values

string

Reimplemented from portfolio_caller_base.

load_data()

glossary_full_portfolio_caller::load_data

(

)

load up all data required for this export.

Return values

void

Reimplemented from portfolio_caller_base.

prepare_package()

glossary_full_portfolio_caller::prepare_package

(

)

prepare the package ready to be passed off to the portfolio plugin

Return values

void

Reimplemented from portfolio_caller_base.

prepare_package_file()

portfolio_caller_base::prepare_package_file ( )

inherited

Helper function to copy files into the temp area for single or multi file exports.

Return values

stored_file|bool

set()

portfolio_caller_base::set ( $field, & $value )

finalinherited

Generic setter for properties belonging to this instance outside the subclass like name, visible, etc.

Parameters

string	$field	property's name
mixed	$value	property's value

Return values

bool

Exceptions

moodle_exception

set_context()

portfolio_module_caller_base::set_context ( $PAGE )

inherited

Overridden to return the course module context.

Parameters

moodle_page

$PAGE

global PAGE

Reimplemented from portfolio_caller_base.

set_export_config()

portfolio_caller_base::set_export_config ( $config )

finalinherited

Stores the config generated at export time.

Subclasses can retrieve values using

See also

get_export_config

Parameters

array

$config

formdata

set_file_and_format_data()

portfolio_caller_base::set_file_and_format_data ( $ids = null )

inherited

Set up the required files for this export.

This supports either passing files directly or passing area arguments directly through to the files api using file_storage\get_area_files

Parameters

mixed

$ids

one of: single file id single stored_file object array of file ids or stored_file objects null

Return values

void

set_formats_from_button()

portfolio_caller_base::set_formats_from_button ( $formats )

inherited

The button-location always knows best what the formats are... so it should be trusted.

Todo

MDL-31298 - re-analyze set_formats_from_button comment

Parameters

array

$formats

array of PORTFOLIO_FORMAT_XX

Return values

void

supported_formats()

portfolio_caller_base::supported_formats ( )

finalinherited

Array of formats this caller supports.

Return values

array

list of formats

Member Data Documentation

$cm

object portfolio_module_caller_base::$cm

protectedinherited

coursemodule object.

set this in the constructor like $this->cm = get_coursemodule_from_instance('forum', $this->forum->id);

$exportconfig

array portfolio_caller_base::$exportconfig = array()

protectedinherited

configuration used for export.

Use set_export_config and get_export_config to access

---

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

• mod/glossary/locallib.php