Moodle APIs 4.3
Moodle 4.3.6 (Build: 20240812)
core_portfolio

Topics

 portfolio
 
 

Namespaces

namespace  core_portfolio\privacy
 This file contains the polyfill to allow a plugin to operate with Moodle 3.3 up.
 

Classes

interface  core_portfolio\privacy\portfolio_provider
 Provider for the portfolio API. More...
 
class  core_portfolio\privacy\provider
 Provider for the portfolio API. More...
 

Variables

const PORTFOLIO_ADD_FAKE_URL 5
 PORTFOLIO_ADD_FAKE_URL - hacky way to turn the button class into a url to redirect to this replaces the old portfolio_fake_add_url function.
 
const PORTFOLIO_ADD_FULL_FORM 1
 PORTFOLIO_ADD_FULL_FORM - a whole form, containing a drop down menu (where necessary) and a submit button.
 
const PORTFOLIO_ADD_ICON_FORM 2
 PORTFOLIO_ADD_ICON_FORM - a whole form, containing a drop down menu (where necessary) but has an icon instead of a button to submit.
 
const PORTFOLIO_ADD_ICON_LINK 3
 PORTFOLIO_ADD_ICON_LINK - just an icon with a link around it (yuk, as will result in a long url only use where necessary)
 
const PORTFOLIO_ADD_MOODLE_URL 6
 PORTFOLIO_ADD_MOODULE_URL - hacky way to turn the button class into a moodle_url to redirect to this replaces the old portfolio_fake_add_url function.
 
const PORTFOLIO_ADD_TEXT_LINK 4
 PORTFOLIO_ADD_TEXT_LINK - just some text with a link around it (yuk, as will result in a long url only use where necessary)
 
const PORTFOLIO_FORMAT_DOCUMENT 'document'
 PORTFOLIO_FORMAT_DOCUMENT - subtype of file.
 
const PORTFOLIO_FORMAT_FILE 'file'
 PORTFOLIO_FORMAT_FILE - the most basic fallback format.
 
const PORTFOLIO_FORMAT_IMAGE 'image'
 PORTFOLIO_FORMAT_IMAGE - subtype of file.
 
const PORTFOLIO_FORMAT_LEAP2A 'leap2a'
 PORTFOLIO_FORMAT_LEAP2A - supported by mahara and and others {http://wiki.cetis.ac.uk/LEAP_2.0}.
 
const PORTFOLIO_FORMAT_MBKP 'mbkp'
 PORTFOLIO_FORMAT_MBKP - the plugin needs to be able to write a complete backup the caller need to be able to export the particular XML bits to insert into moodle.xml (?and the file bits if necessary)
 
const PORTFOLIO_FORMAT_PDF 'pdf'
 PORTFOLIO_FORMAT_PDF - subtype of file.
 
const PORTFOLIO_FORMAT_PLAINHTML 'plainhtml'
 PORTFOLIO_FORMAT_PLAINHTML - a single html representation - no attachments.
 
const PORTFOLIO_FORMAT_PRESENTATION 'presentation'
 PORTFOLIO_FORMAT_PRESENTATION - subtype of file.
 
const PORTFOLIO_FORMAT_RICH 'rich'
 PORTFOLIO_FORMAT_RICH - just used to say, "we support all these".
 
const PORTFOLIO_FORMAT_RICHHTML 'richhtml'
 PORTFOLIO_FORMAT_RICHHTML - like html but with attachments.
 
const PORTFOLIO_FORMAT_SPREADSHEET 'spreadsheet'
 PORTFOLIO_FORMAT_SPREADSHEET - subtype of file.
 
const PORTFOLIO_FORMAT_TEXT 'text'
 PORTFOLIO_FORMAT_TEXT - subtype of file.
 
const PORTFOLIO_FORMAT_VIDEO 'video'
 PORTFOLIO_FORMAT_VIDEO - subtype of file.
 
const PORTFOLIO_STAGE_CLEANUP 6
 PORTFOLIO_STAGE_CLEANUP - cleanup the temporary area.
 
const PORTFOLIO_STAGE_CONFIG 1
 PORTFOLIO_STAGE_CONFIG - display a form to the user this one might not be used if neither the plugin, or the caller has any config.
 
const PORTFOLIO_STAGE_CONFIRM 2
 PORTFOLIO_STAGE_CONFIRM - summarise the form and ask for confirmation if we skipped PORTFOLIO_STAGE_CONFIG, just confirm the send.
 
const PORTFOLIO_STAGE_FINISHED 7
 PORTFOLIO_STAGE_FINISHED - display the "finished notification".
 
const PORTFOLIO_STAGE_PACKAGE 4
 PORTFOLIO_STAGE_PACKAGE - package up the various bits during this stage both the caller and the plugin get their package methods called.
 
const PORTFOLIO_STAGE_QUEUEORWAIT 3
 PORTFOLIO_STAGE_QUEUEORWAIT - either queue the event and skip to PORTFOLIO_STAGE_FINISHED.
 
const PORTFOLIO_STAGE_SEND 5
 PORTFOLIO_STAGE_SEND - the portfolio plugin must send the file.
 
const PORTFOLIO_TIME_FORCEQUEUE 'queue'
 PORTFOLIO_TIME_FORCEQUEUE - very slow, or immediate transfers not supported.
 
const PORTFOLIO_TIME_HIGH 'high'
 PORTFOLIO_TIME_HIGH - slow.
 
const PORTFOLIO_TIME_LOW 'low'
 PORTFOLIO_TIME_LOW - no delay.
 
const PORTFOLIO_TIME_MODERATE 'moderate'
 PORTFOLIO_TIME_MODERATE - a small delay.
 

Detailed Description

Variable Documentation

◆ PORTFOLIO_FORMAT_FILE

const PORTFOLIO_FORMAT_FILE 'file'

PORTFOLIO_FORMAT_FILE - the most basic fallback format.

this should always be supported in remote system.s

◆ PORTFOLIO_TIME_HIGH

const PORTFOLIO_TIME_HIGH 'high'

PORTFOLIO_TIME_HIGH - slow.

the user really should not be given the option to choose this.

◆ PORTFOLIO_TIME_LOW

const PORTFOLIO_TIME_LOW 'low'

PORTFOLIO_TIME_LOW - no delay.

don't even offer the user the option of not waiting for the transfer

◆ PORTFOLIO_TIME_MODERATE

const PORTFOLIO_TIME_MODERATE 'moderate'

PORTFOLIO_TIME_MODERATE - a small delay.

user can still easily opt to watch this transfer and wait.