Automatic class loading - Revision history

Andrewnicols: Note about intent to not migrate this page to moodledev.io

2024-04-30T16:19:22Z

Note about intent to not migrate this page to moodledev.io

← Older revision		Revision as of 16:19, 30 April 2024
Line 1:		Line 1:
			{{Template:WillNotMigrate}}
	{{Moodle 2.6}}		{{Moodle 2.6}}

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


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

				
				
				
				
				
				← Older revision
				Revision as of 13:30, 14 July 2021
				
Line 35:
Line 35:
=== Code examples (namespaced) === === Code examples (namespaced) ===



<code php> <syntaxhighlight lang="php">
<?php <?php



Line 46:
Line 46:
</syntaxhighlight> </syntaxhighlight>



<code php> <syntaxhighlight lang="php">
<?php <?php



Line 58:
Line 58:
</syntaxhighlight> </syntaxhighlight>



<code php> <syntaxhighlight lang="php">
<?php <?php



Line 84:
Line 84:
Example of autoloaded class in forum module: Example of autoloaded class in forum module:



<code php> <syntaxhighlight lang="php">
<?php <?php
// file mod/forum/classes/some_class.php // file mod/forum/classes/some_class.php
Line 93:
Line 93:
</syntaxhighlight> </syntaxhighlight>



<code php> <syntaxhighlight lang="php">
<?php <?php
// file mod/forum/lib.php // file mod/forum/lib.php

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

2021-07-14T13:09:54Z

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

← Older revision		Revision as of 13:09, 14 July 2021
Line 44:		Line 44:
	class base {		class base {
	}		}
	</~~code~~>		</syntaxhighlight>

	<code php>		<code php>
Line 56:		Line 56:

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

	<code php>		<code php>
Line 65:		Line 65:
	\mod_forum\event\post_read::create($post->id, ...)->trigger();		\mod_forum\event\post_read::create($post->id, ...)->trigger();

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

	== Frankenstyle prefixed classes (deprecated)==		== Frankenstyle prefixed classes (deprecated)==
Line 91:		Line 91:

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

	<code php>		<code php>
Line 101:		Line 101:
	$instance = new mod_forum_some_class();		$instance = new mod_forum_some_class();

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

	<syntaxhighlight lang="php"><?php		<syntaxhighlight lang="php"><?php
Line 110:		Line 110:
	// do something		// do something
	}		}
	</~~code~~>		</syntaxhighlight>

	== Backwards compatibility ==		== Backwards compatibility ==

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


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

				
				
				
				
				
				← Older revision
				Revision as of 13:04, 14 July 2021
				
Line 103:
Line 103:
</code> </code>



<code php> <syntaxhighlight lang="php"><?php
  
<?php 



// in any file // in any file



Goodlyvibes: /* Backwards compatibility */
2020-10-10T11:41:23Z
Backwards compatibility

				
				
				
				
				
				← Older revision
				Revision as of 11:41, 10 October 2020
				
Line 116:
Line 116:
== Backwards compatibility == == Backwards compatibility ==



There are no know issues that could cause backwards incompatibility, however it is strongly recommended to use the classes subdirectory only for classes that are included automatically. There are no known issues that could cause backwards incompatibility, however it is strongly recommended to use the classes subdirectory only for classes that are included automatically.



== Performance and developer mode == == Performance and developer mode ==



Stronk7: indent lists
2020-06-19T17:11:52Z
indent lists

				
				
				
				
				
				← Older revision
				Revision as of 17:11, 19 June 2020
				
