Log of /moodle/blocks/moodleblock.class.php

MDL-20700 coding style cleanup - cvs keywords removed, closign php tag removed, trailing whitespace cleanup

navigation MDL-14632 Very significant navigation commit
This patch introduces two new blocks global_navigation_tree and settings_navigation_tree
both of which have been designed to make full use of the new navigation objects available through
the $PAGE object.
Bulk of this code is within lib/navigationlib.php

MDL-19791 Upgraded calls to helpbutton, print_simple_box* and notify

MDL-19955 fixed bogus & that was preventing function call in PHP5.3 when adding blocks, already fixed in HEAD

blocks MDL-19010 Slight reordering of logic to allow titles to be changed by block get_contents  (credit to tim)

blocks: MDL-19893 move blocks on page UI - part 1

This does all the UI. It does not yet update the DB when you click to complete the action.

blocks: MDL-19399 proper permissions checks for editing blocks.

In particular for editing sticky blocks. If the admin addes one at site level,
then the teacher should not be able to change its configuration from
the course page, but should be able to set the position on this page.

"MDL-19118, comments api"

Clean up some more todos.

Fix boilerplate.

blocks editing ui: MDL-19398 Remove stupid pass by reference.
Was causing errors when this method was called via block_method_result

blocks editing ui: MDL-19398 Make block config_global.html files more strongly deprecated.

blocks editing ui: MDL-19398 Make invisible blocks at least partly invisible.

blocks editing ui: MDL-19398 showing and hiding blocks now works.

blocks editing ui: MDL-19398 move generating the block edit icons to blocklib.php
Since that is where the resulting actions are processed.

fix typo

blocks editing ui: MDL-19398 add block now secure. Delete block works insecurely.
Will add security checks in a moment.

blocks: MDL-19010 show empty blocks if they have controls.

block contexts: MDL-19098 every block should have a context
even non-course and sticky blocks.

The parent context is block_instances.parentcontextid.

The block context should be used for checking permissions directly
related to the block, like moodle/block:view or moodle/site:manageblocks.

However, if the block is displaying information about the current page,
for example the participants block showing who 'here', then it may be
better to use the context of the page where the bloack is appearing -
in other words $this->page->context - to check permissions about the
user's ability to see participants here.

Or, if the block is displaying something stronly related to courses,
for example, a course meny block, the block should probably use the
context for $this->page->course to check permissions.

themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme

The code to print blocks in now in theme layout.php files. (Or in
moodle_core_renderer::handle_legacy_theme)

Code for printing blocks everywhere else has been stripped out.
(Total diffstat 1225 insertions, 2019 deletions)

The way the HTML for a block instance is generated has been cleaned
up a lot. Now, the block_instance generates a block_contents
object which gives a structured representation of the block,
and then $OUTPUT->block builds all the HTML from that.

How theme config.php files specify the layout template and block
regions by page general type has been changed to be even more flexible.

Further refinement for how the theme and block code gets initialised.

Ability for scrits to add 'pretend blocks' to the page. That is,
things that look like blocks, but are not normal block_instances.
(Like the add a new block UI.)

Things that are still broken:
 * some pages in lesson, quiz and resource. I'm working on it.
 * lots of developer debug notices pointing out things that
   need to be updated.

MDL-19690 - more $CFG->pixpath to $OUTPUT->old_icon_url

MDL-19690 - lots more $CFG->pixpath to $OUTPUT->old_icon_url

"MDL-14111, revert, remove format_string from _title_html"

"MDL-14111, format block title by format_text"

blocklib: MDL-19010 fix editing block config and block roles.

blocklib: MDL-19010 and now you can delete blocks too!

blocks: MDL-19010 Fix further blocks-related breakage, including removing all references to blocks_insance_old outside blocklib.php

blocklib: MDL-19010 remove no-longer-necessary global variable use from blocks

blocklib: MDL-19010 Fix blocks that were relying on ->instance in an unfortunate way

