Tutorial - Revision history

Mudrd8mz: Text replacement - "" to ""

2021-07-14T20:24:42Z

Text replacement - "</code>" to "</syntaxhighlight>"

← Older revision		Revision as of 20:24, 14 July 2021
Line 82:		Line 82:
	<syntaxhighlight lang="php">		<syntaxhighlight lang="php">
	require_once('../../config.php');		require_once('../../config.php');
	</~~code~~>		</syntaxhighlight>

	For internal files the code should use the following -		For internal files the code should use the following -
	<syntaxhighlight lang="php">		<syntaxhighlight lang="php">
	defined('MOODLE_INTERNAL') \|\| die();		defined('MOODLE_INTERNAL') \|\| die();
	</~~code~~>		</syntaxhighlight>

	===Add basic content to your page===		===Add basic content to your page===
Line 118:		Line 118:
	$navigation->add_node($devcoursenode);		$navigation->add_node($devcoursenode);
	}		}
	</~~code~~>		</syntaxhighlight>

	links		links
Line 134:		Line 134:
	global $DB;		global $DB;
	$courses = $DB->get_records('course', null, '', 'id, category, fullname, shortname');		$courses = $DB->get_records('course', null, '', 'id, category, fullname, shortname');
	</~~code~~>		</syntaxhighlight>
	Example of data returned from the above code.		Example of data returned from the above code.
	<syntaxhighlight lang="php">		<syntaxhighlight lang="php">
Line 163:		Line 163:
	)		)
	)		)
	</~~code~~>		</syntaxhighlight>

	links		links
Line 245:		Line 245:
	<syntaxhighlight lang="php">		<syntaxhighlight lang="php">
	$this->page->requires->js_call_amd('{JScriptfilename}');		$this->page->requires->js_call_amd('{JScriptfilename}');
	</~~code~~>		</syntaxhighlight>
	* Can also be included in mustache templates.		* Can also be included in mustache templates.

