Moodle PHP Documentation 4.4
Moodle 4.4.1 (Build: 20240610) (db07c09afc5)
|
class to export a single glossary entry More...
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 | entry_content ($course, $cm, $glossary, $entry, $aliases, $format) |
helper function to get the html content of an entry for both this class and the full glossary exporter this is a very simplified version of the dictionary format output, but with its 500 levels of indirection removed and file rewriting handled by the portfolio export format. | |
static | expected_callbackargs () |
Array of arguments the caller expects to be passed through to it. | |
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 | |
$entryid | |
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 | |
class to export a single glossary entry
|
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.
string | $format | one of PORTFOLIO_FORMAT_XX |
void |
|
static |
what formats this function generally supports
array |
Reimplemented from portfolio_caller_base.
glossary_entry_portfolio_caller::check_permissions | ( | ) |
make sure that the current user is allowed to do this
boolean |
Reimplemented from portfolio_caller_base.
|
static |
return a nice name to be displayed about this export location
string |
Reimplemented from portfolio_caller_base.
|
static |
helper function to get the html content of an entry for both this class and the full glossary exporter this is a very simplified version of the dictionary format output, but with its 500 levels of indirection removed and file rewriting handled by the portfolio export format.
stdclass | $course | |
stdclass | $cm | |
stdclass | $glossary | |
stdclass | $entry |
string |
|
static |
Array of arguments the caller expects to be passed through to it.
This must be keyed on the argument name, and the array value is a boolean, whether it is required, or just optional eg array( id => true, somethingelse => false )
Reimplemented from portfolio_caller_base.
glossary_entry_portfolio_caller::expected_time | ( | ) |
how long might we expect this export to take
constant | one of PORTFOLIO_TIME_XX |
Reimplemented from portfolio_caller_base.
|
inherited |
Helper method to calculate expected time for multi or single file exports.
string | file time expectation |
|
inherited |
If this caller wants any additional config items, they should be defined here.
moodleform | $mform | passed by reference, add elements to it. |
portfolio_plugin_base | $instance | subclass of portfolio_plugin_base |
Reimplemented in data_portfolio_caller.
|
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.
array | $data | data from form. |
|
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.
string | $key | the name of get function |
stdClass |
Reimplemented from portfolio_caller_base.
|
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.
array | array of allowed keys |
Reimplemented in data_portfolio_caller.
|
finalinherited |
Returns a particular export config value.
Subclasses shouldn't need to override this
string | $key | the config item to fetch |
null|mixed | of export configuration |
|
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.
bool |
|
inherited |
Gets mimetype.
string |
|
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.
array |
Reimplemented from portfolio_caller_base.
Reimplemented in forum_portfolio_caller, and mod_workshop_portfolio_caller.
|
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.
string |
Reimplemented from portfolio_caller_base.
Reimplemented in chat_portfolio_caller, forum_portfolio_caller, and mod_workshop_portfolio_caller.
glossary_entry_portfolio_caller::get_sha1 | ( | ) |
|
inherited |
Helper function to calculate the sha1 for multi or single file exports.
string | sha1 file exports |
|
inherited |
Whether this caller wants any additional config during export (eg options or metadata)
bool |
Reimplemented in data_portfolio_caller.
|
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
string |
Reimplemented from portfolio_caller_base.
glossary_entry_portfolio_caller::load_data | ( | ) |
load up all data required for this export.
void |
Reimplemented from portfolio_caller_base.
glossary_entry_portfolio_caller::prepare_package | ( | ) |
prepare the package ready to be passed off to the portfolio plugin
void |
Reimplemented from portfolio_caller_base.
|
inherited |
Helper function to copy files into the temp area for single or multi file exports.
stored_file|bool |
|
finalinherited |
Generic setter for properties belonging to this instance outside the subclass like name, visible, etc.
string | $field | property's name |
mixed | $value | property's value |
bool |
moodle_exception |
|
inherited |
Overridden to return the course module context.
moodle_page | $PAGE | global PAGE |
Reimplemented from portfolio_caller_base.
|
finalinherited |
Stores the config generated at export time.
Subclasses can retrieve values using
array | $config | formdata |
|
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
mixed | $ids | one of:
|
void |
|
inherited |
|
finalinherited |
Array of formats this caller supports.
array | list of formats |
|
protectedinherited |
coursemodule object.
set this in the constructor like $this->cm = get_coursemodule_from_instance('forum', $this->forum->id);
|
protectedinherited |
configuration used for export.
Use set_export_config and get_export_config to access