blocklib: MDL-19010 upgrade database tables ready for now blocks system

moodle_page: MDL-12212 completely remove the old tag and admin page classes

moodle_page: MDL-12212 kill legacy page_allows_editing implementations

moodle_page: MDL-12212 Kill legacy url_... and blocks_... methods
Start calling $PAGE->set_url in all the places it will be necessary
Start of a stub implementation of $PAGE->blocks to stop other things breaking
Remove some of the special case methods in admin_page

filters: MDL-7336 change weblib to use the new code

* Rename filter base class from filter_base to moodle_text_filter
* Remove unnecessary explicit constructors in moodle_text_filter
subclasses
* New filter_manager class, rather than static methods in filter_base
* Move some logic out of weblib, and into filter_manager
* Count filtering ops when $CFG->perfdebug on, via
performance_measuring_filter_manager
* Kill unused filter_string function. Petr said it should have been
private to weblib

MDL-17458 upgrade logging implemented + a lot more refactoring + exceptions implemented in install/upgrade code + lang pack cleanup + some more improvements

MDL-16613 sesskey cleanup

MDL-15941 block view permissions override regression fixed, merged from HEAD

MDL-15941 block view permissions override regression fixed

MDL-11421 context levels fixed in capability definitions, sorting of caps by name, plug-ins may report used core caps, fixed some risks; merged from MOODLE_19_STABLE

MDL-11421 context levels fixed in capability definitions, sorting of caps by name, plug-ins may report used core caps, fixed some risks

MDL-14679 converted some get/set_field()

MDL-14679 towards blocks conversion

MDL-14815: Added CSS class to blocks when they have editing controls (for themeability)

MDL-14111, fix html tag error

MDL-14111, change it back.

MDL-14111, multilang html-block title, merged from MOODLE_19_STABLE, thanks Gordon Bateson

MDL-14111, Multilang html-block title, thanks Gordon Bateson

MDL-8270 full block backup/restore - based on patches by Mark Nielsen and code in HEAD by Tim Hunt; merged from MOODLE_19_STABLE

MDL-8270 full block backup/restore - based on patches by Mark Nielsen and code in HEAD by Tim Hunt

Merged MDL-7493 further fix: strip_tags from title strings because the titles may have HTML in them.
  -From Martin D/moodler in moodleblock.class.php - thanks.

MDL-11814 use system context for pinned blocks; merged from MOODLE_19_STABLE

MDL-11814 use system context for pinned blocks

Merged MDL-7493 further fix: strip_tags from title strings because the titles may have HTML in them.

MDL-7493 further fix: strip_tags from title strings because the titles may have HTML in them.

Fixes reopened MDL-7493... - foreground show/hide block icon/ALT text switched with Javscript. Merged.

Fixes reopened MDL-7493... - foreground show/hide block icon/ALT text switched with Javscript. Merged.

Fixes reopened MDL-7493 "Make sure standard themes are visible under "Windows High Contrast Black" mode" - foreground show/hide block icon/ALT text switched with Javscript.

MDL-8270, full block backup/restore routine with code

MDL-12066 - Links in the HTML block are not recoded on backup and restore.

This is messy because the links are hidden in the configdata column, which is serialized and base64encoded. So we have to untangle that, then ask the block whether there are any bits of $config that need to be fixed, then re-encode it before backup up. And reverse that on restore. It needs to remain base64 encoded in the backup file, so that the file format is backwards compatible.

I disucssed this with Eloy before doing it.

Merged from MOODLE_19_STABLE.

MDL-12066 - Links in the HTML block are not recoded on backup and restore.

This is messy because the links are hidden in the configdata column, which is serialized and base64encoded. So we have to untangle that, then ask the block whether there are any bits of $config that need to be fixed, then re-encode it before backup up. And reverse that on restore. It needs to remain base64 encoded in the backup file, so that the file format is backwards compatible.

