Moodle APIs  3.8
Moodle 3.8.6 (Build: 20201109)
Files | Namespaces | Classes | Functions | Variables
theme_boost

Files

file  admin_settingspage_tabs.php
 
file  autoprefixer.php
 Autoprefixer.
 
file  columns1.php
 A one column layout for the boost theme.
 
file  columns2.php
 A two column layout for the boost theme.
 
file  config.php
 Boost config.
 
file  core_renderer.php
 Renderers to align Moodle's HTML with that expected by Bootstrap.
 
file  embedded.php
 An embedded layout for the boost theme.
 
file  lib.php
 Theme functions.
 
file  login.php
 A login page layout for the boost theme.
 
file  maintenance.php
 A maintenance layout for the boost theme.
 
file  provider.php
 Privacy Subsystem implementation for theme_boost.
 
file  secure.php
 A secure layout for the boost theme.
 
file  settings.php
 
file  version.php
 Boost.
 

Namespaces

 theme_boost
  
 
 theme_boost\output
  
 
 theme_boost\privacy
  
 

Classes

class  theme_boost\autoprefixer
 Autoprefixer class. More...
 
class  theme_boost\output\core_renderer
 
class  theme_boost\privacy\provider
 The boost theme stores a user preference data. More...
 
class  theme_boost_admin_settingspage_tabs
 

Functions

 theme_boost_css_tree_post_processor ($tree, $theme)
 Post process the CSS tree. More...
 
 theme_boost_get_extra_scss ($theme)
 Inject additional SCSS. More...
 
 theme_boost_get_main_scss_content ($theme)
 Returns the main SCSS content. More...
 
 theme_boost_get_pre_scss ($theme)
 Get SCSS to prepend. More...
 
 theme_boost_get_precompiled_css ()
 Get compiled css. More...
 
 theme_boost_pluginfile ($course, $cm, $context, $filearea, $args, $forcedownload, array $options=array())
 Serves any files associated with the theme settings. More...
 

Variables

 $blockshtml = $OUTPUT->blocks('side-pre')
 
 $blockshtml = $OUTPUT->blocks('side-pre')
 
 $bodyattributes = $OUTPUT->body_attributes([])
 
if($navdraweropen) $bodyattributes = $OUTPUT->body_attributes($extraclasses)
 
 $bodyattributes = $OUTPUT->body_attributes()
 
 $bodyattributes = $OUTPUT->body_attributes()
 
 $buildregionmainsettings = !$PAGE->include_region_main_settings_in_header_actions()
 
 $extraclasses = []
 
 $hasblocks = strpos($blockshtml, 'data-block=') !== false
 
 $hasblocks = strpos($blockshtml, 'data-block=') !== false
 
 $nav = $PAGE->flatnav
 
 $regionmainsettingsmenu = $buildregionmainsettings ? $OUTPUT->region_main_settings_menu() : false
 
 $templatecontext
 
 $templatecontext
 
 $templatecontext ['firstcollectionlabel'] = $nav->get_collectionlabel()
 
 $templatecontext ['flatnavigation'] = $nav
 
 $templatecontext
 
 $templatecontext
 
 $templatecontext
 
 $templatecontext
 
$THEME addblockposition = BLOCK_ADDBLOCK_POSITION_FLATNAV
 
$plugin component = 'theme_boost'
 
$THEME csstreepostprocessor = 'theme_boost_css_tree_post_processor'
 
$THEME editor_scss = ['editor']
 
$THEME editor_sheets = []
 
if(isloggedin()) else
 
$THEME enable_dock = false
 
$THEME extrascsscallback = 'theme_boost_get_extra_scss'
 
$THEME iconsystem = core\output\icon_system::FONTAWESOME
 
$THEME layouts
 
$THEME name = 'boost'
 
$THEME parents = []
 
$THEME precompiledcsscallback = 'theme_boost_get_precompiled_css'
 
$THEME prescsscallback = 'theme_boost_get_pre_scss'
 
$THEME rendererfactory = 'theme_overridden_renderer_factory'
 
$THEME requiredblocks = ''
 
