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

Public Member Functions

 __construct ($actionurl, $block, $page)
 definition ()
 set_data ($defaults)

Data Fields

 $block
 $page

Protected Member Functions

 specific_definition ($mform)

Detailed Description

The base class form used by blocks/edit.php to edit block instance configuration.

Definition at line 43 of file edit_form.php.


Constructor & Destructor Documentation

__construct ( actionurl,
block,
page 
)

Definition at line 55 of file edit_form.php.

Here is the call graph for this function:


Member Function Documentation

Abstract method - always override!

Reimplemented from moodleform.

Definition at line 62 of file edit_form.php.

Here is the call graph for this function:

set_data ( default_values)

Load in existing data as form defaults. Usually new entry defaults are stored directly in form definition (new entry form); this function is used to load in data where values already exist and data is being edited (edit entry form).

note: $slashed param removed

Parameters:
mixed$default_valuesobject or array of default values

Reimplemented from moodleform.

Reimplemented in block_html_edit_form.

Definition at line 245 of file edit_form.php.

Here is the call graph for this function:

specific_definition ( mform) [protected]

Override this to create any form fields specific to this type of block.

Parameters:
object$mformthe form being built.

Reimplemented in block_navigation_edit_form, block_quiz_results_edit_form, block_settings_edit_form, block_blog_recent_edit_form, block_blog_tags_edit_form, block_glossary_random_edit_form, block_html_edit_form, block_mentees_edit_form, block_rss_client_edit_form, block_tag_flickr_edit_form, block_tag_youtube_edit_form, block_tags_edit_form, and block_myprofile_edit_form.

Definition at line 281 of file edit_form.php.

Here is the caller graph for this function:


Field Documentation

$block

Definition at line 48 of file edit_form.php.

$page

Definition at line 53 of file edit_form.php.


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