I disucssed this with Eloy before doing it.

Merged fixes for RTL support in 1.8 from Sharar Dolev and the Hebrew translation team

see  MDL-10768

Hide roles button on sticky blocks   MDL-9723  Merged from head

Hide role assign button from pinned blocks (always)    MDL-9723

MDL-10573 - moodle/block:view wasn't working with switch roles or block_list class

MDL-10894 - Make block add/remove and edit permissions more consistent

MDL-10573 - Added a capability for viewing blocks, this allows role-based control of block
display.

Changed context capability check so that CONTEXT_BLOCK capabilities can also come from the
moodle core capability definitions

Changed applicable_formats to remove certain blocks from the tags pages

Switch arrows in blocks when in RTL mode  MDL-10768

MDL-9742 - changed tabs to spaces in a few places where there are one
or two

MDL-8922: Had to modify another bunch of files to fix a simple problem:
when a config block contains a form, the previous form needs to be closed
properly (it was, but there were non-matching closing divs etc...).

MDL-8922: Had to modify another bunch of files to fix a simple problem:
when a config block contains a form, the previous form needs to be closed
properly (it was, but there were non-matching closing divs etc...).

MDL-8922 : Fixed a number of xhtml simple issues, but heaps of hard-core fixes yet to do.

MDL-8922 : Fixed a number of xhtml simple issues, but heaps of hard-core fixes yet to do.

Merge from MOODLE_18_STABLE:
Fixing notices, I should 've done grep "BLOCK_TYPE_NUKE" earlier.

Fixing notices, I should 've done grep "BLOCK_TYPE_NUKE" earlier.

Merge from MOODLE_18_STABLE:
Killing BLOCK_NUKE constant, since Martin nuked nuke blocks.

Killing BLOCK_NUKE constant, since Martin nuked nuke blocks.

made some changes so that if a user has any roles assigned in context_module or context_block with moodle/site:manageblocks or moodle/course:manageactivities, he will see the "turn editting on" button without needing to have a role assigned at context_course with moodle/course:manageactivies capability. Of course this user would not be able to edit any blocks or modules he/she is not supposed to edit. Ajax for these users with partial editing privilages are locked. Please report bugs asap as we are looking at backporting this change to 1.8. Cheers.

merged fixed wrong context, it should be possible to manage a single block

fixed wrong context, it should be possible to manage a single block

fixed wrong context, it should be possible to manage a single block

MDL-8343 reorganize frontpage settings in admintree - admin tree now allows to specify context together with required capability for each entry
MDL-8352 Fully separate CONTEXT_COURSE, SITEID from COURSE_SYSTEM - first part of cleanup related to frontpage

MDL-7861 new class .icon and .iconsmall

MDL-7861 some xhtml fixes

Fixed a missing space which broken XHTML 1.0 strict

Fix for MDL-7493. Added html id attribute for the image button used to toggle hide and show for blocks. This is used by javascript to replace the image on the fly.

Fix for MDL-7293

merged fix for MDL-7441, wrong size for roles icon

fix for MDL-7441 wrong size for roles icon

fixed 'capabilitities' typos and removed forgotten debug_print_backtrace() commited with MDL-6728

coverted /admin/ to proper /$CFG->admin/ in paths

Added feature to blocks (and restorelib) so that blocks get a method call (default does nothing) after they are restored. This allows blocks to change their settings if necessary in respect of the new course roll-forward 'restore and change start date' feature that Al implemented recently. The core blocks happen not to store dates anyway so don't need this, but contributed blocks may well do.

major whitespace cleanup - fixed tabs

Nuked nuke.

A temporary icon for roles (needs work!)

fixes for new admin blocks

fixed admin defaults, some warnings during install and added trmporary hack to make $CFG->notloggedinroleid work

FIxed roles button on blocks

FIxed some notices

Ed Coyne's AJAX course format, with some cleanups done.

