 |
Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
|
|
Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
|
Class for describing a moodle block, all Moodle blocks derive from this class. More...
Public Member Functions | |
| __construct () | |
| Class Functions. | |
| _load_instance ($instance, $page) | |
| Set up a particular instance of this class given data from the block_insances table and the current page. | |
| _self_test () | |
| Tests if this block has been implemented correctly. | |
| applicable_formats () | |
| Which page types this block may appear on. | |
| before_delete () | |
| Function that can be overridden to do extra cleanup before the database tables are deleted. | |
| can_block_be_added (moodle_page $page) | |
| This method can be overriden to add some extra checks to decide whether the block can be added or not to a page. | |
| config_save ($data) | |
| Default behavior: save all variables as $CFG properties You don't need to override this if you 're satisfied with the above. | |
| get_aria_role () | |
| Returns the aria role attribute that best describes this block. | |
| get_config_for_external () | |
| Return the plugin config settings for external functions. | |
| get_content () | |
| Parent class version of this function simply returns NULL This should be implemented by the derived class to return the content object. | |
| get_content_for_external ($output) | |
| Return an object containing all the block content to be returned by external functions. | |
| get_content_for_output ($output) | |
| Return a block_contents object representing the full contents of this block. | |
| get_content_type () | |
| Returns the class $content_type var value. | |
| get_required_javascript () | |
| Allows the block to load any JS it requires into the page. | |
| get_title () | |
| Returns the class $title var value. | |
| has_config () | |
| Subclasses should override this and return true if the subclass block has a settings.php file. | |
| hide_header () | |
| Default return is false - header will be shown. | |
| html_attributes () | |
| Return any HTML attributes that you want added to the outer. | |
| instance_allow_config () | |
| Is each block of this type going to have instance-specific configuration? Normally, this setting is controlled by instance_allow_multiple(): if multiple instances are allowed, then each will surely need its own configuration. | |
| instance_allow_multiple () | |
| Are you going to allow multiple instances of each block? If yes, then it is assumed that the block WILL USE per-instance configuration. | |
| instance_can_be_collapsed () | |
| If overridden and set to false by the block it will not be collapsible. | |
| instance_can_be_docked () | |
| Can be overridden by the block to prevent the block from being dockable. | |
| instance_can_be_edited () | |
| If overridden and set to false by the block it will not be editable. | |
| instance_can_be_hidden () | |
| If overridden and set to false by the block it will not be hidable when editing is turned on. | |
| instance_config_commit ($nolongerused=false) | |
| Replace the instance's configuration data with those currently in $this->config;. | |
| instance_config_save ($data, $nolongerused=false) | |
| Serialize and store config data. | |
| instance_copy ($fromid) | |
| Copy any block-specific data when copying to a new block instance. | |
| instance_create () | |
| Do any additional initialization you may need at the time a new block instance is created. | |
| instance_delete () | |
| Delete everything related to this instance if you have been using persistent storage other than the configdata field. | |
| is_empty () | |
| Returns true or false, depending on whether this block has any content to display and whether the user has permission to view the block. | |
| name () | |
| Returns the block name, as present in the class name, the database, the block directory, etc etc. | |
| refresh_content () | |
| First sets the current value of $this->content to NULL then calls the block's get_content() function to set its value back. | |
| specialization () | |
| This function is called on your subclass right after an instance is loaded Use this function to act on instance data just after it's loaded and before anything else is done For instance: if your block will have different title's depending on location (site, course, blog, etc) | |
| user_can_addto ($page) | |
| Allows the block class to have a say in the user's ability to create new instances of this block. | |
| user_can_edit () | |
| Allows the block class to have a say in the user's ability to edit (i.e., configure) blocks of this type. | |
Public Attributes | |
| string | $arialabel = NULL |
| The name of the block to be displayed in the block title area if the title is empty. | |
| stdClass | $config = NULL |
| An object containing the instance configuration information for the current instance of this block. | |
| stdClass | $content = NULL |
| An object to contain the information to be displayed in the block. | |
| int | $content_type = BLOCK_TYPE_TEXT |
| The type of content that this block creates. | |
| context | $context = NULL |
| This blocks's context. | |
| int | $cron = NULL |
| How often the cronjob should run, 0 if not at all. | |
| stdClass | $instance = NULL |
| The initialized instance of this block object. | |
| moodle_page | $page = NULL |
| The page that this block is appearing on. | |
| string | $str |
| Internal var for storing/caching translated strings $str. | |
| string | $title = NULL |
| The title of the block to be displayed in the block title area. | |
Protected Member Functions | |
| formatted_contents ($output) | |
| Convert the contents of the block to HTML. | |
Class for describing a moodle block, all Moodle blocks derive from this class.
| block_base::__construct | ( | ) |
Class Functions.
Fake constructor to keep PHP5 happy
| block_base::_load_instance | ( | $instance, | |
| $page ) |
Set up a particular instance of this class given data from the block_insances table and the current page.
(See block_manager::load_blocks().)
| stdClass | $instance | data from block_insances, block_positions, etc. |
| moodle_page | $page | the page this block is on. |
| block_base::_self_test | ( | ) |
Tests if this block has been implemented correctly.
Also, $errors isn't used right now
| boolean |
| block_base::applicable_formats | ( | ) |
Which page types this block may appear on.
The information returned here is processed by the blocks_name_allowed_in_format() function. Look there if you need to know exactly how this works.
Default case: everything except mod and tag.
| array | page-type prefix => true/false. |
Reimplemented in block_accessreview, block_activity_modules, block_activity_results, block_admin_bookmarks, block_badges, block_blog_menu, block_blog_recent, block_blog_tags, block_comments, block_completionstatus, block_course_summary, block_feedback, block_html, block_login, block_lp, block_mentees, block_mnet_hosts, block_myoverview, block_myprofile, block_navigation, block_private_files, block_recent_activity, block_recentlyaccessedcourses, block_recentlyaccesseditems, block_rss_client, block_search_forums, block_section_links, block_selfcompletion, block_settings, block_site_main_menu, block_social_activities, block_starredcourses, block_tag_flickr, block_tag_youtube, block_tags, and block_timeline.
| block_base::before_delete | ( | ) |
Function that can be overridden to do extra cleanup before the database tables are deleted.
(Called once per block, not per instance!)
Reimplemented in block_myprofile.
| block_base::can_block_be_added | ( | moodle_page | $page | ) |
This method can be overriden to add some extra checks to decide whether the block can be added or not to a page.
It doesn't need to do the standard capability checks as they will be performed by has_add_block_capability(). This method is user agnostic. If you want to check if a user can add a block or not, you should use user_can_addto().
| moodle_page | $page | The page where this block will be added. |
| bool | Whether the block can be added or not to the given page. |
Reimplemented in block_accessreview, block_badges, block_blog_menu, block_blog_recent, block_blog_tags, block_comments, block_completionstatus, block_globalsearch, block_glossary_random, block_lp, block_mnet_hosts, and block_tags.
| block_base::config_save | ( | $data | ) |
Default behavior: save all variables as $CFG properties You don't need to override this if you 're satisfied with the above.
|
protected |
Convert the contents of the block to HTML.
This is used by block base classes like block_list to convert the structured $this->content->list and $this->content->icons arrays to HTML. So, in most blocks, you probaby want to override the get_contents() method, which generates that structured representation of the contents.
| $output | The core_renderer to use when generating the output. |
| string | the HTML that should appearn in the body of the block. |
Reimplemented in block_list, and block_tree.
| block_base::get_aria_role | ( | ) |
Returns the aria role attribute that best describes this block.
Region is the default, but this should be overridden by a block is there is a region child, or even better a landmark child.
Options are as follows:
| string |
Reimplemented in block_activity_modules, block_admin_bookmarks, block_blog_menu, block_course_list, block_navigation, block_search_forums, and block_settings.
| block_base::get_config_for_external | ( | ) |
Return the plugin config settings for external functions.
In some cases the configs will need formatting or be returned only if the current user has some capabilities enabled.
| stdClass | the configs for both the block instance and plugin (as object with name -> value) |
Reimplemented in block_activity_results, block_blog_recent, block_blog_tags, block_course_list, block_glossary_random, block_html, block_mentees, block_myoverview, block_myprofile, block_navigation, block_online_users, block_recentlyaccessedcourses, block_rss_client, block_section_links, block_settings, block_starredcourses, block_tag_flickr, block_tag_youtube, and block_tags.
| block_base::get_content | ( | ) |
Parent class version of this function simply returns NULL This should be implemented by the derived class to return the content object.
| stdObject |
Reimplemented in block_accessreview, block_activity_modules, block_activity_results, block_admin_bookmarks, block_badges, block_blog_menu, block_blog_recent, block_blog_tags, block_calendar_month, block_calendar_upcoming, block_comments, block_completionstatus, block_course_list, block_course_summary, block_feedback, block_globalsearch, block_glossary_random, block_html, block_login, block_lp, block_mentees, block_mnet_hosts, block_myoverview, block_myprofile, block_navigation, block_news_items, block_online_users, block_private_files, block_recent_activity, block_recentlyaccessedcourses, block_recentlyaccesseditems, block_rss_client, block_search_forums, block_section_links, block_selfcompletion, block_settings, block_site_main_menu, block_social_activities, block_starredcourses, block_tag_flickr, block_tag_youtube, block_tags, and block_timeline.
| block_base::get_content_for_external | ( | $output | ) |
Return an object containing all the block content to be returned by external functions.
If your block is returning formatted content or provide files for download, you should override this method to use the core_external\util\format_text, core_external\utilformat_string functions for formatting or external_util\get_area_files for files.
| core_renderer | $output | the rendered used for output |
| stdClass | object containing the block title, central content, footer and linked files (if any). |
Reimplemented in block_html.
| block_base::get_content_for_output | ( | $output | ) |
Return a block_contents object representing the full contents of this block.
This internally calls ->get_content(), and then adds the editing controls etc.
You probably should not override this method, but instead override html_attributes(), formatted_contents() or get_content(), hide_header(), (get_edit_controls), etc.
| block_contents | a representation of the block, for rendering. |
| block_base::get_content_type | ( | ) |
Returns the class $content_type var value.
Intentionally doesn't check if content_type is set. This is already done in _self_test()
| string\$this-,>content_type |
| block_base::get_required_javascript | ( | ) |
Allows the block to load any JS it requires into the page.
By default this function simply permits the user to dock the block if it is dockable.
Left null as of MDL-64506.
Reimplemented in block_navigation, and block_settings.
| block_base::get_title | ( | ) |
Returns the class $title var value.
Intentionally doesn't check if a title is set. This is already done in _self_test()
| string\$this-,>title |
| block_base::has_config | ( | ) |
Subclasses should override this and return true if the subclass block has a settings.php file.
| boolean |
Reimplemented in block_accessreview, block_activity_results, block_badges, block_blog_menu, block_blog_tags, block_course_list, block_html, block_mnet_hosts, block_myoverview, block_myprofile, block_online_users, block_recentlyaccessedcourses, block_rss_client, block_section_links, block_starredcourses, and block_tag_youtube.
| block_base::hide_header | ( | ) |
Default return is false - header will be shown.
| boolean |
Reimplemented in block_course_summary, and block_myoverview.
| block_base::html_attributes | ( | ) |
Return any HTML attributes that you want added to the outer.
function html_attributes() { $attributes = parent\html_attributes(); $attributes['class'] .= ' mynewclass'; return $attributes; } | array | attribute name => value. |
Reimplemented in block_html, block_list, and block_navigation.
| block_base::instance_allow_config | ( | ) |
Is each block of this type going to have instance-specific configuration? Normally, this setting is controlled by instance_allow_multiple(): if multiple instances are allowed, then each will surely need its own configuration.
However, in some cases it may be necessary to provide instance configuration to blocks that do not want to allow multiple instances. In that case, make this function return true. I stress again that this makes a difference ONLY if instance_allow_multiple() returns false.
| boolean |
Reimplemented in block_badges, block_blog_menu, block_blog_recent, block_blog_tags, block_myprofile, block_navigation, block_rss_client, block_section_links, block_settings, and block_tags.
| block_base::instance_allow_multiple | ( | ) |
Are you going to allow multiple instances of each block? If yes, then it is assumed that the block WILL USE per-instance configuration.
| boolean |
Reimplemented in block_accessreview, block_activity_results, block_admin_bookmarks, block_badges, block_blog_menu, block_blog_tags, block_comments, block_glossary_random, block_html, block_mentees, block_myprofile, block_navigation, block_private_files, block_rss_client, block_settings, block_tag_flickr, block_tag_youtube, and block_tags.
| block_base::instance_can_be_collapsed | ( | ) |
If overridden and set to false by the block it will not be collapsible.
| bool |
| block_base::instance_can_be_docked | ( | ) |
Can be overridden by the block to prevent the block from being dockable.
| bool |
Return false as per MDL-64506
Reimplemented in block_html, block_mentees, block_navigation, and block_settings.
| block_base::instance_can_be_edited | ( | ) |
If overridden and set to false by the block it will not be editable.
| bool |
Reimplemented in block_myoverview.
| block_base::instance_can_be_hidden | ( | ) |
If overridden and set to false by the block it will not be hidable when editing is turned on.
| bool |
Reimplemented in block_navigation, and block_settings.
| block_base::instance_config_commit | ( | $nolongerused = false | ) |
Replace the instance's configuration data with those currently in $this->config;.
Reimplemented in block_glossary_random.
| block_base::instance_config_save | ( | $data, | |
| $nolongerused = false ) |
Serialize and store config data.
Reimplemented in block_activity_results, and block_html.
| block_base::instance_copy | ( | $fromid | ) |
Copy any block-specific data when copying to a new block instance.
| int | $fromid | the id number of the block instance to copy from |
| boolean |
Reimplemented in block_html.
| block_base::instance_create | ( | ) |
Do any additional initialization you may need at the time a new block instance is created.
| boolean |
| block_base::instance_delete | ( | ) |
Delete everything related to this instance if you have been using persistent storage other than the configdata field.
| boolean |
Reimplemented in block_html.
| block_base::is_empty | ( | ) |
Returns true or false, depending on whether this block has any content to display and whether the user has permission to view the block.
| boolean |
Reimplemented in block_list.
| block_base::name | ( | ) |
Returns the block name, as present in the class name, the database, the block directory, etc etc.
| string |
| block_base::refresh_content | ( | ) |
First sets the current value of $this->content to NULL then calls the block's get_content() function to set its value back.
| stdObject |
| block_base::specialization | ( | ) |
This function is called on your subclass right after an instance is loaded Use this function to act on instance data just after it's loaded and before anything else is done For instance: if your block will have different title's depending on location (site, course, blog, etc)
Reimplemented in block_badges, block_blog_tags, block_comments, block_course_summary, block_glossary_random, block_html, block_mentees, block_myprofile, block_private_files, block_rss_client, block_tag_flickr, block_tag_youtube, and block_tags.
| block_base::user_can_addto | ( | $page | ) |
Allows the block class to have a say in the user's ability to create new instances of this block.
The framework has first say in whether this will be allowed (e.g., no adding allowed unless in edit mode) but if the framework does allow it, the block can still decide to refuse. This function has access to the complete page object, the creation related to which is being determined.
| moodle_page | $page |
| boolean |
| block_base::user_can_edit | ( | ) |
Allows the block class to have a say in the user's ability to edit (i.e., configure) blocks of this type.
The framework has first say in whether this will be allowed (e.g., no editing allowed unless in edit mode) but if the framework does allow it, the block can still decide to refuse.
| boolean |
| string block_base::$arialabel = NULL |
The name of the block to be displayed in the block title area if the title is empty.
arialabel
| stdClass block_base::$config = NULL |
An object containing the instance configuration information for the current instance of this block.
$config
| stdClass block_base::$content = NULL |
An object to contain the information to be displayed in the block.
$content
| int block_base::$content_type = BLOCK_TYPE_TEXT |
The type of content that this block creates.
Currently support options - BLOCK_TYPE_LIST, BLOCK_TYPE_TEXT $content_type
| int block_base::$cron = NULL |
How often the cronjob should run, 0 if not at all.
$cron
| stdClass block_base::$instance = NULL |
The initialized instance of this block object.
$instance
| string block_base::$title = NULL |
The title of the block to be displayed in the block title area.
$title
1.11.0