Line 29:
Line 29:
** Plugin classes must use the '''namespace plugintype_pluginname''' ** Plugin classes must use the '''namespace plugintype_pluginname'''
** File names will be the class names (plus the php extension). ** File names will be the class names (plus the php extension).
** e.g. Class '''\mod_forum\some_class''' is stored in file '''mod/forum/classes/some_class.php''' *** e.g. Class '''\mod_forum\some_class''' is stored in file '''mod/forum/classes/some_class.php'''
** e.g. Class '''\core\frankenstyle''' is stored in file '''lib/classes/frankenstyle.php''' *** e.g. Class '''\core\frankenstyle''' is stored in file '''lib/classes/frankenstyle.php'''
** For more details about valid first and second level namespaces see [[Coding_style#Rules_for_level1]]. ** For more details about valid first and second level namespaces see [[Coding_style#Rules_for_level1]].



Line 77:
Line 77:
** Plugin classes must start with the prefix '''plugintype_pluginname''' ** Plugin classes must start with the prefix '''plugintype_pluginname'''
** File names will be the class names '''without the prefix''' (plus the php extension). ** File names will be the class names '''without the prefix''' (plus the php extension).
** e.g. Class '''mod_forum_some_class''' is stored in file '''mod/forum/classes/some_class.php''' *** e.g. Class '''mod_forum_some_class''' is stored in file '''mod/forum/classes/some_class.php'''
** e.g. Class '''core_frankenstyle''' class is stored in '''lib/classes/frankenstyle.php''' *** e.g. Class '''core_frankenstyle''' class is stored in '''lib/classes/frankenstyle.php'''



=== Code Examples (prefixed)=== === Code Examples (prefixed)===



Stronk7: more details
2020-06-19T17:10:48Z
more details

				
				
				
				
				
				← Older revision
				Revision as of 17:10, 19 June 2020
				
Line 30:
Line 30:
** File names will be the class names (plus the php extension). ** File names will be the class names (plus the php extension).
** e.g. Class '''\mod_forum\some_class''' is stored in file '''mod/forum/classes/some_class.php''' ** e.g. Class '''\mod_forum\some_class''' is stored in file '''mod/forum/classes/some_class.php'''
** e.g. Class '''\core\frankenstyle''' class is stored in '''lib/classes/frankenstyle.php''' ** e.g. Class '''\core\frankenstyle''' is stored in file '''lib/classes/frankenstyle.php'''
** For more details about valid first and second level namespaces see [[Coding_style#Rules_for_level1]]. ** For more details about valid first and second level namespaces see [[Coding_style#Rules_for_level1]].






Stronk7: typo
2020-06-19T17:09:02Z
typo

				
				
				
				
				
				← Older revision
				Revision as of 17:09, 19 June 2020
				
Line 9:
Line 9:
* Sit under the '''classes''' directory of every component: * Sit under the '''classes''' directory of every component:
** '''/lib/classes/''' for core component (core). ** '''/lib/classes/''' for core component (core).
** '''SUBSYSTEMDIR/classes/''' for subsystem (core_sybsystem). ** '''SUBSYSTEMDIR/classes/''' for subsystem (core_subsystem).
** '''PLUGINDIR/classes/''' for plugins (plugintype_plugin). ** '''PLUGINDIR/classes/''' for plugins (plugintype_plugin).
:::Note: The list of valid subsystems and plugin types with their corresponding directories [https://github.com/moodle/moodle/blob/master/lib/components.json can be found in code]. :::Note: The list of valid subsystems and plugin types with their corresponding directories [https://github.com/moodle/moodle/blob/master/lib/components.json can be found in code].



Stronk7: (fix file name details)
2020-06-19T17:08:04Z
(fix file name details)

				
				
				
				
				
				← Older revision
				Revision as of 17:08, 19 June 2020
				
Line 28:
Line 28:
** Subsystem classes must use the '''namespace core_subsystem'''. ** Subsystem classes must use the '''namespace core_subsystem'''.
** Plugin classes must use the '''namespace plugintype_pluginname''' ** Plugin classes must use the '''namespace plugintype_pluginname'''
** File names will be the class names '''without the prefix''' ** File names will be the class names (plus the php extension).
** e.g. Class '''\mod_forum\some_class''' is stored in file '''mod/forum/classes/some_class.php''' ** e.g. Class '''\mod_forum\some_class''' is stored in file '''mod/forum/classes/some_class.php'''
** e.g. Class '''\core\frankenstyle''' class is stored in '''lib/classes/frankenstyle.php''' ** e.g. Class '''\core\frankenstyle''' class is stored in '''lib/classes/frankenstyle.php'''
Line 76:
Line 76:
** Subsystem classes must start with the prefix '''core_subsystem'''. ** Subsystem classes must start with the prefix '''core_subsystem'''.
** Plugin classes must start with the prefix '''plugintype_pluginname''' ** Plugin classes must start with the prefix '''plugintype_pluginname'''
** File names will be the class names '''without the prefix''' ** File names will be the class names '''without the prefix''' (plus the php extension).
** e.g. Class '''mod_forum_some_class''' is stored in file '''mod/forum/classes/some_class.php''' ** e.g. Class '''mod_forum_some_class''' is stored in file '''mod/forum/classes/some_class.php'''
** e.g. Class '''core_frankenstyle''' class is stored in '''lib/classes/frankenstyle.php''' ** e.g. Class '''core_frankenstyle''' class is stored in '''lib/classes/frankenstyle.php'''



Stronk7: MDLSITE-6087 - namespaced classes are not the default - make it clear here.
2020-06-19T17:04:58Z
MDLSITE-6087 - namespaced classes are not the default - make it clear here.
Show changes

← Older revision		Revision as of 13:30, 14 July 2021
Line 35:		Line 35:
	=== Code examples (namespaced) ===		=== Code examples (namespaced) ===

	<~~code~~ php>		<syntaxhighlight lang="php">
	<?php		<?php

Line 46:		Line 46:
	</syntaxhighlight>		</syntaxhighlight>

	<~~code~~ php>		<syntaxhighlight lang="php">
	<?php		<?php

Line 58:		Line 58:
	</syntaxhighlight>		</syntaxhighlight>

	<~~code~~ php>		<syntaxhighlight lang="php">
	<?php		<?php

Line 84:		Line 84:
	Example of autoloaded class in forum module:		Example of autoloaded class in forum module:

	<~~code~~ php>		<syntaxhighlight lang="php">
	<?php		<?php
	// file mod/forum/classes/some_class.php		// file mod/forum/classes/some_class.php
Line 93:		Line 93:
	</syntaxhighlight>		</syntaxhighlight>

	<~~code~~ php>		<syntaxhighlight lang="php">
	<?php		<?php
	// file mod/forum/lib.php		// file mod/forum/lib.php

← Older revision		Revision as of 13:04, 14 July 2021
Line 103:		Line 103:
	</code>		</code>

	<~~code~~ php>		<syntaxhighlight lang="php"><?php

	<?php

	// in any file		// in any file

← Older revision		Revision as of 11:41, 10 October 2020
Line 116:		Line 116:
	== Backwards compatibility ==		== Backwards compatibility ==

	There are no ~~know~~ issues that could cause backwards incompatibility, however it is strongly recommended to use the classes subdirectory only for classes that are included automatically.		There are no known issues that could cause backwards incompatibility, however it is strongly recommended to use the classes subdirectory only for classes that are included automatically.

	== Performance and developer mode ==		== Performance and developer mode ==

← Older revision		Revision as of 17:11, 19 June 2020
Line 29:		Line 29:
	** Plugin classes must use the '''namespace plugintype_pluginname'''		** Plugin classes must use the '''namespace plugintype_pluginname'''
	** File names will be the class names (plus the php extension).		** File names will be the class names (plus the php extension).
	** e.g. Class '''\mod_forum\some_class''' is stored in file '''mod/forum/classes/some_class.php'''		*** e.g. Class '''\mod_forum\some_class''' is stored in file '''mod/forum/classes/some_class.php'''
	** e.g. Class '''\core\frankenstyle''' is stored in file '''lib/classes/frankenstyle.php'''		*** e.g. Class '''\core\frankenstyle''' is stored in file '''lib/classes/frankenstyle.php'''
	** For more details about valid first and second level namespaces see [[Coding_style#Rules_for_level1]].		** For more details about valid first and second level namespaces see [[Coding_style#Rules_for_level1]].

Line 77:		Line 77:
	** Plugin classes must start with the prefix '''plugintype_pluginname'''		** Plugin classes must start with the prefix '''plugintype_pluginname'''
	** File names will be the class names '''without the prefix''' (plus the php extension).		** File names will be the class names '''without the prefix''' (plus the php extension).
	** e.g. Class '''mod_forum_some_class''' is stored in file '''mod/forum/classes/some_class.php'''		*** e.g. Class '''mod_forum_some_class''' is stored in file '''mod/forum/classes/some_class.php'''
	** e.g. Class '''core_frankenstyle''' class is stored in '''lib/classes/frankenstyle.php'''		*** e.g. Class '''core_frankenstyle''' class is stored in '''lib/classes/frankenstyle.php'''

	=== Code Examples (prefixed)===		=== Code Examples (prefixed)===

← Older revision		Revision as of 17:10, 19 June 2020
Line 30:		Line 30:
	** File names will be the class names (plus the php extension).		** File names will be the class names (plus the php extension).
	** e.g. Class '''\mod_forum\some_class''' is stored in file '''mod/forum/classes/some_class.php'''		** e.g. Class '''\mod_forum\some_class''' is stored in file '''mod/forum/classes/some_class.php'''
	** e.g. Class '''\core\frankenstyle''' ~~class~~ is stored in '''lib/classes/frankenstyle.php'''		** e.g. Class '''\core\frankenstyle''' is stored in file '''lib/classes/frankenstyle.php'''
	** For more details about valid first and second level namespaces see [[Coding_style#Rules_for_level1]].		** For more details about valid first and second level namespaces see [[Coding_style#Rules_for_level1]].

← Older revision		Revision as of 17:09, 19 June 2020
Line 9:		Line 9:
	* Sit under the '''classes''' directory of every component:		* Sit under the '''classes''' directory of every component:
	** '''/lib/classes/''' for core component (core).		** '''/lib/classes/''' for core component (core).
	** '''SUBSYSTEMDIR/classes/''' for subsystem (~~core_sybsystem~~).		** '''SUBSYSTEMDIR/classes/''' for subsystem (core_subsystem).
	** '''PLUGINDIR/classes/''' for plugins (plugintype_plugin).		** '''PLUGINDIR/classes/''' for plugins (plugintype_plugin).
	:::Note: The list of valid subsystems and plugin types with their corresponding directories [https://github.com/moodle/moodle/blob/master/lib/components.json can be found in code].		:::Note: The list of valid subsystems and plugin types with their corresponding directories [https://github.com/moodle/moodle/blob/master/lib/components.json can be found in code].

← Older revision		Revision as of 17:08, 19 June 2020
Line 28:		Line 28:
	** Subsystem classes must use the '''namespace core_subsystem'''.		** Subsystem classes must use the '''namespace core_subsystem'''.
	** Plugin classes must use the '''namespace plugintype_pluginname'''		** Plugin classes must use the '''namespace plugintype_pluginname'''
	** File names will be the class names ~~'''without~~ the ~~prefix'''~~		** File names will be the class names (plus the php extension).
	** e.g. Class '''\mod_forum\some_class''' is stored in file '''mod/forum/classes/some_class.php'''		** e.g. Class '''\mod_forum\some_class''' is stored in file '''mod/forum/classes/some_class.php'''
	** e.g. Class '''\core\frankenstyle''' class is stored in '''lib/classes/frankenstyle.php'''		** e.g. Class '''\core\frankenstyle''' class is stored in '''lib/classes/frankenstyle.php'''
Line 76:		Line 76:
	** Subsystem classes must start with the prefix '''core_subsystem'''.		** Subsystem classes must start with the prefix '''core_subsystem'''.
	** Plugin classes must start with the prefix '''plugintype_pluginname'''		** Plugin classes must start with the prefix '''plugintype_pluginname'''
	** File names will be the class names '''without the prefix'''		** File names will be the class names '''without the prefix''' (plus the php extension).
	** e.g. Class '''mod_forum_some_class''' is stored in file '''mod/forum/classes/some_class.php'''		** e.g. Class '''mod_forum_some_class''' is stored in file '''mod/forum/classes/some_class.php'''
	** e.g. Class '''core_frankenstyle''' class is stored in '''lib/classes/frankenstyle.php'''		** e.g. Class '''core_frankenstyle''' class is stored in '''lib/classes/frankenstyle.php'''

Automatic class loading - Revision history

Andrewnicols: Note about intent to not migrate this page to moodledev.io

Mudrd8mz: Text replacement - "" to ""

Mudrd8mz: Text replacement - "" to ""

Mudrd8mz: Text replacement - " " to ""

Goodlyvibes: /* Backwards compatibility */

Stronk7: indent lists

Stronk7: more details

Stronk7: typo

Stronk7: (fix file name details)

Stronk7: MDLSITE-6087 - namespaced classes are not the default - make it clear here.

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

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

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