More cleanups to come from Ed.

This isn't actually working for me right now but he'll fix it now.

This is completely optional and won't affect any other code right now.

Updated to use new Roles System. Plus some fixes.

SWEEPING CLEANUP

The API was changed slightly so that has_capability now takes the
whole $context object (we almost always have it anyway)

The $kill thing was removed.   If you want to assert a capability
then use:

    require_capability('capname', $context);

with optional variables to modify the error message

Misc bugs here and there also removed and code tidied

ROLES AND PERMISSIONS  - FIRST CHECK-IN
=======================================

WARNING:  DEV IS CURRENTLY VERY UNSTABLE.

This is a mega-checkin of the new Roles system.   A lot of changes have
been made in core and modules.

Currently there are a lot of rough edges and known problems.  We are
working hard on these .. .the reason for getting this into HEAD at this
stage is enable us to move faster (our branch was diverging from HEAD
too much).

Please keep an eye on http://docs.moodle.org/en/Roles for current status
and information for developers on how to use the new Roles system.

.

some site level capabilitie implementations

Added hooks so that blocks can create functions that are run when they are installed and uninstalled. The base implementation does nothing.

Fix bug 5611 (Skip block), across 4 files. Extra parameter $title in weblib.php: print_side_block, edits to moodleblock.class.php, Standard style, en_utf8 language pack.

Accessibility: moved H2 from weblib.php: print_side_block_start, to moodleblock.class.php: _title_html (validate, <span>s revert to <div>); skip block link - replaced pixel image with 'accesshide' text; use get_string.

Accessibility: function _title_html, replaced <div> with H2, enclosed <div> to <span> - now validates!

Added cron support for blocks - it was already there in the tables, now we just need to use it

Oops. Forgot some debug code in there.

NEW FEATURE:

Per-block access controls for creating and editing block instances. Defaults
behave the same as before, and the framework has final say as before.

See relevant discussion at http://moodle.org/mod/forum/discuss.php?d=36444



Other minor changes: Converted "continue" to "break" inside switch statements
(more to the point, although equivalent), change erroneous (but harmless)
"return false" to "break" on failed addition of block instance, removed some
inline comments from block_base (they were duplicated in PHPdoc)

Fixing warnings in my moodle/ blocks /pagelib, plus moved page->edit_always to base class

Removed tiny amount of unncessary code I added as part of the my moodle block stuff yesterday

MyMoodle: new /my/ page, contains course overview (module based, forum done). User defined blocks on /my/ page, admin defined stickyblocks. Needs lots of testing. Held off bumping version.php for blocks because of the postgres upgrade fixes Patrick is putting in.

Merging from STABLE:

Implementing Dan Marsden's great idea for additional hooks when block
instances are deleted (bug 3446). Going a step further and adding hooks
for when block instances are created.

Implementing Dan Marsden's great idea for additional hooks when block
instances are deleted (bug 3446). Going a step further and adding hooks
for when block instances are created.

This probably counts as adding features to a STABLE, but I wanted to
give any future blocks that use this as much back-compat as possible.

Here be DIVs.

Visual improvement: blocks which are "hidden" (eye icon) now shown exactly
like collapsed blocks (minus sign) when editing is on.

Removed an inline style on list blocks

Added proper styles to block buttons

Moved a bunch of inline styles to the stylesheets.

Small fix, changing break; to return; now that there's no switch()

Implemented discussion from bug 2547:

* Block authors no longer need to set $this->content_type
* If you want to make a "list" block, just derive from block_list
  instead of block_base
* All switch() statements gone from library code
* Overloaded method is_empty() added to block classes for convenience

Updating the guide and some comments to be up to date with the latest
and greatest inner workings. sigh.

Introducing instance ids as id attributes in blocks. This should completely
solve the problem where two instances of the same block did confusing things
when you tried to collapse one of them.

Incidentally, moving some styles for quiz_results block to where they belong.