Mudrd8mz: Text replacement - "`" to ""`


2021-07-14T13:39:34Z
Text replacement - "<code php>" to "<syntaxhighlight lang="php">"

				
				
				
				
				
				← Older revision
				Revision as of 13:39, 14 July 2021
				
Line 80:
Line 80:



For browser accessible pages you must include config.php with code something similar to this -   For browser accessible pages you must include config.php with code something similar to this -  
<code php> <syntaxhighlight lang="php">
require_once('../../config.php'); require_once('../../config.php');
</code> </code>



For internal files the code should use the following -   For internal files the code should use the following -  
<code php> <syntaxhighlight lang="php">
defined('MOODLE_INTERNAL') || die(); defined('MOODLE_INTERNAL') || die();
</code> </code>
Line 112:
Line 112:
* Hooks are located in lib.php. Try to keep lib.php as small as possible as this file is included on every page. Put classes and functions elsewhere. * Hooks are located in lib.php. Try to keep lib.php as small as possible as this file is included on every page. Put classes and functions elsewhere.
* Course navigation extension example: * Course navigation extension example:
<code php> <syntaxhighlight lang="php">
function tool_devcourse_extend_navigation_course($navigation, $course, $coursecontext) { function tool_devcourse_extend_navigation_course($navigation, $course, $coursecontext) {
     $url = new moodle_url('/admin/tool/devcourse/index.php');      $url = new moodle_url('/admin/tool/devcourse/index.php');
Line 131:
Line 131:



Example call to retrieve data from the course table. Example call to retrieve data from the course table.
<code php> <syntaxhighlight lang="php">
global $DB; global $DB;
$courses = $DB->get_records('course', null, '', 'id, category, fullname, shortname'); $courses = $DB->get_records('course', null, '', 'id, category, fullname, shortname');
Line 243:
Line 243:
* Use grunt to build your JavaScript. * Use grunt to build your JavaScript.
* Include your JavaScript in php files as follows: * Include your JavaScript in php files as follows:
<code php> <syntaxhighlight lang="php">
$this->page->requires->js_call_amd('{JScriptfilename}'); $this->page->requires->js_call_amd('{JScriptfilename}');
</code> </code>



Mudrd8mz: Text replacement - "" to ""

2021-07-14T13:04:42Z
Text replacement - "<code>" to "<syntaxhighlight lang="php">"

				
				
				
				
				
				← Older revision
				Revision as of 13:04, 14 July 2021
				
Line 136:
Line 136:
</code> </code>
Example of data returned from the above code. Example of data returned from the above code.
<code> <syntaxhighlight lang="php">
Array Array
( (



Stronk7: /* Adding events and logging */
2020-04-06T11:15:06Z
Adding events and logging

				
				
				
				
				
				← Older revision
				Revision as of 11:15, 6 April 2020
				
Line 263:
Line 263:
links links



* [[Event 2]] * [[Events API]]
* [[Logging 2]] * [[Logging 2]]






Stuartrmealor: /* See also */
2019-02-05T03:08:22Z
See also

				
				
				
				
				
				← Older revision
				Revision as of 03:08, 5 February 2019
				
Line 353:
Line 353:
* See [https://moodle.org/mod/forum/discuss.php?d=355789 this (july 2017) forum thread ] about Getting Started with Moodle Development. * See [https://moodle.org/mod/forum/discuss.php?d=355789 this (july 2017) forum thread ] about Getting Started with Moodle Development.
* See [https://moodle.org/mod/forum/discuss.php?d=352360 this (may 2017) forum thread] about Getting Started with Moodle Development. * See [https://moodle.org/mod/forum/discuss.php?d=352360 this (may 2017) forum thread] about Getting Started with Moodle Development.
* MoodleBites for Developers - completely online courses [https://www.moodlebites.com/mod/page/view.php?id=24546 Level 1] and [https://www.moodlebites.com/mod/page/view.php?id=19542 Level 2] are designed to get new developers up-to-speed with Moodle development, and are run online by HRDNZ (Certified Moodle Partner since 2006).



See also these older tutorials: See also these older tutorials:



Sarjona: Add reference to new Setting up dev environment page
2018-09-04T17:35:49Z
Add reference to new Setting up dev environment page

				
				
				
				
				
				← Older revision
				Revision as of 17:35, 4 September 2018
				
Line 12:
Line 12:



===Setting up your development environment=== ===Setting up your development environment===
* Moodle uses Git for developement. View the link below for basic information about Git and Moodle. * [[Setting up development environment]]: PHP server, database...
  * Moodle uses Git for development. View the following link for basic information about Git and Moodle: [[Git for developers]]
links 
  
* [[Git for developers]] 



===The Moodle development framework=== ===The Moodle development framework===



Sarjona: /* TODO */
2018-09-04T16:18:36Z
TODO

				
				
				
				
				
				← Older revision
				Revision as of 16:18, 4 September 2018
				
Line 351:
Line 351:
# About one or two screens for each section with a very generic overview for beginners, containing links to relevant docs WITH COMMENTS ABOUT QUALITY, USEFULNESS, CAVEATS etc. # About one or two screens for each section with a very generic overview for beginners, containing links to relevant docs WITH COMMENTS ABOUT QUALITY, USEFULNESS, CAVEATS etc.
# Go through all the linked pages and make sure they are current and accurate. # Go through all the linked pages and make sure they are current and accurate.
# Add a worked example to this page, so that each section has suggestions about things to add to the admin tool being built as an exercise.  If the code is long, it could be placed on separate pages.  A good reference for style is [[Moodle_Mobile_Developing_a_plugin_tutorial]] and [[Blocks]]. # Add a worked example to this page, so that each section has suggestions about things to add to the admin tool being built as an exercise.  If the code is long, it could be placed on separate pages.  A good reference for style is [[Mobile_support_for_plugins]] and [[Blocks]].



==See also== ==See also==



Sarjona: /* See also */
2018-09-04T16:18:12Z
See also

				
				
				
				
				
				← Older revision
				Revision as of 16:18, 4 September 2018
				
Line 361:
Line 361:
* [[Blocks|A Step-by-step Guide To Creating Blocks]]   * [[Blocks|A Step-by-step Guide To Creating Blocks]]  
* [[NEWMODULE Tutorial]] * [[NEWMODULE Tutorial]]
* [[Moodle_Mobile_Developing_a_plugin_tutorial|Moodle Mobile plugin tutorial]] * [[Mobile_support_for_plugins|Moodle Mobile plugin tutorial]]
* [[Category:Tutorial|Other tutorials in these docs]] * [[Category:Tutorial|Other tutorials in these docs]]






Dmonllao: /* Maintaining good security */
2018-07-17T07:10:16Z
Maintaining good security

				
				
				
				
				
				← Older revision
				Revision as of 07:10, 17 July 2018
				
Line 227:
Line 227:
links links



* [https://docs.moodle.org/dev/Security Security docs] * [[Security]]
* [[lib/formslib.php Form Definition#Most Commonly Used PARAM .2A Types]] * [[lib/formslib.php Form Definition#Most Commonly Used PARAM .2A Types]]
* [[Output functions#p.28.29 and s.28.29]] * [[Output functions#p.28.29 and s.28.29]]



Dmonllao: /* Maintaining good security */
2018-07-17T07:09:49Z
Maintaining good security

				
				
				
				
				
				← Older revision
				Revision as of 07:09, 17 July 2018
				
Line 227:
Line 227:
links links



* [https://docs.moodle.org/dev/Security Security docs]
* [[lib/formslib.php Form Definition#Most Commonly Used PARAM .2A Types]] * [[lib/formslib.php Form Definition#Most Commonly Used PARAM .2A Types]]
* [[Output functions#p.28.29 and s.28.29]] * [[Output functions#p.28.29 and s.28.29]]

← Older revision		Revision as of 13:39, 14 July 2021
Line 80:		Line 80:

	For browser accessible pages you must include config.php with code something similar to this -		For browser accessible pages you must include config.php with code something similar to this -
	<~~code~~ php>		<syntaxhighlight lang="php">
	require_once('../../config.php');		require_once('../../config.php');
	</code>		</code>

	For internal files the code should use the following -		For internal files the code should use the following -
	<~~code~~ php>		<syntaxhighlight lang="php">
	defined('MOODLE_INTERNAL') \|\| die();		defined('MOODLE_INTERNAL') \|\| die();
	</code>		</code>
Line 112:		Line 112:
	* Hooks are located in lib.php. Try to keep lib.php as small as possible as this file is included on every page. Put classes and functions elsewhere.		* Hooks are located in lib.php. Try to keep lib.php as small as possible as this file is included on every page. Put classes and functions elsewhere.
	* Course navigation extension example:		* Course navigation extension example:
	<~~code~~ php>		<syntaxhighlight lang="php">
	function tool_devcourse_extend_navigation_course($navigation, $course, $coursecontext) {		function tool_devcourse_extend_navigation_course($navigation, $course, $coursecontext) {
	$url = new moodle_url('/admin/tool/devcourse/index.php');		$url = new moodle_url('/admin/tool/devcourse/index.php');
Line 131:		Line 131:

	Example call to retrieve data from the course table.		Example call to retrieve data from the course table.
	<~~code~~ php>		<syntaxhighlight lang="php">
	global $DB;		global $DB;
	$courses = $DB->get_records('course', null, '', 'id, category, fullname, shortname');		$courses = $DB->get_records('course', null, '', 'id, category, fullname, shortname');
Line 243:		Line 243:
	* Use grunt to build your JavaScript.		* Use grunt to build your JavaScript.
	* Include your JavaScript in php files as follows:		* Include your JavaScript in php files as follows:
	<~~code~~ php>		<syntaxhighlight lang="php">
	$this->page->requires->js_call_amd('{JScriptfilename}');		$this->page->requires->js_call_amd('{JScriptfilename}');
	</code>		</code>

← Older revision		Revision as of 13:04, 14 July 2021
Line 136:		Line 136:
	</code>		</code>
	Example of data returned from the above code.		Example of data returned from the above code.
	<~~code~~>		<syntaxhighlight lang="php">
	Array		Array
	(		(

← Older revision		Revision as of 11:15, 6 April 2020
Line 263:		Line 263:
	links		links

	* [[~~Event 2~~]]		* [[Events API]]
	* [[Logging 2]]		* [[Logging 2]]

← Older revision		Revision as of 03:08, 5 February 2019
Line 353:		Line 353:
	* See [https://moodle.org/mod/forum/discuss.php?d=355789 this (july 2017) forum thread ] about Getting Started with Moodle Development.		* See [https://moodle.org/mod/forum/discuss.php?d=355789 this (july 2017) forum thread ] about Getting Started with Moodle Development.
	* See [https://moodle.org/mod/forum/discuss.php?d=352360 this (may 2017) forum thread] about Getting Started with Moodle Development.		* See [https://moodle.org/mod/forum/discuss.php?d=352360 this (may 2017) forum thread] about Getting Started with Moodle Development.
			* MoodleBites for Developers - completely online courses [https://www.moodlebites.com/mod/page/view.php?id=24546 Level 1] and [https://www.moodlebites.com/mod/page/view.php?id=19542 Level 2] are designed to get new developers up-to-speed with Moodle development, and are run online by HRDNZ (Certified Moodle Partner since 2006).

	See also these older tutorials:		See also these older tutorials:

← Older revision		Revision as of 17:35, 4 September 2018
Line 12:		Line 12:

	===Setting up your development environment===		===Setting up your development environment===
	* Moodle uses Git for ~~developement~~. View the link ~~below~~ for basic information about Git and Moodle.		* [[Setting up development environment]]: PHP server, database...
			* Moodle uses Git for development. View the following link for basic information about Git and Moodle: [[Git for developers]]
	~~links~~

	* [[Git for developers]]

	===The Moodle development framework===		===The Moodle development framework===

← Older revision		Revision as of 16:18, 4 September 2018
Line 351:		Line 351:
	# About one or two screens for each section with a very generic overview for beginners, containing links to relevant docs WITH COMMENTS ABOUT QUALITY, USEFULNESS, CAVEATS etc.		# About one or two screens for each section with a very generic overview for beginners, containing links to relevant docs WITH COMMENTS ABOUT QUALITY, USEFULNESS, CAVEATS etc.
	# Go through all the linked pages and make sure they are current and accurate.		# Go through all the linked pages and make sure they are current and accurate.
	# Add a worked example to this page, so that each section has suggestions about things to add to the admin tool being built as an exercise. If the code is long, it could be placed on separate pages. A good reference for style is [[~~Moodle_Mobile_Developing_a_plugin_tutorial~~]] and [[Blocks]].		# Add a worked example to this page, so that each section has suggestions about things to add to the admin tool being built as an exercise. If the code is long, it could be placed on separate pages. A good reference for style is [[Mobile_support_for_plugins]] and [[Blocks]].

	==See also==		==See also==

← Older revision		Revision as of 16:18, 4 September 2018
Line 361:		Line 361:
	* [[Blocks\|A Step-by-step Guide To Creating Blocks]]		* [[Blocks\|A Step-by-step Guide To Creating Blocks]]
	* [[NEWMODULE Tutorial]]		* [[NEWMODULE Tutorial]]
	* [[~~Moodle_Mobile_Developing_a_plugin_tutorial~~\|Moodle Mobile plugin tutorial]]		* [[Mobile_support_for_plugins\|Moodle Mobile plugin tutorial]]
	* [[Category:Tutorial\|Other tutorials in these docs]]		* [[Category:Tutorial\|Other tutorials in these docs]]

← Older revision		Revision as of 07:10, 17 July 2018
Line 227:		Line 227:
	links		links

	* [~~https://docs.moodle.org/dev/~~Security ~~Security docs~~]		* [[Security]]
	* [[lib/formslib.php Form Definition#Most Commonly Used PARAM .2A Types]]		* [[lib/formslib.php Form Definition#Most Commonly Used PARAM .2A Types]]
	* [[Output functions#p.28.29 and s.28.29]]		* [[Output functions#p.28.29 and s.28.29]]

← Older revision		Revision as of 07:09, 17 July 2018
Line 227:		Line 227:
	links		links

			* [https://docs.moodle.org/dev/Security Security docs]
	* [[lib/formslib.php Form Definition#Most Commonly Used PARAM .2A Types]]		* [[lib/formslib.php Form Definition#Most Commonly Used PARAM .2A Types]]
	* [[Output functions#p.28.29 and s.28.29]]		* [[Output functions#p.28.29 and s.28.29]]