Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
Files | Namespaces | Classes | Functions | Variables
block_myoverview

Files

file  access.php
 Capabilities for the My overview block.
 
file  block_myoverview.php
 Contains the class for the My overview block.
 
file  lib.php
 Library functions for overview.
 
file  main.php
 Class containing data for my overview block.
 
file  provider.php
 Privacy Subsystem implementation for block_myoverview.
 
file  renderer.php
 myoverview block rendrer
 
file  settings.php
 Settings for the myoverview block.
 
file  upgrade.php
 This file keeps track of upgrades to the myoverview block.
 
file  version.php
 Version details for the My overview block.
 

Namespaces

namespace  block_myoverview\output
  
 
namespace  block_myoverview\privacy
  
 

Classes

class  block_myoverview
 My overview block class. More...
 
class  block_myoverview\output\main
 Class containing data for my overview block. More...
 
class  block_myoverview\output\renderer
 myoverview block renderer More...
 
class  block_myoverview\privacy\provider
 Privacy Subsystem for block_myoverview. More...
 

Functions

 block_myoverview_pre_course_delete (\stdClass $course)
 Pre-delete course hook to cleanup any records with references to the deleted course. More...
 
 block_myoverview_user_preferences ()
 Get the current user preferences that are available. More...
 
 xmldb_block_myoverview_upgrade ($oldversion)
 Upgrade code for the MyOverview block. More...
 

Variables

 $capabilities
 
 $plugin = 2020060900
 
const BLOCK_MYOVERVIEW_CUSTOMFIELD_EMPTY -1
 Allows selection of all courses without a value for the custom field.
 
const BLOCK_MYOVERVIEW_DISPLAY_CATEGORIES_OFF 'off'
 
const BLOCK_MYOVERVIEW_DISPLAY_CATEGORIES_ON 'on'
 Constants for the admin category display setting.
 
const BLOCK_MYOVERVIEW_GROUPING_ALL 'all'
 
const BLOCK_MYOVERVIEW_GROUPING_ALLINCLUDINGHIDDEN 'allincludinghidden'
 Constants for the user preferences grouping options.
 
const BLOCK_MYOVERVIEW_GROUPING_CUSTOMFIELD 'customfield'
 
const BLOCK_MYOVERVIEW_GROUPING_FAVOURITES 'favourites'
 
const BLOCK_MYOVERVIEW_GROUPING_FUTURE 'future'
 
const BLOCK_MYOVERVIEW_GROUPING_HIDDEN 'hidden'
 
const BLOCK_MYOVERVIEW_GROUPING_INPROGRESS 'inprogress'
 
const BLOCK_MYOVERVIEW_GROUPING_PAST 'past'
 
const BLOCK_MYOVERVIEW_PAGING_12 12
 Constants for the user paging preferences.
 
const BLOCK_MYOVERVIEW_PAGING_24 24
 
const BLOCK_MYOVERVIEW_PAGING_48 48
 
const BLOCK_MYOVERVIEW_PAGING_96 96
 
const BLOCK_MYOVERVIEW_PAGING_ALL 0
 
const BLOCK_MYOVERVIEW_SORTING_LASTACCESSED 'lastaccessed'
 
const BLOCK_MYOVERVIEW_SORTING_SHORTNAME 'shortname'
 
const BLOCK_MYOVERVIEW_SORTING_TITLE 'title'
 Constants for the user preferences sorting options timeline.
 
const BLOCK_MYOVERVIEW_VIEW_CARD 'card'
 Constants for the user preferences view options.
 
const BLOCK_MYOVERVIEW_VIEW_LIST 'list'
 
const BLOCK_MYOVERVIEW_VIEW_SUMMARY 'summary'
 
$plugin component = 'block_myoverview'
 
$plugin version = 2020061500
 

Detailed Description

Function Documentation

◆ block_myoverview_pre_course_delete()

block_myoverview_pre_course_delete ( \stdClass  $course)

Pre-delete course hook to cleanup any records with references to the deleted course.

Parameters
stdClass$courseThe deleted course

◆ block_myoverview_user_preferences()

block_myoverview_user_preferences ( )

Get the current user preferences that are available.

Return values
mixedArray representing current options along with defaults

◆ xmldb_block_myoverview_upgrade()

xmldb_block_myoverview_upgrade (   $oldversion)

Upgrade code for the MyOverview block.

Parameters
int$oldversion

Variable Documentation

◆ $capabilities

$capabilities
Initial value:
= array(
'block/myoverview:myaddinstance' => array(
'captype' => 'write',
'contextlevel' => CONTEXT_SYSTEM,
'archetypes' => array(
'user' => CAP_ALLOW
),
'clonepermissionsfrom' => 'moodle/my:manageblocks'
)
)
const CONTEXT_SYSTEM
System context level - only one instance in every system.
Definition: accesslib.php:122
const CAP_ALLOW
Allow permission, overrides CAP_PREVENT defined in parent contexts.
Definition: accesslib.php:115