$plugin requires = 2019111200
 
$THEME scss
 
$THEME sheets = []
 
$THEME usefallback = true
 
$plugin version = 2019111800
 
$THEME yuicssmodules = array()
 

Detailed Description

Function Documentation

◆ theme_boost_css_tree_post_processor()

theme_boost_css_tree_post_processor (   $tree,
  $theme 
)

Post process the CSS tree.

Parameters
string$treeThe CSS tree.
theme_config$themeThe theme config object.

◆ theme_boost_get_extra_scss()

theme_boost_get_extra_scss (   $theme)

Inject additional SCSS.

Parameters
theme_config$themeThe theme config object.
Return values
string

◆ theme_boost_get_main_scss_content()

theme_boost_get_main_scss_content (   $theme)

Returns the main SCSS content.

Parameters
theme_config$themeThe theme config object.
Return values
string

◆ theme_boost_get_pre_scss()

theme_boost_get_pre_scss (   $theme)

Get SCSS to prepend.

Parameters
theme_config$themeThe theme config object.
Return values
array

◆ theme_boost_get_precompiled_css()

theme_boost_get_precompiled_css ( )

Get compiled css.

Return values
stringcompiled css

◆ theme_boost_pluginfile()

theme_boost_pluginfile (   $course,
  $cm,
  $context,
  $filearea,
  $args,
  $forcedownload,
array  $options = array() 
)

Serves any files associated with the theme settings.

Parameters
stdClass$course
stdClass$cm
context$context
string$filearea
array$args
bool$forcedownload
array$options
Return values
bool

Variable Documentation

◆ $templatecontext [1/6]

$templatecontext
Initial value:
= [
'sitename' => format_string($SITE->shortname, true, ['context' => context_course::instance(SITEID), "escape" => false]),
'output' => $OUTPUT,
'bodyattributes' => $bodyattributes
]

◆ $templatecontext [2/6]

$templatecontext
Initial value:
= [
'sitename' => format_string($SITE->shortname, true, ['context' => context_course::instance(SITEID), "escape" => false]),
'output' => $OUTPUT,
'sidepreblocks' => $blockshtml,
'hasblocks' => $hasblocks,
'bodyattributes' => $bodyattributes,
'navdraweropen' => $navdraweropen,
'regionmainsettingsmenu' => $regionmainsettingsmenu,
'hasregionmainsettingsmenu' => !empty($regionmainsettingsmenu)
]

◆ $templatecontext [3/6]

$templatecontext
Initial value:
= [
'sitename' => format_string($SITE->shortname, true, ['context' => context_course::instance(SITEID), "escape" => false]),
'output' => $OUTPUT
]

◆ $templatecontext [4/6]

$templatecontext
Initial value:
= [
'sitename' => format_string($SITE->shortname, true, ['context' => context_course::instance(SITEID), "escape" => false]),
'output' => $OUTPUT,
'bodyattributes' => $bodyattributes
]

◆ $templatecontext [5/6]

$templatecontext
Initial value:
= [
'sitename' => format_string($SITE->shortname, true, ["escape" => false]),
'output' => $OUTPUT
]

◆ $templatecontext [6/6]

$templatecontext
Initial value:
= [
'sitename' => format_string($SITE->shortname, true, ['context' => context_course::instance(SITEID), "escape" => false]),
'output' => $OUTPUT,
'bodyattributes' => $bodyattributes,
'sidepreblocks' => $blockshtml,
'hasblocks' => $hasblocks
]

◆ else

if (isloggedin()) else
Initial value:
{
$navdraweropen = false

◆ scss

$THEME scss
Initial value:
= function($theme) {
}
theme_boost_get_main_scss_content
theme_boost_get_main_scss_content($theme)
Returns the main SCSS content.
Definition: lib.php:90
format_string
format_string($string, $striplinks=true, $options=null)
Given a simple string, this function returns the string processed by enabled string filters if $CFG->...
Definition: weblib.php:1430
context_course\instance
static instance($courseid, $strictness=MUST_EXIST)
Returns course context instance.
Definition: accesslib.php:6944