block_tags Class Reference

Inheritance diagram for block_tags:

Collaboration diagram for block_tags:

Public Member Functions
	init ()
	instance_allow_multiple ()
	has_config ()
	applicable_formats ()
	instance_allow_config ()
	specialization ()
	get_content ()

---

Detailed Description

Definition at line 3 of file block_tags.php.

---

Member Function Documentation

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.

Returns:

array page-type prefix => true/false.

Reimplemented from block_base.

Definition at line 20 of file block_tags.php.

get_content

(

)

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

Returns:

stdObject

Get a list of tags

Reimplemented from block_base.

Definition at line 38 of file block_tags.php.

Here is the call graph for this function:

has_config

(

)

Subclasses should override this and return true if the subclass block has a config_global.html file.

Returns:

boolean

Reimplemented from block_base.

Definition at line 16 of file block_tags.php.

init

(

)

Definition at line 4 of file block_tags.php.

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.

Returns:

boolean

Reimplemented from block_base.

Definition at line 24 of file block_tags.php.

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

Returns:

boolean

Reimplemented from block_base.

Definition at line 12 of file block_tags.php.

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

Definition at line 28 of file block_tags.php.

---

The documentation for this class was generated from the following file:

• C:/xampp/htdocs/moodle/blocks/tags/block_tags.php