Element Library - Revision history

Sarjona at 08:22, 10 February 2025

2025-02-10T08:22:51Z

← Older revision		Revision as of 08:22, 10 February 2025
Line 1:		Line 1:
			{{Template:WillNotMigrate}}

	{{Infobox Project		{{Infobox Project
	\|name = Element Library		\|name = Element Library

Andrewnicols: Mark project as abandoned.

2021-09-21T07:48:35Z

Mark project as abandoned.

← Older revision		Revision as of 07:48, 21 September 2021
Line 6:		Line 6:
	\|assignee = Damyon, Sam		\|assignee = Damyon, Sam
	}}		}}
	{{~~Work in progress~~\|forumurl=https://moodle.org/mod/forum/discuss.php?d=261202}}		{{Abandoned\|forumurl=https://moodle.org/mod/forum/discuss.php?d=261202}}
	The element library will be a new admin tool that will display the output from a list of renderer methods / renderables. The target users for the tool are:		The element library will be a new admin tool that will display the output from a list of renderer methods / renderables. The target users for the tool are:
	* Themers, used to test all the existing renderables in a newly developed theme		* Themers, used to test all the existing renderables in a newly developed theme

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


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

				
				
				
				
				
				← Older revision
				Revision as of 13:30, 14 July 2021
				
Line 47:
Line 47:



This class should set the "name, docs and category" class variables in it's constructor. The "execute" method should create a "assign_user_summary" instance filled with dummy data, get a 'mod_assign' renderer and call render on the "assign_user_dummy" class. This class should set the "name, docs and category" class variables in it's constructor. The "execute" method should create a "assign_user_summary" instance filled with dummy data, get a 'mod_assign' renderer and call render on the "assign_user_dummy" class.
<code php> <syntaxhighlight lang="php">
File: mod/assign/classes/output/assign_user_summary_renderer_sample.php File: mod/assign/classes/output/assign_user_summary_renderer_sample.php
<?php <?php
Line 90:
Line 90:



B) Implement the renderable_sample_generator for mod_assign B) Implement the renderable_sample_generator for mod_assign
<code php> <syntaxhighlight lang="php">
File: mod/assign/classes/output/renderable_sample_generator.php File: mod/assign/classes/output/renderable_sample_generator.php
<?php <?php

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

2021-07-14T13:03:24Z

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

← Older revision		Revision as of 13:03, 14 July 2021
Line 87:		Line 87:
	}		}

	</~~code~~>		</syntaxhighlight>

	B) Implement the renderable_sample_generator for mod_assign		B) Implement the renderable_sample_generator for mod_assign
Line 102:		Line 102:
	}		}

	</~~code~~>		</syntaxhighlight>

	== Related links ==		== Related links ==
	* [[Render library specification]]		* [[Render library specification]]

Damyon at 06:59, 17 June 2014

2014-06-17T06:59:24Z

← Older revision		Revision as of 06:59, 17 June 2014
Line 18:		Line 18:
	* Direct links to the documentation for renderers / renderables		* Direct links to the documentation for renderers / renderables
	* Report on the list of renderables used by a renderable / renderer method		* Report on the list of renderables used by a renderable / renderer method
			* Testing with different language directions

	Some optional requirements:		Some optional requirements:
	* Perform some checks on the renderer to verify it contains no db queries etc		* Perform some checks on the renderer to verify it contains no db queries etc
	* Responsive testing in the tool (short-cuts to adjust the window size)		* Responsive testing in the tool (short-cuts to adjust the window size)
	* Testing with different language directions

Damyon at 06:54, 17 June 2014

2014-06-17T06:54:16Z

← Older revision		Revision as of 06:54, 17 June 2014
Line 17:		Line 17:
	* Allow easy testing in LTR/RTL and different screen sizes		* Allow easy testing in LTR/RTL and different screen sizes
	* Direct links to the documentation for renderers / renderables		* Direct links to the documentation for renderers / renderables
			* Report on the list of renderables used by a renderable / renderer method

	Some optional requirements:		Some optional requirements:
Line 22:		Line 23:
	* Responsive testing in the tool (short-cuts to adjust the window size)		* Responsive testing in the tool (short-cuts to adjust the window size)
	* Testing with different language directions		* Testing with different language directions
	* Report on the list of renderables used by a renderable / renderer method

	This tool will work by querying a core api for getting a list of renderer_sample_base instances from each plugin. The renderer_sample_base is an abstract class that provides documentation and an example rendering of either a renderer method or a renderable.		This tool will work by querying a core api for getting a list of renderer_sample_base instances from each plugin. The renderer_sample_base is an abstract class that provides documentation and an example rendering of either a renderer method or a renderable.

