Moodle APIs 4.1
Moodle 4.1.9+ (Build: 20240402)
Directories | Files | Namespaces | Classes | Variables
core_block

Directories

directory navigation
  
 

Files

file  behat_blocks.php
 Steps definitions related with blocks.
 
file  edit_form.php
 Defines the base class form used by blocks/edit.php to edit block instance configuration.
 
file  external.php
 Blocks external API.
 
file  fetch_addable_blocks.php
 This is the external method used for fetching the addable blocks in a given page.
 
file  moodleblock.class.php
 This file contains the parent class for moodle blocks, block_base.
 
file  provider.php
 Data provider.
 
file  secondary.php
 Class secondary.
 

Namespaces

namespace  core_block\external
  
 
namespace  core_block\navigation\views
  
 
namespace  core_block\privacy
  
 

Classes

class  behat_blocks
 
class  block_base
 Class for describing a moodle block, all Moodle blocks derive from this class. More...
 
class  block_edit_form
 The base class form used by blocks/edit.php to edit block instance configuration. More...
 
class  block_list
 Specialized class for displaying a block with a list of icons/text labels. More...
 
class  block_tree
 Specialized class for displaying a tree menu. More...
 
class  core_block\external\fetch_addable_blocks
 This is the external method used for fetching the addable blocks in a given page. More...
 
class  core_block\navigation\views\secondary
 
class  core_block\privacy\provider
 Data provider class. More...
 
class  core_block_external
 

Variables

global core_block\external::$CFG
 
const BLOCK_TYPE_LIST 1
 Constants.
 
const BLOCK_TYPE_TEXT 2
 Block type of text.
 
const BLOCK_TYPE_TREE 3
 Block type of tree.
 
 if (!defined( 'MOODLE_INTERNAL'))
 

Detailed Description

Variable Documentation

◆ BLOCK_TYPE_LIST

const BLOCK_TYPE_LIST 1

Constants.

Block type of list. Contents of block should be set as an associative array in the content object as items ($this->content->items). Optionally include footer text in $this->content->footer.

◆ BLOCK_TYPE_TEXT

const BLOCK_TYPE_TEXT 2

Block type of text.

Contents of block should be set to standard html text in the content object as items ($this->content->text). Optionally include footer text in $this->content->footer.

◆ BLOCK_TYPE_TREE

const BLOCK_TYPE_TREE 3

Block type of tree.

$this->content->items is a list of tree_item objects and $this->content->footer is a string.