Changing the way that applicable formats for each block are defined:

The format for each page is now the same as the id attribute of the
BODY tag, which in turn is a simple function of the script's relative path:

The format for e.g. a quiz view page is "mod-quiz-view". The format for the
site index is "site-index". Exception: the format for courses is not just
"course-view", but "course-view-weeks" etc.

Obviously the applicable_formats() override for each block should now take
this into account. The matching rules now are:

* You can specify the full format, e.g. "mod-quiz-view" => true
  will allow the block to be added in quizzes
* Prefixes match the full page format, e.g. "mod" matches ALL activities
* You can use "*" as a wildcard, e.g. "mod-*-view" matches just the view.php
  page of all activities
* These rules interoperate, thus "mod-*" is the same as "mod"
* "all" remains as a catch-all situation

Fixing a serious bug with PHP 5 only, which caused blocks to lose
their configuration data (there is an explanation but I don't think
anyone cares).

Actually it was an optimization and I had to disable it. All is fine now.

Pull all blocks out of quiz pages. We can see about allowing them later.

Add a very useful feature to block_base to make instance config even more
convenient to use. And take advantage of it to make the block run faster.

Removed some $THEME and added some new classes for the blockconfiginstance
and blockconfigglobal boxes

Renaming 4 internal-use-only class methods by prefixing an underscore.
I want to make a point that people should NOT be calling them.

Fix for bug 2371:

The alt text is now the same as the tooltip for the block control icons in
editing mode (i.e., language pack configurable).

Fixing the alt attributes for the icons used to move/hide etc. blocks when
editing is on. Also a few minor corrections for things inside comments.

Fix for bug 2241:

I hope this time I got everything changed to the new Page interface! I 'm
really sorry for messing up and breaking new installations... :(

Also moved the only two functions of the API outside the page_base class.

Ummm... more changes due to the renaming.

New naming conventions for class names to bring them in line with the
rest of Moodle. The convention for blocks is now:

class block_something extends block_base { ... }

HOWTO updated accordingly, plus some more minor polishing. More to come.

Added dummy constructor to keep PHP5 happy.

Slight change to the HOWTO to be more clear.

Removed the $course var from MoodleBlock (useless now).

Tweaked class MoodleBlock some. Removed a useless function (how did it get in here?)
and renamed handle_config(), print_config() to config_save(), config_print() for
consistency with the new instance_ functions().

Removed that old and obsolete README file.

added comments and some spacing cleanup

MAJOR CHANGES:
--------------

Brand-new pagelib.php at your disposal! It slices, it dices, it makes your coffee.
It still doesn't understand women... Read the comments in pagelib.php for a first
impression. Feedback highly encouraged!

Blocks code has undergone significant changes to work with Pages. Flexibility is its
middle name, since I think (without having tried it) that adding e.g. a third
placeholder for "center" blocks in courses, with full support for moving around etc,
will now take about 15 lines of new or edited code. If you are not impressed yet, I
suggest watching a documentary on solar physics. :P

MINOR CHANGES:
--------------

Added instance_allow_config() in the blocks class hierarchy to supplement per-instance
configuration options. You can override it to return true and thus get configuration
amenities without allowing multiple instances.

Minor polishing to comments and documentation (whatever caught my eye was game).

Tightened up some code here and there by utilizing all the new features.

BUGFIXES:
---------

A bug in restore_execute.html caused hidden blocks to not be restored at all.

spacing updates and addition of some phpdoc comments

clarified comments and added some spacing.

added comment for new specialization function

added spacing

some spacing added

Da monster-commit of blocks version 2!

Code based on the work of Daryl Hawes for the blog module. Thanks, Daryl!

Please test the hell out of it as it's sure to have issues that need to be
ironed out.

course/view.php is using sesskey
(changes in blocks done, please check them)

Merged from MOODLE_14_STABLE

course/view.php is using sesskey
(changes in blocks done, please check them)

Changes for XHTML compatibility

XHTML compliance
- fixed (hopefully) all <img> tags
- global replace on <br> to <br />
- &amp; in URLs
- got the forum module XHTML compliant
Julian Sedding

Fix for bug 1662:

Changed the way applicable formats for blocks are handled. The changes are
short codewise, but to grasp all the implications read the forum discussion
at the relevant URL.

fixed the problem that people trying to move blocks accidentally deleted them.

As per Gustav's suggestion in bug 1507, changing the default behavior for
blocks to make them available in the site page, too. Also, minor spelling correction.

fixed empty boxes bug reported in http://moodle.org/mod/forum/discuss.php?d=8432

Bugfix: blocks with no content at all show up as shadows when editing.

Merging the changes from 1.4 dev branch (site index blocks + various bugfixes)

Warning: monster commit! ;-)

