Development:Very flexible block system proposal - Revision history

Mudrd8mz: Text replacement - "class="nicetable"" to "class="wikitable""

2021-07-14T13:25:50Z

Text replacement - "class="nicetable"" to "class="wikitable""

← Older revision		Revision as of 13:25, 14 July 2021
Line 178:		Line 178:
	====Table: block_instances====		====Table: block_instances====

	{\| class="~~nicetable~~"		{\| class="wikitable"
	! Column !! Type !! Comment		! Column !! Type !! Comment
	\|-		\|-
Line 206:		Line 206:
	====Table: block_positions====		====Table: block_positions====

	{\| class="~~nicetable~~"		{\| class="wikitable"
	! Column !! Type !! Comment		! Column !! Type !! Comment
	\|-		\|-
Line 230:		Line 230:
	Keeps at track of all the know page types, for those places in the UI that need to display a list.		Keeps at track of all the know page types, for those places in the UI that need to display a list.

	{\| class="~~nicetable~~"		{\| class="wikitable"
	! Column !! Type !! Comment		! Column !! Type !! Comment
	\|-		\|-

Derekcx: /* User interface */ tiny edit s I can link

2010-10-28T20:48:28Z

User interface: tiny edit s I can link

← Older revision		Revision as of 20:48, 28 October 2010
Line 385:		Line 385:
	We need to think about the strategy for which contexts the permissions are pre-loaded for. If we get that right, performance should be OK.		We need to think about the strategy for which contexts the permissions are pre-loaded for. If we get that right, performance should be OK.

	==User interface==		==Blocks User interface==

	===Blocks editing on/off button===		===Blocks editing on/off button===

TimHunt: /* Contexts */

2009-05-05T05:44:57Z

Contexts

← Older revision		Revision as of 05:44, 5 May 2009
Line 362:		Line 362:
	For CONTEXT_BLOCK, instanceid continues to point to block_instances.id.		For CONTEXT_BLOCK, instanceid continues to point to block_instances.id.

	Now every block clearly belongs to one context, we can create a context for every block, not just ones on the course-view page.		Now every block clearly belongs to one context, we can create a context for every block, not just ones on the course-view page. (See http://moodle.org/mod/forum/discuss.php?d=122600)

	(There is one issue like that. What about complex blocks like newsfeed (in contrib). That has its own UI pages, in addition to the block that appears on the course page. Do we allow blocks on those pages? If so, do we limit the level of nesting? I think we can just support arbitrary levels of nesting.)		(There is one issue like that. What about complex blocks like newsfeed (in contrib). That has its own UI pages, in addition to the block that appears on the course page. Do we allow blocks on those pages? If so, do we limit the level of nesting? I think we can just support arbitrary levels of nesting.)

TimHunt: /* Table: block_positions */

2009-05-01T05:42:27Z

Table: block_positions

← Older revision		Revision as of 05:42, 1 May 2009
Line 221:		Line 221:
	\| visible \|\| INT(2) NOT NULL \|\| 1 = visible, 0 = hidden.		\| visible \|\| INT(2) NOT NULL \|\| 1 = visible, 0 = hidden.
	\|-		\|-
	\| ~~position~~ \|\| VARCHAR(16) NOT NULL \|\| E.g. 'left' or 'right'. Valid values depend on the theme, etc.		\| region \|\| VARCHAR(16) NOT NULL \|\| E.g. 'left' or 'right'. Valid values depend on the theme, etc.
	\|-		\|-
	\| weight \|\| INT(10) NOT NULL \|\| Used to determine the order within the list of blocks in position.		\| weight \|\| INT(10) NOT NULL \|\| Used to determine the order within the list of blocks in position.

TimHunt: /* Table: block_instances */

2009-05-01T05:42:06Z

Table: block_instances

← Older revision		Revision as of 05:42, 1 May 2009
Line 193:		Line 193:
	\| subpagepattern \|\| VARCHAR(16) NOT NULL \|\| Like pagetypepattern, only for subpage.		\| subpagepattern \|\| VARCHAR(16) NOT NULL \|\| Like pagetypepattern, only for subpage.
	\|-		\|-
	\| ~~defaultposition~~ \|\| VARCHAR(16) \|\| Used for sticky-blocks. The default place for this to appear.		\| defaultregion \|\| VARCHAR(16) \|\| Used for sticky-blocks. The default place for this to appear.
	\|-		\|-
	\| defaultweight \|\| INT(10) \|\| Used for sticky-blocks. The default place for this to appear.		\| defaultweight \|\| INT(10) \|\| Used for sticky-blocks. The default place for this to appear.

TimHunt: /* Database upgrade */

2009-04-29T09:12:31Z

Database upgrade

← Older revision		Revision as of 09:12, 29 April 2009
Line 291:		Line 291:
	# ✔ fill in blockname from blockid		# ✔ fill in blockname from blockid
	# ✔ rename pagetype to pagetypepattern		# ✔ rename pagetype to pagetypepattern
	# fill in contextid and subpage from pageid, and update pagetypepattern where we are changing it		# ✔ fill in contextid and subpage from pageid, and update pagetypepattern where we are changing it
	# ✔ fill any missing values in contextid with a dummy value		# ✔ fill any missing values in contextid with a dummy value
	# ✔ add not-null constraints to blockname, contextid and showinsubcontexts		# ✔ add not-null constraints to blockname, contextid and showinsubcontexts
	# get_records('block_pinned_old') loop over that and insert into block_instances		# ✔ get_records('block_pinned_old') loop over that and insert into block_instances
	# ✔ create new table block_positions		# ✔ create new table block_positions
	# ✔ for any blocks with visible = false, insert a row into block_positions.		# ✔ for any blocks with visible = false, insert a row into block_positions.

TimHunt: /* Inner workings of this proposal */

2009-04-29T07:41:41Z

Inner workings of this proposal

← Older revision		Revision as of 07:41, 29 April 2009
Line 280:		Line 280:
	Basic plan (constrained by the fact that I want to both keep an exact copy of the original data, but also keep the new ids in the block_instances table the same as the ids in the old block_instance table, and MSSQL makes it hard to preserve the id column when copying between tables.)		Basic plan (constrained by the fact that I want to both keep an exact copy of the original data, but also keep the new ids in the block_instances table the same as the ids in the old block_instance table, and MSSQL makes it hard to preserve the id column when copying between tables.)

	# rename block_pinned -> block_pinned_old		# ✔ rename block_instance to block_instances
	# create new block_instance_old with an oldid column, but otherwise the same columns		# ✔ rename block_pinned -> block_pinned_old
	# copy all date ~~block_instance~~ -> block_instance_old (that is one INSERT INTO)		# ✔ create new block_instance_old with an oldid column, but otherwise the same columns
	# ~~rename block_instance to block_instances~~		# ✔ copy all date block_instances -> block_instance_old (that is one INSERT INTO)
	# drop ~~block_instance~~.multiple		# ✔ drop block.multiple
	# rename position and weight to defaultposition and defaultweight		# ✔ rename position and weight to defaultposition and defaultweight
	# change positions to the new notation		# ✔ change positions to the new notation
	# add new columns blockname, contextid, subpage (but without not-null constraints)		# ✔ add new unique key to block.name so it can be a target for a foreign key
	# fill in blockname from blockid		# ✔ add new columns blockname, contextid, showinsubcontexts, subpage (but without not-null constraints)
	# fill in contextid and subpage from pageid		# ✔ fill in blockname from blockid
	~~# rename pagetype to pagetypepattern~~		# ✔ rename pagetype to pagetypepattern
	# update pagetypepattern where we are changing it		# fill in contextid and subpage from pageid, and update pagetypepattern where we are changing it
	# ~~drop pageid, blockid columns~~		# ✔ fill any missing values in contextid with a dummy value
	# fill any missing values in contextid with a dummy value		# ✔ add not-null constraints to blockname, contextid and showinsubcontexts
	# add not-null constraints		# get_records('block_pinned_old') loop over that and insert into block_instances
	# get_records('block_pinned_old')		# ✔ create new table block_positions
	# loop over that and insert into block_instances		# ✔ for any blocks with visible = false, insert a row into block_positions.
			# ✔ drop block_instances.pageid, .blockid and .visible columns

	Because this is a potentially tricky upgrade, we will rename the old database tables to block_instance_old and block_pinned_old, then make the upgrade script copy data to the new tables. This will mean we have a backup of the original data in case anything goes wrong during upgrade.		Because this is a potentially tricky upgrade, we will rename the old database tables to block_instance_old and block_pinned_old, then make the upgrade script copy data to the new tables. This will mean we have a backup of the original data in case anything goes wrong during upgrade.
Line 332:		Line 333:
	=====Known third-party page types=====		=====Known third-party page types=====

			; format_page extends page_course - from the flex page course format
			: can only be downloaded from moodlerooms, not in contrib. TODO
	; mod-xxx-view (xxx = dimdim, game, wiki, oublog, )		; mod-xxx-view (xxx = dimdim, game, wiki, oublog, )
	: ''as above''		: ''as above''
Line 341:		Line 344:
	I would rather switch to proper names		I would rather switch to proper names

	* l => ~~startside~~ (better for RTL languages)		* l => side-pre (better for RTL languages)
	* r => ~~endside~~		* r => side-post
	* c => course-view-top (this comes from contrib/patches/center_blocks_position_patch on course-view page. We may as well support this.)		* c => course-view-top (this comes from contrib/patches/center_blocks_position_patch on course-view page and the flex page course format. We may as well support this.)

	====New blocks created on upgrade to 2.0====		====New blocks created on upgrade to 2.0====

TimHunt: /* Database upgrade */

2009-04-28T10:55:59Z

Database upgrade

← Older revision		Revision as of 10:55, 28 April 2009
Line 277:		Line 277:

	===Database upgrade===		===Database upgrade===

			Basic plan (constrained by the fact that I want to both keep an exact copy of the original data, but also keep the new ids in the block_instances table the same as the ids in the old block_instance table, and MSSQL makes it hard to preserve the id column when copying between tables.)

			# rename block_pinned -> block_pinned_old
			# create new block_instance_old with an oldid column, but otherwise the same columns
			# copy all date block_instance -> block_instance_old (that is one INSERT INTO)
			# rename block_instance to block_instances
			# drop block_instance.multiple
			# rename position and weight to defaultposition and defaultweight
			# change positions to the new notation
			# add new columns blockname, contextid, subpage (but without not-null constraints)
			# fill in blockname from blockid
			# fill in contextid and subpage from pageid
			# rename pagetype to pagetypepattern
			# update pagetypepattern where we are changing it
			# drop pageid, blockid columns
			# fill any missing values in contextid with a dummy value
			# add not-null constraints
			# get_records('block_pinned_old')
			# loop over that and insert into block_instances

	Because this is a potentially tricky upgrade, we will rename the old database tables to block_instance_old and block_pinned_old, then make the upgrade script copy data to the new tables. This will mean we have a backup of the original data in case anything goes wrong during upgrade.		Because this is a potentially tricky upgrade, we will rename the old database tables to block_instance_old and block_pinned_old, then make the upgrade script copy data to the new tables. This will mean we have a backup of the original data in case anything goes wrong during upgrade.

TimHunt: /* New blocks created on upgrade to 2.0 */

2009-04-28T10:20:26Z

New blocks created on upgrade to 2.0

← Older revision		Revision as of 10:20, 28 April 2009
Line 327:		Line 327:
	====New blocks created on upgrade to 2.0====		====New blocks created on upgrade to 2.0====

	The notation here is		The notation here is (blockname, context,

	~~; Settings block:~~		* ('settings', syscontextid+subcontexts, *, NULL)
			* ('navigation', syscontextid+subcontexts, *, NULL)
			* TODO ''default blog tags ...''

	==Roles and capabilities==		==Roles and capabilities==

TimHunt: /* Page types with sticky blocks */

2009-04-28T10:16:02Z

Page types with sticky blocks

← Older revision		Revision as of 10:16, 28 April 2009
Line 306:		Line 306:

	; course-view		; course-view
	:		: becomes (syscontextid+subcontexts, course-view-*, NULL)
	; my-index		; my-index
	:		: becomes (syscontextid+subcontexts, my-index, NULL)

	=====Known third-party page types=====		=====Known third-party page types=====