PHP block_base類代碼示例

 /**
  * @param block_base $block a block that appears on this page.
  * @return boolean boolean whether the currently logged in user is allowed to delete this block.
  */
 protected function user_can_delete_block($block)
 {
     return $this->page->user_can_edit_blocks() && $block->user_can_edit() && $block->user_can_addto($this->page) && !in_array($block->instance->blockname, self::get_undeletable_block_types());
 }

 function instance_config_save($data, $nolongerused = false)
 {
     if (empty($data->quizid)) {
         $data->quizid = $this->get_owning_quiz();
     }
     parent::instance_config_save($data);
 }

 function get_required_javascript()
 {
     parent::get_required_javascript();
     $this->page->requires->jquery();
     $this->page->requires->jquery_plugin('ui');
     $this->page->requires->jquery_plugin('ui-css');
 }

 function after_install()
 {
     global $CFG;
     // initialize the global configuration
     $global_config = array("block_moodle_notifications_email_channel" => 1, "block_moodle_notifications_sms_channel" => 1, "block_moodle_notifications_rss_channel" => 1, "block_moodle_notifications_frequency" => 12, "block_moodle_notifications_email_notification_preset" => 1, "block_moodle_notifications_sms_notification_preset" => 1);
     return parent::config_save($global_config);
 }

 function instance_config_save($data)
 {
     if (empty($data->quizid)) {
         $data->quizid = $this->get_owning_quiz();
     }
     parent::instance_config_save($data);
 }

 function definition()
 {
     $mform =& $this->_form;
     // First show fields specific to this type of block.
     $this->specific_definition($mform);
     // Then show the fields about where this block appears.
     $mform->addElement('header', 'whereheader', get_string('wherethisblockappears', 'block'));
     // If the current weight of the block is out-of-range, add that option in.
     $blockweight = $this->block->instance->weight;
     $weightoptions = array();
     if ($blockweight < -block_manager::MAX_WEIGHT) {
         $weightoptions[$blockweight] = $blockweight;
     }
     for ($i = -block_manager::MAX_WEIGHT; $i <= block_manager::MAX_WEIGHT; $i++) {
         $weightoptions[$i] = $i;
     }
     if ($blockweight > block_manager::MAX_WEIGHT) {
         $weightoptions[$blockweight] = $blockweight;
     }
     $first = reset($weightoptions);
     $weightoptions[$first] = get_string('bracketfirst', 'block', $first);
     $last = end($weightoptions);
     $weightoptions[$last] = get_string('bracketlast', 'block', $last);
     $regionoptions = $this->page->theme->get_all_block_regions();
     $parentcontext = get_context_instance_by_id($this->block->instance->parentcontextid);
     $mform->addElement('static', 'contextname', get_string('thisblockbelongsto', 'block'), print_context_name($parentcontext));
     $mform->addElement('selectyesno', 'bui_showinsubcontexts', get_string('appearsinsubcontexts', 'block'));
     $pagetypeoptions = matching_page_type_patterns($this->page->pagetype);
     $pagetypeoptions = array_combine($pagetypeoptions, $pagetypeoptions);
     $mform->addElement('select', 'bui_pagetypepattern', get_string('pagetypes', 'block'), $pagetypeoptions);
     if ($this->page->subpage) {
         $subpageoptions = array('%@NULL@%' => get_string('anypagematchingtheabove', 'block'), $this->page->subpage => get_string('thisspecificpage', 'block', $this->page->subpage));
         $mform->addElement('select', 'bui_subpagepattern', get_string('subpages', 'block'), $subpageoptions);
     }
     $defaultregionoptions = $regionoptions;
     $defaultregion = $this->block->instance->defaultregion;
     if (!array_key_exists($defaultregion, $defaultregionoptions)) {
         $defaultregionoptions[$defaultregion] = $defaultregion;
     }
     $mform->addElement('select', 'bui_defaultregion', get_string('defaultregion', 'block'), $defaultregionoptions);
     $mform->addElement('select', 'bui_defaultweight', get_string('defaultweight', 'block'), $weightoptions);
     // Where this block is positioned on this page.
     $mform->addElement('header', 'whereheader', get_string('onthispage', 'block'));
     $mform->addElement('selectyesno', 'bui_visible', get_string('visible', 'block'));
     $blockregion = $this->block->instance->region;
     if (!array_key_exists($blockregion, $regionoptions)) {
         $regionoptions[$blockregion] = $blockregion;
     }
     $mform->addElement('select', 'bui_region', get_string('region', 'block'), $regionoptions);
     $mform->addElement('select', 'bui_weight', get_string('weight', 'block'), $weightoptions);
     $pagefields = array('bui_visible', 'bui_region', 'bui_weight');
     if (!$this->block->user_can_edit()) {
         $mform->hardFreezeAllVisibleExcept($pagefields);
     }
     if (!$this->page->user_can_edit_blocks()) {
         $mform->hardFreeze($pagefields);
     }
     $this->add_action_buttons();
 }

 public function get_required_javascript()
 {
     global $PAGE;
     $PAGE->requires->yui_module('moodle-block_databasebookmarks-bookmark', 'M.block_databasebookmarks.bookmark.init');
     $PAGE->requires->strings_for_js(array('deletebookmark', 'bookmark', 'bookmarkname', 'bookmarkheader'), 'block_databasebookmarks');
     $PAGE->requires->strings_for_js(array('buttons'), 'mod_data');
     return parent::get_required_javascript();
 }

 /**
  * Returns the attributes to set for this block
  *
  * This function returns an array of HTML attributes for this block including
  * the defaults.
  * {@link block_tree::html_attributes()} is used to get the default arguments
  * and then we check whether the user has enabled hover expansion and add the
  * appropriate hover class if it has.
  *
  * @return array An array of HTML attributes
  */
 public function html_attributes()
 {
     $attributes = parent::html_attributes();
     if (!empty($this->config->enablehoverexpansion) && $this->config->enablehoverexpansion == 'yes') {
         $attributes['class'] .= ' block_js_expansion';
     }
     $attributes['class'] .= ' block_uai';
     return $attributes;
 }

 /**
  * Serialize and store config data
  */
 function instance_config_save($data, $nolongerused = false)
 {
     global $DB;
     $config = clone $data;
     // Move embedded files into a proper filearea and adjust HTML links to match
     $config->text = file_save_draft_area_files($data->text['itemid'], $this->context->id, 'block_html', 'content', 0, array('subdirs' => true), $data->text['text']);
     $config->format = $data->text['format'];
     parent::instance_config_save($config, $nolongerused);
 }

 function instance_config_save($data)
 {
     $savedata = null;
     if (isset($data->general['moduleUrl'])) {
         $savedata->moduleUrl = $data->general['moduleUrl'];
     }
     $savedata->configuration = $data->configuration;
     $savedata->preferences = $data->preferences;
     return parent::instance_config_save($savedata);
 }

 function _print_block()
 {
     global $USER;
     // make sure they are looged in or they cant see it
     if (isloggedin() && isset($USER) && $USER->username != 'guest') {
         return parent::_print_block();
     } else {
         return "";
     }
 }

 /**
  * Will be called before an instance of this block is backed up, so that any links in
  * any links in any HTML fields on config can be encoded.
  * @return string
  */
 function get_backup_encoded_config()
 {
     /// Prevent clone for non configured block instance. Delegate to parent as fallback.
     if (empty($this->config)) {
         return parent::get_backup_encoded_config();
     }
     $data = clone $this->config;
     $data->text = backup_encode_absolute_links($data->text);
     return base64_encode(serialize($data));
 }

 /**
  * The block depends upon a React app (which should only be loaded once).
  * Unfortunately, it is necessary to use the Moodle page requirements manager.
  * It is also necessary to hide RequireJS from the React app.
  */
 public function get_required_javascript()
 {
     parent::get_required_javascript();
     // if debugging, load unminified script
     $script_src = 'build/activity_tree.min.js';
     if (debugging()) {
         $script_src = str_replace('.min.js', '.js', $script_src);
     }
     /** @var page_requirements_manager $prm */
     $prm = $this->page->requires;
     $prm->js('/blocks/activity_tree/static/js/other/requirejs_hide.js');
     $prm->js(new moodle_url('/blocks/activity_tree/static/js/' . $script_src));
     $prm->js('/blocks/activity_tree/static/js/other/requirejs_show.js');
 }

 function instance_config($instance)
 {
     parent::instance_config($instance);
     $course = get_record('course', 'id', $this->instance->pageid);
     if (isset($course->format)) {
         if ($course->format == 'topics') {
             $this->title = get_string('topics', 'block_section_links');
         } else {
             if ($course->format == 'weeks') {
                 $this->title = get_string('weeks', 'block_section_links');
             } else {
                 $this->title = get_string('blockname', 'block_section_links');
             }
         }
     }
 }

 function instance_config($instance)
 {
     global $DB;
     parent::instance_config($instance);
     $course = $this->page->course;
     if (isset($course->format)) {
         if ($course->format == 'topics') {
             $this->title = get_string('topics', 'block_section_links');
         } else {
             if ($course->format == 'weeks') {
                 $this->title = get_string('weeks', 'block_section_links');
             } else {
                 $this->title = get_string('pluginname', 'block_section_links');
             }
         }
     }
 }