Themes 2.0 adding upgrade code - Historia wersji

Samhemelryk: /* Step 2: install.php */

2011-04-11T07:23:30Z

Step 2: install.php

← poprzednia wersja		Wersja z 07:23, 11 kwi 2011
Linia 66:		Linia 66:
	The reason for this is because Moodle processes install.php the first time that a version number is used rather than upgrade.php.		The reason for this is because Moodle processes install.php the first time that a version number is used rather than upgrade.php.

	The install.php file should contain a single function that needs to be named following a strict naming scheme and it should be located in a directory called db located within your theme's directory, for example moodle/theme/mythemename/db/install.php.		The install.php file should contain a single function that needs to be named following a strict naming scheme and it should be located in a directory called db located within your theme's directory, for example '''moodle/theme/mythemename/db/install.php'''.

	For this example I have called my theme ''mythemename'' so the function will be as follows:		For this example I have called my theme ''mythemename'' so the function will be as follows:

Samhemelryk: /* Step 2: install.php */

2011-04-11T07:21:56Z

Step 2: install.php

← poprzednia wersja		Wersja z 07:21, 11 kwi 2011
Linia 66:		Linia 66:
	The reason for this is because Moodle processes install.php the first time that a version number is used rather than upgrade.php.		The reason for this is because Moodle processes install.php the first time that a version number is used rather than upgrade.php.

	The install.php file should contain a single function that needs to be named following a strict naming scheme.		The install.php file should contain a single function that needs to be named following a strict naming scheme and it should be located in a directory called db located within your theme's directory, for example moodle/theme/mythemename/db/install.php.

	For this example I have called my theme ''mythemename'' so the function will be as follows:		For this example I have called my theme ''mythemename'' so the function will be as follows:
	<code php>		<code php>

Samhemelryk o 07:06, 11 kwi 2011

2011-04-11T07:06:44Z

@@ Linia 61: / Linia 61: @@
 ; MATURITY_ALPHA : This marks the theme as an alpha release, this is the first release of a new theme and users will expect to find a lot still needs to be done.