Damyon at 06:53, 17 June 2014

2014-06-17T06:53:42Z

← Older revision		Revision as of 06:53, 17 June 2014
Line 24:		Line 24:
	* Report on the list of renderables used by a renderable / renderer method		* Report on the list of renderables used by a renderable / renderer method

	This tool will work by querying a core api for getting a list of ~~renderer_test~~ instances from each plugin. The ~~renderer_test~~ is an abstract class that provides documentation and an example rendering of either a renderer method or a renderable.		This tool will work by querying a core api for getting a list of renderer_sample_base instances from each plugin. The renderer_sample_base is an abstract class that provides documentation and an example rendering of either a renderer method or a renderable.

	== How to add something to the element library (for developers) ==		== How to add something to the element library (for developers) ==

	Each "thing" in the element library - is rendered by an instance of a \core\output\~~renderer_test~~ class.		Each "thing" in the element library - is rendered by an instance of a \core\output\renderer_sample_base class.

	For a plugin (or core) to add a new "thing" they must:		For a plugin (or core) to add a new "thing" they must:

	A) Implement the tests in subclasses of "\core\output\~~renderer_test_base~~". These classes can have any name, but it is recommended to name them as "\{plugin namespace}\output\~~XXX_renderer_test~~". Each test must define a "execute()" method which produces the output, as well as supply developer docs, a name for the test and a category.		A) Implement the tests in subclasses of "\core\output\renderer_sample_base". These classes can have any name, but it is recommended to name them as "\{plugin namespace}\output\XXX_renderer_sample". Each test must define a "execute()" method which produces the output, as well as supply developer docs, a name for the test and a category.

	Note: the renderer should be able to produce it's output relying completely on the data contained in its own arguments or the renderable. If it is performing additional DB queries etc - it will probably fail when provided with "mock" data. In this situation, you should consider refactoring the renderer so it does not perform DB queries.		Note: the renderer should be able to produce it's output relying completely on the data contained in its own arguments or the renderable. If it is performing additional DB queries etc - it will probably fail when provided with "mock" data. In this situation, you should consider refactoring the renderer so it does not perform DB queries.

	B) Extend the abstract class "\core\output\~~renderer_test_generator_base~~" with a new class named "\{plugin namespace}\output\~~renderer_test_generator~~". This class needs to extend "\core\output\~~renderer_test_generator_base~~". There is one function to implement, which is the "~~create_tests~~" function which accepts no arguments and returns a list of subclasses of "\core\output\~~renderer_test_base~~" (implemented in step A).		B) Extend the abstract class "\core\output\renderer_sample_generator_base" with a new class named "\{plugin namespace}\output\renderer_sample_generator". This class needs to extend "\core\output\renderer_sample_generator_base". There is one function to implement, which is the "create_samples" function which accepts no arguments and returns a list of subclasses of "\core\output\renderer_sample_base" (implemented in step A).

	Note - the non-namespaced class name "{plugin name}~~_output_renderer_test_generator~~" is also supported.		Note - the non-namespaced class name "{plugin name}_output_renderer_sample_generator" is also supported.

	=== Example: Adding "Assign user summary" ===		=== Example: Adding "Assign user summary" (TODO - change this example to a core renderable) ===

	A) Add a new class "\mod_assign\output\~~assign_user_summary_renderer_test~~" which extends "\core\output\~~renderer_test_base~~".		A) Add a new class "\mod_assign\output\assign_user_summary_renderer_sample" which extends "\core\output\renderer_sample_base".

	This class should set the "name, docs and category" class variables in it's constructor. The "execute" method should create a "assign_user_summary" instance filled with dummy data, get a 'mod_assign' renderer and call render on the "assign_user_dummy" class.		This class should set the "name, docs and category" class variables in it's constructor. The "execute" method should create a "assign_user_summary" instance filled with dummy data, get a 'mod_assign' renderer and call render on the "assign_user_dummy" class.
	<code php>		<code php>
	File: mod/assign/classes/output/~~assign_user_summary_renderer_test~~.php		File: mod/assign/classes/output/assign_user_summary_renderer_sample.php
	<?php		<?php

	namespace mod_assign\output;		namespace mod_assign\output;

	class ~~assign_user_summary_renderer_test~~ extends \core\output\~~renderer_test_base~~ {		class assign_user_summary_renderer_sample extends \core\output\renderer_sample_base {

	public function __construct() {		public function __construct() {
	$this->name = 'Assign user summary';		$this->name = 'Assign user summary';
	$this->docs = 'A user summary object that is used to display information about a user in multiple places in mod_assign.';		$this->docs = 'A user summary object that is used to display information about a user in multiple places in mod_assign.';
	$this->category = \core\output\~~renderer_test_base~~::CATEGORY_COMPONENT;		$this->category = \core\output\renderer_sample_base::CATEGORY_COMPONENT;
	}		}

Line 87:		Line 87:
	</code>		</code>

	B) Implement the ~~renderable_test_generator~~ for mod_assign		B) Implement the renderable_sample_generator for mod_assign
	<code php>		<code php>
	File: mod/assign/classes/output/~~renderable_test_generator~~.php		File: mod/assign/classes/output/renderable_sample_generator.php
	<?php		<?php
	namespace mod_assign\output;		namespace mod_assign\output;

	class ~~renderer_test_generator~~ extends \core\output\~~renderer_test_generator_base~~ {		class renderer_sample_generator extends \core\output\renderer_sample_generator_base {
	public function ~~create_tests~~() {		public function create_samples() {
	$tests = array(new ~~assign_user_summary_renderer_test~~());		$tests = array(new assign_user_summary_renderer_sample());
	return $tests;		return $tests;
	}		}

Poltawski: whitespace tweak after styling (blame Barbara :) )

2014-06-12T07:50:24Z

whitespace tweak after styling (blame Barbara :) )