------------------------
MAJOR CHANGES:
------------------------

** 1 **
Moved print_side_block() and print_side_block_start() from course/lib.php to
weblib.php. This seems like a good idea, considering I kept including the
whole library just for this.

** 2 **
Changed the declarations of these two functions! Not in a drastic way, but
the $width parameter is lost and replaced by an array with HTML attributes.
The way to replicate the "old" behavior now is:

    print_side_block_start($title, array('style' => 'width: 180px;'));

which also has the nice and intentional side effect of printing content that
validates even for XHTML 1.0 Strict. It also allows much greater flexibility
for the blocks, which is a requirement for another top secret feature ;-)

I have updated ALL the code in the default installation to be up-to-date with
these changes.

------------------------
NEW FEATURES:
------------------------

** 1 **

Blocks for the site home page! :-)

** 2 **
Changed the TOPICS format to put sequentially numbered html ID attributes
in each section, using the new print_side_block(). This is another step for
the top secret new feature...

** 3 **
Updated all blocks to have a nice HTML id attribute. See above.

------------------------
OTHER CHANGES:
------------------------

** 1 **
The admin block now has dual behavior, depending on whether it's displayed
in course 1 (site home page) or not.

** 2 **
Removed a whole lot of now-useless code from course/lib.php

------------------------
BUGFIXES:
------------------------

Removed warning in participants block if the user is a guest

Removed warning in calendar/lib.php if the user is a guest

When logging in "on the way" to a course, user events start as shown,
correcting the buggy behavior that exists in release 1.3.

If a block forgets to set the footer, we won't get a warning in debug mode.

Small addition for the future: blocks will be able to define their own
HTML attributes.

Update, better and simpler handling.

Preparation for Nuke blocks integration, and relaxing of requirements for
block db upgrade scripts. We 're getting to a point where you can really
have a directory with just a single 20-line file for your block and Moodle
will do all the rest. Much like Nuke does now. That is A Good Thing! :-)

Added a CVS version number

Grand Bugslayer Eloy at work again: Hiding the blocks if they have no content
should mean "if they have no content AND no footer".

Don't display blocks that have no content at all. I 'm not sure if this
could cause any confusion, but it solves the problem with the admin block
being displayed to guests.

The thought about a "display only to X and Y kinds of users" feature came
to mind, but maybe that would be more confusing than useful.

First Official realease of the "Blocks System".
Integrated with Moodle:
    - Install automatically.
    - Update course->blockinfo for each course at installation time.
    - Modified course creation to insert into blockinfo field.
    - Modified restore to insert into blockinfo field.
    - Admin options (hide, show, delete, config) from admin page.
    - Lang strings inserted (en only).
    - Database support to mysql and postgresql (not tested!!).
Moodle, backup and block versions updated to 2004041800.
Tested with mysql: Install fresh and upgrade from previous.
section_activities block renamed to social_activities and created
its own lang file to support name "Social Activities". This can
be changed at any time.

TODO:
=====
Support it really in backup/restore.
????

Enjoy!! Ciao :-)