-==Step 2: upgrade.php==
+==Step 2: install.php==
 This is the main upgrade file. It should be located in a directory called ''db'' located within your theme's directory, for example '''moodle/theme/mythemename/db/upgrade.php'''.

Kordan: /* Step 2: upgrade.php */

2011-03-29T09:15:02Z

Step 2: upgrade.php

← poprzednia wersja		Wersja z 09:15, 29 mar 2011
Linia 67:		Linia 67:
	<code php>		<code php>
	<?php		<?php

			defined('MOODLE_INTERNAL') \|\| die();

	function xmldb_theme_mythemename_upgrade($oldversion) {		function xmldb_theme_mythemename_upgrade($oldversion) {
Linia 83:		Linia 85:
	<code php>		<code php>
	<?php		<?php

			defined('MOODLE_INTERNAL') \|\| die();

	function xmldb_theme_mythemename_upgrade($oldversion) {		function xmldb_theme_mythemename_upgrade($oldversion) {

Kordan: /* Step 2: upgrade.php */

2011-03-29T07:58:01Z

Step 2: upgrade.php

← poprzednia wersja		Wersja z 07:58, 29 mar 2011
Linia 68:		Linia 68:
	<?php		<?php

	function ~~xmldb_mythemename_upgrade~~($oldversion) {		function xmldb_theme_mythemename_upgrade($oldversion) {
	// We'll look at what is in here shortly.		// We'll look at what is in here shortly.

Kordan: /* Step 2: upgrade.php */

2011-03-29T07:56:28Z

Step 2: upgrade.php

← poprzednia wersja		Wersja z 07:56, 29 mar 2011
Linia 68:		Linia 68:
	<?php		<?php

	function ~~xmldb_mythemename_anomaly_upgrade~~($oldversion) {		function xmldb_mythemename_upgrade($oldversion) {
	// We'll look at what is in here shortly.		// We'll look at what is in here shortly.

Kordan: /* Step 1: version.php */

2011-03-29T07:52:11Z

Step 1: version.php

← poprzednia wersja		Wersja z 07:52, 29 mar 2011
Linia 30:		Linia 30:

	The first thing to notice here is that we are setting properties of an object called $plugin, this object will be used to describe our theme.		The first thing to notice here is that we are setting properties of an object called $plugin, this object will be used to describe our theme.
	We are setting four properties here, version, component, requires, and maturity. The version property is required and the rest are optional however it is best practice to put ~~the~~ in as well.		We are setting four properties here, version, component, requires, and maturity. The version property is required and the rest are optional however it is best practice to put them in as well.
	===The version property===		===The version property===
	The version property is the version number of our theme and needs to be an integer, although you can set it to any integer value you want it is '''HIGHLY''' recommended to use the date format shown above as it is used everywhere else throughout Moodle.		The version property is the version number of our theme and needs to be an integer, although you can set it to any integer value you want it is '''HIGHLY''' recommended to use the date format shown above as it is used everywhere else throughout Moodle.

Kordan: /* Step 1: version.php */

2011-03-29T07:51:22Z

Step 1: version.php

← poprzednia wersja		Wersja z 07:51, 29 mar 2011
Linia 21:		Linia 21:
	* This is the version.php file for my theme.		* This is the version.php file for my theme.
	*/		*/
			defined('MOODLE_INTERNAL') \|\| die;

	$plugin->version = 2011032900;		$plugin->version = 2011032900;
	$plugin->component = 'theme_mythemename';		$plugin->component = 'theme_mythemename';

Kordan: /* Step 1: version.php */

2011-03-29T07:49:18Z

Step 1: version.php

← poprzednia wersja		Wersja z 07:49, 29 mar 2011
Linia 11:		Linia 11:
	For those of you who are already familiar with writing Moodle plugins you will be familiar with the version.php, however for many themer's the reality is that they've never gone beyond adding a settings page so this will be new.		For those of you who are already familiar with writing Moodle plugins you will be familiar with the version.php, however for many themer's the reality is that they've never gone beyond adding a settings page so this will be new.

	The version.php file is a requirement for many plugin types, however for theme's it is optional. The idea is that it contains just two or three lines of code that ~~the~~ tell Moodle what version the plugin is and a little bit about where it is meant to be, or what version of Moodle it requires. The version.php file for a theme should be created within the theme's base directory e.g. ''moodle/theme/mythemename/version.php''.		The version.php file is a requirement for many plugin types, however for theme's it is optional. The idea is that it contains just two or three lines of code that tell Moodle what version the plugin is and a little bit about where it is meant to be, or what version of Moodle it requires. The version.php file for a theme should be created within the theme's base directory e.g. ''moodle/theme/mythemename/version.php''.

	The following is an example of what a version.php file for a theme looks like.		The following is an example of what a version.php file for a theme looks like.

Samhemelryk o 02:52, 29 mar 2011

2011-03-29T02:52:08Z

@@ Linia 3: / Linia 3: @@
 ==Why?==
 As part of the Moodle 2 revamp theme's have been given the same abilities as many of the other plugin types within Moodle. They are now able to have settings pages, database tables, they can override renderers, and they can do all sorts of great things.
 Unfortunately this change has its positives and negatives, on the positive you can now really get some cool stuff happening within a theme, the downside is just like any other plugin you need to think about those who are already using your theme when you make changes.
 If you are changing the name of a setting, or if you are changing the database schema for the theme you will need to add upgrade code to your theme so that those who are already using your theme are moved along nicely and don't lose the effort they've put into customising and setting up your theme.
@@ Linia 55: / Linia 57: @@
 ; MATURITY_RC : This marks the theme as a release candidate, users can expect the theme to contain one or two bugs but be largely stable and usable.
 ; MATURITY_BETA : This marks the theme as a beta release, users can expect the theme to contain several bugs and for it to be likely to change still.
-; MATURITY_ALPHA : This marks the theme as an alpha release, this is the first release of a new theme and users will expect to find alot still needs to be done.
+; MATURITY_ALPHA : This marks the theme as an alpha release, this is the first release of a new theme and users will expect to find a lot still needs to be done.