← Older revision		Revision as of 07:50, 12 June 2014
Line 1:		Line 1:
	~~{{Work in progress\|forumurl=https://moodle.org/mod/forum/discuss.php?d=261202}}~~
	{{Infobox Project		{{Infobox Project
	\|name = Element Library		\|name = Element Library
Line 7:		Line 6:
	\|assignee = Damyon, Sam		\|assignee = Damyon, Sam
	}}		}}
			{{Work in progress\|forumurl=https://moodle.org/mod/forum/discuss.php?d=261202}}
	The element library will be a new admin tool that will display the output from a list of renderer methods / renderables. The target users for the tool are:		The element library will be a new admin tool that will display the output from a list of renderer methods / renderables. The target users for the tool are:
	* Themers, used to test all the existing renderables in a newly developed theme		* Themers, used to test all the existing renderables in a newly developed theme

Tsala: removing empty line

2014-06-09T07:20:45Z

removing empty line

← Older revision		Revision as of 07:20, 9 June 2014
Line 7:		Line 7:
	\|assignee = Damyon, Sam		\|assignee = Damyon, Sam
	}}		}}

	The element library will be a new admin tool that will display the output from a list of renderer methods / renderables. The target users for the tool are:		The element library will be a new admin tool that will display the output from a list of renderer methods / renderables. The target users for the tool are:
	* Themers, used to test all the existing renderables in a newly developed theme		* Themers, used to test all the existing renderables in a newly developed theme

Tsala: specific forum thread URL in work in progress message

2014-06-06T12:33:37Z

specific forum thread URL in work in progress message

← Older revision		Revision as of 12:33, 6 June 2014
Line 1:		Line 1:
	{{Work in progress}}		{{Work in progress\|forumurl=https://moodle.org/mod/forum/discuss.php?d=261202}}
	{{Infobox Project		{{Infobox Project
	\|name = Element Library		\|name = Element Library

← Older revision		Revision as of 13:30, 14 July 2021
Line 47:		Line 47:

	This class should set the "name, docs and category" class variables in it's constructor. The "execute" method should create a "assign_user_summary" instance filled with dummy data, get a 'mod_assign' renderer and call render on the "assign_user_dummy" class.		This class should set the "name, docs and category" class variables in it's constructor. The "execute" method should create a "assign_user_summary" instance filled with dummy data, get a 'mod_assign' renderer and call render on the "assign_user_dummy" class.
	<~~code~~ php>		<syntaxhighlight lang="php">
	File: mod/assign/classes/output/assign_user_summary_renderer_sample.php		File: mod/assign/classes/output/assign_user_summary_renderer_sample.php
	<?php		<?php
Line 90:		Line 90:

	B) Implement the renderable_sample_generator for mod_assign		B) Implement the renderable_sample_generator for mod_assign
	<~~code~~ php>		<syntaxhighlight lang="php">
	File: mod/assign/classes/output/renderable_sample_generator.php		File: mod/assign/classes/output/renderable_sample_generator.php
	<?php		<?php