Moodle  2.2.1
http://www.collinsharper.com
block_html Class Reference
Inheritance diagram for block_html:
Collaboration diagram for block_html:

Public Member Functions

 init ()
 applicable_formats ()
 specialization ()
 instance_allow_multiple ()
 get_content ()
 instance_config_save ($data, $nolongerused=false)
 instance_delete ()
 content_is_trusted ()
 instance_can_be_docked ()

Detailed Description

Definition at line 26 of file block_html.php.


Member Function Documentation

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.

Returns:
array page-type prefix => true/false.

Reimplemented from block_base.

Definition at line 32 of file block_html.php.

Definition at line 104 of file block_html.php.

Here is the call graph for this function:

Here is the caller graph for this function:

Parent class version of this function simply returns NULL This should be implemented by the derived class to return the content object.

Returns:
stdObject

Reimplemented from block_base.

Definition at line 44 of file block_html.php.

Here is the call graph for this function:

init ( )

Definition at line 28 of file block_html.php.

Are you going to allow multiple instances of each block? If yes, then it is assumed that the block WILL USE per-instance configuration

Returns:
boolean

Reimplemented from block_base.

Definition at line 40 of file block_html.php.

The block should only be dockable when the title of the block is not empty and when parent allows docking.

Returns:
bool

Reimplemented from block_base.

Definition at line 131 of file block_html.php.

instance_config_save ( data,
nolongerused = false 
)

Serialize and store config data

Reimplemented from block_base.

Definition at line 86 of file block_html.php.

Here is the call graph for this function:

Delete everything related to this instance if you have been using persistent storage other than the configdata field.

Returns:
boolean

Reimplemented from block_base.

Definition at line 97 of file block_html.php.

Here is the call graph for this function:

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 from block_base.

Definition at line 36 of file block_html.php.

Here is the call graph for this function:


The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Enumerations